Skip to content

Commit

Permalink
Support elements repositories for overcloud host images
Browse files Browse the repository at this point in the history
Change-Id: Ia8c927c330b9428a3824a6925f6274cbc54314a0
Story: 2002098
Task: 44165
(cherry picked from commit c4a116e)
  • Loading branch information
priteau committed Jul 27, 2022
1 parent 00daa5b commit 86c8141
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions ansible/overcloud-host-image-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
os_images_cache: "{{ image_cache_path }}"
os_images_common: ""
os_images_list: "{{ overcloud_dib_host_images }}"
os_images_git_elements: "{{ overcloud_dib_git_elements }}"
os_images_upload: False
os_images_force_rebuild: "{{ overcloud_host_image_force_rebuild }}"

Expand Down
33 changes: 33 additions & 0 deletions doc/source/configuration/reference/overcloud-dib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,17 @@ the configuration drive built by Bifrost during provisioning.
``overcloud_dib_env_vars_extra``.
``overcloud_dib_packages``
List of DIB packages to install. Default is to install no extra packages.
``overcloud_dib_git_elements_default``
List of default git repositories containing Diskimage Builder (DIB)
elements. See stackhpc.os-images role for usage. Default is empty.
``overcloud_dib_git_elements_extra``
List of additional git repositories containing Diskimage Builder (DIB)
elements. See stackhpc.os-images role for usage. Default is empty.
``overcloud_dib_git_elements``
List of git repositories containing Diskimage Builder (DIB) elements. See
stackhpc.os-images role for usage. Default is a combination of
``overcloud_dib_git_elements_default`` and
``overcloud_dib_git_elements_extra``.
``overcloud_dib_upper_constraints_file``
Upper constraints file for installing packages in the virtual environment
used for building overcloud host disk images. Default is ``{{
Expand Down Expand Up @@ -154,6 +165,28 @@ Alternatively, the :diskimage-builder-doc:`dynamic-login element
<elements/dynamic-login/README>` can be used to authorize SSH keys by appending
them to the kernel arguments.

Example: Configuring custom DIB elements
----------------------------------------

Sometimes it is useful to use custom DIB elements that are not shipped with DIB
itself. This can be done by sharing them in a git repository.

.. code-block:: yaml
:caption: ``overcloud-dib.yml``
overcloud_dib_elements_extra:
- "my-element"
overcloud_dib_git_elements:
- repo: "https://git.example.com/custom-dib-elements"
local: "{{ source_checkout_path }}/custom-dib-elements"
version: "master"
elements_path: "elements"
In this example the ``master`` branch of
https://git.example.com/custom-dib-elements would have a top level ``elements``
directory, containing a ``my-element`` directory for the element.

Example: Installing a package
-----------------------------

Expand Down

0 comments on commit 86c8141

Please sign in to comment.