openstack/kolla
Code Issues Proposed changes

[docs] Fix guide about new images

Browse Source 
Update and minor fixes.

Change-Id: I8ea88a099dcd62bb7501b1dce64be1f292a19879
This commit is contained in:
Radosław Piliszek 2020-05-21 15:20:51 +02:00
parent f3f471b41e
commit 548e66f942
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/contributor/adding-a-new-image.rst
View File

@ -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.