From 50f5fb14e3d6d9bc25cc4576b612bd9893670e0e Mon Sep 17 00:00:00 2001
From: Mark Goddard <mark@stackhpc.com>
Date: Thu, 1 Dec 2022 12:17:57 +0000
Subject: [PATCH] Build overcloud host images via DIB by default
Changes overcloud_dib_build_host_images to true, as promised in
I93d242889e225b4e60254f6b9cc5eeb457294ac8.
Change-Id: I322432985535348fb4ebe5bff7db5dd68f16b340
---
ansible/inventory/group_vars/all/overcloud-dib | 6 +++---
doc/source/configuration/reference/bifrost.rst | 2 +-
doc/source/configuration/reference/overcloud-dib.rst | 3 +--
doc/source/deployment.rst | 7 +++----
etc/kayobe/overcloud-dib.yml | 2 +-
.../notes/overcloud-dib-default-dda199b09d40cb3b.yaml | 6 ++++++
6 files changed, 15 insertions(+), 11 deletions(-)
create mode 100644 releasenotes/notes/overcloud-dib-default-dda199b09d40cb3b.yaml
diff --git a/ansible/inventory/group_vars/all/overcloud-dib b/ansible/inventory/group_vars/all/overcloud-dib
index 47f05f887..01a68b34e 100644
--- a/ansible/inventory/group_vars/all/overcloud-dib
+++ b/ansible/inventory/group_vars/all/overcloud-dib
@@ -7,8 +7,8 @@
# Whether to build host disk images with DIB directly instead of through
# Bifrost. Setting it to true disables Bifrost image build and allows images to
# be built with the `kayobe overcloud host image build` command. Default value
-# is {{ os_distribution == 'rocky' }}. This will change in a future release.
-overcloud_dib_build_host_images: "{{ os_distribution == 'rocky' }}"
+# is true.
+overcloud_dib_build_host_images: true
# List of additional build host packages to install.
overcloud_dib_host_packages_extra: []
@@ -96,4 +96,4 @@ overcloud_dib_upper_constraints_file: "{{ pip_upper_constraints_file }}"
# Upper constraints file for installation of DIB to build overcloud host disk images.
# Default is empty string.
-overcloud_dib_dib_upper_constraints_file: ""
\ No newline at end of file
+overcloud_dib_dib_upper_constraints_file: ""
diff --git a/doc/source/configuration/reference/bifrost.rst b/doc/source/configuration/reference/bifrost.rst
index 8e5667dfd..bf92a889d 100644
--- a/doc/source/configuration/reference/bifrost.rst
+++ b/doc/source/configuration/reference/bifrost.rst
@@ -42,7 +42,7 @@ 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.
+ (set in ``${KAYOBE_CONFIG_PATH}/overcloud-dib.yml``) is changed to false.
Bifrost uses Diskimage builder (DIB) to build a root disk image that is
deployed to overcloud hosts when they are provisioned. The following options
diff --git a/doc/source/configuration/reference/overcloud-dib.rst b/doc/source/configuration/reference/overcloud-dib.rst
index a33d9a7d4..033c8156f 100644
--- a/doc/source/configuration/reference/overcloud-dib.rst
+++ b/doc/source/configuration/reference/overcloud-dib.rst
@@ -19,8 +19,7 @@ following option:
Whether to build host disk images with DIB directly instead of through
Bifrost. Setting it to true disables Bifrost image build and allows images
to be built with the ``kayobe overcloud host image build`` command. Default
- value is false, except on Rocky where it is true. This will change in a
- future release.
+ value is true since the Zed release.
With this option enabled, Bifrost will be configured to stop building a root
disk image. This will become the default behaviour in a future release.
diff --git a/doc/source/deployment.rst b/doc/source/deployment.rst
index 768c5910e..f3eff660f 100644
--- a/doc/source/deployment.rst
+++ b/doc/source/deployment.rst
@@ -172,8 +172,8 @@ At this point the seed services need to be deployed on the seed VM. These
services are deployed in the ``bifrost_deploy`` container.
This command will also build the Operating System image that will be used to
-deploy the overcloud nodes using Disk Image Builder (DIB), unless
-``overcloud_dib_build_host_images`` is set to ``True``.
+deploy the overcloud nodes using Disk Image Builder (DIB), if
+``overcloud_dib_build_host_images`` is set to ``False``.
.. note::
@@ -229,8 +229,7 @@ Building Overcloud Host Disk Images
.. note::
This step is only relevant if ``overcloud_dib_build_host_images`` is set to
- ``True``. By default, a host disk image is automatically built by Bifrost
- unless you're running Rocky Linux - which requires this step.
+ ``True``, which is the default since the Zed release.
Host disk images are deployed on overcloud hosts during provisioning. To build
host disk images::
diff --git a/etc/kayobe/overcloud-dib.yml b/etc/kayobe/overcloud-dib.yml
index 3d95fa65f..0efa25f40 100644
--- a/etc/kayobe/overcloud-dib.yml
+++ b/etc/kayobe/overcloud-dib.yml
@@ -7,7 +7,7 @@
# Whether to build host disk images with DIB directly instead of through
# Bifrost. Setting it to true disables Bifrost image build and allows images to
# be built with the `kayobe overcloud host image build` command. Default value
-# is {{ os_distribution == 'rocky' }}. This will change in a future release.
+# is true.
#overcloud_dib_build_host_images:
# List of additional build host packages to install. Default is an empty list.
diff --git a/releasenotes/notes/overcloud-dib-default-dda199b09d40cb3b.yaml b/releasenotes/notes/overcloud-dib-default-dda199b09d40cb3b.yaml
new file mode 100644
index 000000000..ed59541b5
--- /dev/null
+++ b/releasenotes/notes/overcloud-dib-default-dda199b09d40cb3b.yaml
@@ -0,0 +1,6 @@
+---
+upgrade:
+ - |
+ Overcloud host images are now built via DIB by default, rather than
+ Bifrost. The old behaviour may be obtained by setting
+ ``overcloud_dib_build_host_images`` to ``false``.