Merge "Added more information on building images"

This commit is contained in:
Zuul 2018-02-05 18:50:30 +00:00 committed by Gerrit Code Review
commit 30b45348cb

View File

@ -43,6 +43,14 @@ In general, images are built like this:
.. end
* For developement, run:
.. code-block:: console
python tools/build.py
.. end
By default, the above command would build all images based on CentOS image.
The operator can change the base distro with the ``-b`` option:
@ -53,6 +61,14 @@ The operator can change the base distro with the ``-b`` option:
.. end
* For developement, run:
.. code-block:: console
python tools/build.py -b ubuntu
.. end
There are following distros available for building images:
- centos
@ -74,6 +90,14 @@ command line:
.. end
* For developement, run:
.. code-block:: console
python tools/build.py keystone
.. end
In this case, the build script builds all images whose name contains the
``keystone`` string along with their dependencies.
@ -85,6 +109,14 @@ Multiple names may be specified on the command line:
.. end
* For developement, run:
.. code-block:: console
python tools/build.py keystone nova
.. end
The set of images built can be defined as a profile in the ``profiles`` section
of ``kolla-build.conf``. Later, profile can be specified by ``--profile`` CLI
argument or ``profile`` option in ``kolla-build.conf``. Kolla provides some
@ -157,6 +189,14 @@ installed from source code. The default method of the OpenStack install is
.. end
* For developement, run:
.. code-block:: console
python tools/build.py -t source
.. end
The locations of OpenStack source code are written in
``etc/kolla/kolla-build.conf``.
Now the source type supports ``url``, ``git``, and ``local``. The location of
@ -212,6 +252,10 @@ installing extra packages as part of the build, tweaking settings, installing
plugins, and numerous other capabilities. Some of these examples are described
in more detail below.
.. note::
The docker file for each image is found in docker/<image name> directory.
Generic Customisation
---------------------
@ -245,6 +289,14 @@ Then rebuild the horizon image, passing the ``--template-override`` argument:
.. end
* For developement, run:
.. code-block:: console
python tools/build.py --template-override template-overrides.j2 horizon
.. end
.. note::
The above example will replace all contents from the original block. Hence
@ -287,6 +339,14 @@ Then rebuild the horizon image, passing the ``--template-override`` argument:
.. end
* For developement, run:
.. code-block:: console
python tools/build.py --template-override template-overrides.j2 horizon
.. end
Alternatively ``template_override`` can be set in ``kolla-build.conf``.
The ``append`` suffix in the above example carries special significance. It