aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRadosław Piliszek <radoslaw.piliszek@gmail.com>2020-05-21 15:20:51 +0200
committerRadosław Piliszek <radoslaw.piliszek@gmail.com>2020-05-21 15:20:51 +0200
commit548e66f94270649b40dbd6751a880e985227e61a (patch)
treeabe5933366b2dda5878b18b7c0ab9ab2a77c9fbe /doc
parentf3f471b41e6702d30ff45b4fb25b8b84bb030b52 (diff)
downloadkolla-548e66f94270649b40dbd6751a880e985227e61a.tar.gz
kolla-548e66f94270649b40dbd6751a880e985227e61a.zip
[docs] Fix guide about new images
Update and minor fixes. Change-Id: I8ea88a099dcd62bb7501b1dce64be1f292a19879
Diffstat (limited to 'doc')
-rw-r--r--doc/source/contributor/adding-a-new-image.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/source/contributor/adding-a-new-image.rst b/doc/source/contributor/adding-a-new-image.rst
index db3f19b50..c097a4c20 100644
--- a/doc/source/contributor/adding-a-new-image.rst
+++ b/doc/source/contributor/adding-a-new-image.rst
@@ -10,7 +10,7 @@ We use ``jinja2`` templating syntax to help manage the volume and complexity
that comes with maintaining multiple Dockerfiles for multiple different base
operating systems.
-Images should be created under the ``docker`` directory. OpenStack services
+Dockerfiles should be placed under the ``docker`` directory. OpenStack services
should inherit from the provided ``openstack-base`` image, and
infrastructure services (for example: ``fluentd``) should inherit from
``base``.
@@ -26,12 +26,15 @@ customise various stages of the build (refer to :ref:`Dockerfile Customisation
<dockerfile-customisation>`)
Some of these blocks are free form. However, there is a subset that should be
-common to every Dockerfile. The overall structure is as follows:
+common to every Dockerfile. The overall structure of a Dockerfiles of an
+OpenStack project base image is as follows:
.. code-block:: console
FROM {{ namespace }}/{{ image_prefix }}openstack-base:{{ tag }}
+ {% block labels %}
LABEL maintainer="{{ maintainer }}" name="{{ image_name }}" build-date="{{ build_date }}"
+ {% endblock %}
{% block << service >>_header %}{% endblock %}
@@ -50,3 +53,6 @@ common to every Dockerfile. The overall structure is as follows:
The generic footer block ``{% block footer %}{% endblock %}`` should **not** be
included in base images (for example: ``cinder-base``).
+
+It's probably easiest to identify the most similar service being already
+provided, copy its Dockerfile structure and amend it to new needs.