openstack
/
kolla
Code Issues Proposed changes

Clarify how to generate kolla-build.conf in docs 

image-building.rst does not mention where to find the
necessary files to generate kolla-build.conf with tox.

This patch clarifies that you need to check out the git
repository first and also that it is technically not
necessary to generate the kolla-build.conf file.

Change-Id: Ifd6ed216e5086b935ca399b1613319d67424d5ae
Closes-Bug: #1744453
This commit is contained in:
David Rabel 2018-04-25 19:19:29 +02:00
parent 4ab12d271b
commit 6f441ccd1b
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/admin/image-building.rst
View File

@ -20,7 +20,12 @@ Generating kolla-build.conf
Install tox and generate the build configuration. The build configuration is
designed to hold advanced customizations when building images.
Generate the ``kolla-build.conf`` file using the following steps.
If you have already cloned the Kolla Git repository to the ``kolla`` folder,
generate the ``kolla-build.conf`` file using the following steps.
If you don't, you can also run ``kolla-build`` without a ``kolla-build.conf``
or with the file you find in the ``etc_examples`` folder of the Kolla pip package.
But you should only do that for testing purposes, if at all.
.. code-block:: console