Merge pull request #24 from stackhpc/xena-dib-backports

Backport all overcloud DIB patches (Xena)

Author: markgoddard

ansible/group_vars/all/overcloud-dib

@@ -10,6 +10,18 @@
 # is False. This will change in a future release.
 overcloud_dib_build_host_images: False
 
+# List of overcloud host disk images to build. Each element is a dict defining
+# an image in a format accepted by the stackhpc.os-images role. Default is to
+# build an image named "deployment_image" configured with the overcloud_dib_*
+# variables defined below: {"name": "deployment_image", "elements": "{{
+# overcloud_dib_elements }}", "env": "{{ overcloud_dib_env_vars }}",
+# "packages": "{{ overcloud_dib_packages }}"}.
+overcloud_dib_host_images:
+  - name: "deployment_image"
+    elements: "{{ overcloud_dib_elements }}"
+    env: "{{ overcloud_dib_env_vars }}"
+    packages: "{{ overcloud_dib_packages }}"
+
 # DIB base OS element. Default is {{ os_distribution }}.
 overcloud_dib_os_element: "{{ os_distribution }}"
 
@@ -53,6 +65,20 @@ overcloud_dib_env_vars: "{{ overcloud_dib_env_vars_default | combine(overcloud_d
 # List of DIB packages to install. Default is to install no extra packages.
 overcloud_dib_packages: []
 
+# List of default git repositories containing Diskimage Builder (DIB) elements.
+# See stackhpc.os-images role for usage. Default is empty.
+overcloud_dib_git_elements_default: []
+
+# List of additional git repositories containing Diskimage Builder (DIB)
+# elements. See stackhpc.os-images role for usage. Default is empty.
+overcloud_dib_git_elements_extra: []
+
+# 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_git_elements: >-
+  {{ overcloud_dib_git_elements_default + overcloud_dib_git_elements_extra }}
+
 # Upper constraints file for installing packages in the virtual environment
 # used for building overcloud host disk images. Default is {{
 # pip_upper_constraints_file }}.

ansible/overcloud-host-image-build.yml

@@ -1,19 +1,24 @@
 ---
-# Build and install a overcloud host disk image for the seed host's ironic
+# Build and install overcloud host disk images for the seed host's ironic
 # service.
 
-- name: Ensure overcloud host disk image is built and installed
+- name: Ensure overcloud host disk images are built and installed
   hosts: seed
   tags:
     - overcloud-host-image-build
   vars:
-    overcloud_host_image_name: "deployment_image"
-    overcloud_host_disk_images:
-      - "{{ overcloud_host_image_name }}.qcow2"
     overcloud_host_image_force_rebuild: False
   tasks:
     - block:
-        - name: Ensure overcloud host disk image is built
+        - name: Validate overcloud host disk image configuration
+          assert:
+            that:
+              - overcloud_dib_host_images is sequence
+              - overcloud_dib_host_images | selectattr('name', 'undefined') | list | length == 0
+              - overcloud_dib_host_images | selectattr('elements', 'undefined') | list | length == 0
+            msg: "overcloud_dib_host_images set to invalid value"
+
+        - name: Ensure overcloud host disk images are built
           include_role:
             name: stackhpc.os-images
           vars:
@@ -22,30 +27,18 @@
             os_images_upper_constraints_file: "{{ overcloud_dib_upper_constraints_file }}"
             os_images_cache: "{{ image_cache_path }}"
             os_images_common: ""
-            os_images_list:
-              - name: "{{ overcloud_host_image_name }}"
-                elements: "{{ overcloud_dib_elements }}"
-                env: "{{ overcloud_dib_env_vars }}"
-                packages: "{{ overcloud_dib_packages }}"
-                type: qcow2
+            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 }}"
 
-        - name: Ensure overcloud host disk image is copied onto seed
+        - name: Copy overcloud host disk images into /httpboot
           copy:
-            src: "{{ image_cache_path }}/{{ overcloud_host_image_name }}/{{ item }}"
-            dest: "/etc/kolla/bifrost/{{ item }}"
+            src: "{{ image_cache_path }}/{{ image.name }}/{{ image.name }}.{{ image.type | default('qcow2') }}"
+            dest: "/var/lib/docker/volumes/bifrost_httpboot/_data/{{ image.name }}.{{ image.type | default('qcow2') }}"
             remote_src: True
-          with_items: "{{ overcloud_host_disk_images }}"
+          with_items: "{{ overcloud_dib_host_images }}"
+          loop_control:
+            loop_var: image
           become: True
-
-        - name: Copy overcloud host disk image into /httpboot
-          command: >
-            docker exec bifrost_deploy
-            bash -c 'ansible -vvvv target
-            -i /bifrost/playbooks/inventory/target
-            -m copy
-            -a "src=/etc/bifrost/{{ item }} dest=/httpboot/{{ item }}"
-            -e "ansible_python_interpreter=/var/lib/kolla/venv/bin/python"'
-          with_items: "{{ overcloud_host_disk_images }}"
       when: overcloud_dib_build_host_images | bool

doc/source/configuration/reference/bifrost.rst

@@ -39,6 +39,11 @@ For example, to install Bifrost from a custom git repository:
 Overcloud root disk image configuration
 =======================================
 
+.. note::
+
+   This configuration only applies when ``overcloud_dib_build_host_images``
+   (set in ``${KAYOBE_CONFIG_PATH}/overcloud-dib.yml``) is not changed to true.
+
 Bifrost uses Diskimage builder (DIB) to build a root disk image that is
 deployed to overcloud hosts when they are provisioned. The following options
 configure how this image is built.  Consult the
@@ -180,6 +185,8 @@ Rather than needing to write a custom DIB element, we can use the
    kolla_bifrost_dib_packages:
      - "biosdevname"
 
+.. _configuration-bifrost-image-deployment-config:
+
 Disk image deployment configuration
 ===================================
 
@@ -190,11 +197,10 @@ The name of the root disk image to deploy can be configured via the
 Kayobe inventory. This can be used to provision different images across the
 overcloud.
 
-.. note::
-
-   Support for building multiple disk images is not yet available. Images can
-   be manually renamed before changing the Kayobe configuration to build a
-   different image.
+While only a single disk image can be built with Bifrost, starting from the
+Yoga 12.0.0 release, Kayobe supports building multiple disk images directly
+through Diskimage builder. Consult the :ref:`overcloud host disk image build
+documentation <overcloud-dib>` for more details.
 
 Ironic configuration
 ====================

doc/source/configuration/reference/index.rst

@@ -18,6 +18,7 @@ options.
    kolla
    kolla-ansible
    bifrost
+   overcloud-dib
    ironic-python-agent
    docker-registry
    seed-custom-containers

doc/source/configuration/reference/os-distribution.rst

@@ -1,3 +1,5 @@
+.. _os-distribution:
+
 ===============
 OS Distribution
 ===============