summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Coutellier <victor.coutellier@ovhcloud.com>2022-03-07 16:08:00 +0100
committerVictor Coutellier <victor.coutellier@ovhcloud.com>2022-03-07 16:43:21 +0100
commit3fe7df37c0a857d2f5464ffc5154d1dce6c6a872 (patch)
treeafa65e6be8cb5d4bb88651db8f36596c04fd0538
parentc14a366582da0bec621b103418da1668fce5f591 (diff)
downloadkolla-3fe7df37c0a857d2f5464ffc5154d1dce6c6a872.tar.gz
kolla-3fe7df37c0a857d2f5464ffc5154d1dce6c6a872.zip
Clarify documentation about source override
The current documentation about source override is ambiguous and let users presume that you should always use "-base" after the project name you want to override source location. This assumption is wrong, as kolla look for a section who match exactly the name of the image. Images who don't have a "-base", like Horizon, are really hard to override for a user. I propose to put an example without a "-base" and also add a disclaimer in the documentation about that. Change-Id: I308a352975f11c29afb3f2ea1c22212062066b4b
-rw-r--r--doc/source/admin/image-building.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst
index d20dff1ee..aa100f4a3 100644
--- a/doc/source/admin/image-building.rst
+++ b/doc/source/admin/image-building.rst
@@ -140,9 +140,9 @@ The ``kolla-build.conf`` file could look like this:
.. path /etc/kolla/kolla-build.conf
.. code-block:: ini
- [glance-base]
+ [horizon]
type = url
- location = https://tarballs.openstack.org/glance/glance-master.tar.gz
+ location = https://tarballs.openstack.org/horizon/horizon-master.tar.gz
[keystone-base]
type = git
@@ -157,6 +157,11 @@ The ``kolla-build.conf`` file could look like this:
type = local
location = /tmp/ironic.tar.gz
+.. note::
+
+ Note that the name of the section should exactly match the image name
+ you are trying to change source location for.
+
.. _dockerfile-customisation:
Dockerfile customisation