aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2022-03-17 10:44:32 +0000
committerGerrit Code Review <review@openstack.org>2022-03-17 10:44:32 +0000
commit0312ee67ee9f7e82afdad7ad361d72dfcd425dc6 (patch)
treeefc72f389ca4bce4d59c103de0902d19a71d945a /doc
parentf212617276d251bd852f0d9d993727b88a9e034e (diff)
parentc9f93c30c1fa24e4949b2c34341cbbedf00421e9 (diff)
downloadkolla-0312ee67ee9f7e82afdad7ad361d72dfcd425dc6.tar.gz
kolla-0312ee67ee9f7e82afdad7ad361d72dfcd425dc6.zip
Merge "Add enabled flag for sources"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/image-building.rst17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst
index 2fe0c3abb..821f4c8a0 100644
--- a/doc/source/admin/image-building.rst
+++ b/doc/source/admin/image-building.rst
@@ -130,10 +130,11 @@ installed from upstream sources. The default method of the OpenStack install is
ones.
The locations of OpenStack source code are written in ``kolla-build.conf``.
-The source type supports ``url``, ``git``, and ``local``. The location of
-the ``local`` source type can point to either a directory containing the source
-code or to a tarball of the source. The ``local`` source type permits to make
-the best use of the Docker cache.
+The source's ``type`` supports ``url``, ``git`` and ``local``. The
+``location`` of the ``local`` source type can point to either a directory
+containing the source code or to a tarball of the source. The ``local`` source
+type permits to make the best use of the Docker cache. A source may be
+disabled by setting ``enabled`` to ``False``.
The ``kolla-build.conf`` file could look like this:
@@ -156,6 +157,7 @@ The ``kolla-build.conf`` file could look like this:
[ironic-base]
type = local
location = /tmp/ironic.tar.gz
+ enabled = False
.. note::
@@ -380,8 +382,11 @@ The template now becomes:
python3 -m pip --no-cache-dir install /plugins/*
{% endblock %}
-Many of the Dockerfiles already copy the ``plugins-archive`` to the image and
-install available plugins at build time.
+Some plugins are installed by default. For images with default plugins, the
+Dockerfiles already copy the ``plugins-archive`` to the image and install
+available plugins at build time. These default plugins may be disabled by
+setting ``enabled`` to ``False`` in the relevant plugin source configuration
+section in ``kolla-build.conf``.
Neutron plugins
^^^^^^^^^^^^^^^