From 6f441ccd1bc1226a31884e735aeb80e248189ee6 Mon Sep 17 00:00:00 2001 From: David Rabel Date: Wed, 25 Apr 2018 19:19:29 +0200 Subject: [PATCH] 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 --- doc/source/admin/image-building.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst index 55b86fb2f8..4c1c8e92ba 100644 --- a/doc/source/admin/image-building.rst +++ b/doc/source/admin/image-building.rst @@ -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