diff options
| author | Mark Goddard <mark@stackhpc.com> | 2022-03-14 13:57:12 +0000 |
|---|---|---|
| committer | Mark Goddard <mark@stackhpc.com> | 2022-03-16 17:07:01 +0000 |
| commit | c9f93c30c1fa24e4949b2c34341cbbedf00421e9 (patch) | |
| tree | 80f60da3c0f19c01319777dc9f22ed48091db640 /doc/source | |
| parent | 5bb6489922aab2b431be8f121465eb7f3a49b5ae (diff) | |
| download | kolla-c9f93c30c1fa24e4949b2c34341cbbedf00421e9.tar.gz kolla-c9f93c30c1fa24e4949b2c34341cbbedf00421e9.zip | |
Add enabled flag for sources
Sometimes it might be useful to disable a source for an image, e.g. for
a plugin that is not used. This may be to reduce image sizes, or
restrict the dependencies necessary to build images.
This change adds a new 'enabled' option to each source definition. This
allows sources, plugins or additions for each source image to be
disabled individually.
Change-Id: I31ee0744574fb3db96bee2e9f545600de53d9ee4
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/admin/image-building.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst index aa100f4a3..9e87fbf1b 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:: @@ -369,8 +371,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 ^^^^^^^^^^^^^^^ |