openstack/kayobe
Code Issues Proposed changes

Change IPA compression algorithm from default gzip to zstd -19

Browse Source 
Updates the IPA (Ironic Python Agent) compression algorithm from
the default gzip to use zstd -19 instead. This reduces the
transfer size of the IPA boot ISO from the Ironic conductor
to the baremetal nodes during provisioning.

Change-Id: Id0938c3fef6ccb9ceb556ce68a442393eabf2624
Signed-off-by: Claudia Watson <claudia@stackhpc.com>
This commit is contained in:
Claudia Watson
2025-09-25 15:21:54 +01:00
parent 751d52ca44
commit 6986fea598
4 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
ansible/inventory/group_vars/all/ipa
View File

@@ -20,7 +20,7 @@ ipa_builder_source_url: "https://opendev.org/openstack/ironic-python-agent-build
ipa_builder_source_version: "{{ openstack_branch }}"
# List of additional build host packages to install.
ipa_build_dib_host_packages_extra: []
ipa_build_dib_host_packages_extra: [ 'zstd' ]
# List of default Diskimage Builder (DIB) elements to use when building IPA
# images. Default is ["centos", "dynamic-login", "enable-serial-console",
@@ -53,6 +53,7 @@ ipa_build_dib_env_default:
DIB_REPOLOCATION_ironic_python_agent: "{{ ipa_build_source_url }}"
DIB_REPOREF_ironic_python_agent: "{{ ipa_build_source_version }}"
DIB_REPOREF_requirements: "{{ ipa_build_source_version }}"
DIB_IPA_COMPRESS_CMD: 'zstd -19'
# Dictionary of additional environment variables to provide to Diskimage
# Builder (DIB) during IPA image build.
@@ -83,7 +84,7 @@ ipa_build_dib_git_elements_extra: []
ipa_build_dib_git_elements: >-
{{ ipa_build_dib_git_elements_default + ipa_build_dib_git_elements_extra }}
# List of DIB packages to install. Default is none.
# List of DIB packages to install. Default is empty list.
ipa_build_dib_packages: []
# Upper constraints file for installing packages in the virtual environment

3
doc/source/configuration/reference/ironic-python-agent.rst
View File

@@ -45,8 +45,7 @@ image build``.
``ipa_builder_source_version``
Version of IPA builder source repository. Default is ``master``.
``ipa_build_dib_host_packages_extra``
List of additional build host packages to install. Default is an empty
list.
List of additional build host packages to install. Default is ``[ 'zstd' ]``.
``ipa_build_dib_elements_default``
List of default Diskimage Builder (DIB) elements to use when building IPA
images. Default is ``["centos", "dynamic-login", "enable-serial-console",

4
etc/kayobe/ipa.yml
View File

@@ -19,7 +19,7 @@
# Version of IPA builder source repository. Default is {{ openstack_branch }}.
#ipa_builder_source_version:
# List of additional build host packages to install. Default is an empty list.
# List of additional build host packages to install. Default is [ 'zstd' ].
#ipa_build_dib_host_packages_extra:
# List of default Diskimage Builder (DIB) elements to use when building IPA
@@ -64,7 +64,7 @@
# ipa_build_dib_git_elements_default and ipa_build_dib_git_elements_extra.
#ipa_build_dib_git_elements:
# List of DIB packages to install. Default is none.
# List of DIB packages to install. Default is empty list.
#ipa_build_dib_packages:
# Upper constraints file for installing packages in the virtual environment

14
releasenotes/notes/change-IPA-compression-algorithm-to-zstd-19-b3860e0a24ca824e.yaml Normal file
View File

@@ -0,0 +1,14 @@
---
features:
- |
Changes the IPA (Ironic Python Agent) image compression algorithm from
the default ``gzip`` to ``zstd``. This improves provisioning
performance by reducing the size of the IPA boot ISO transferred from
the Ironic conductor to the bare metal nodes.
upgrade:
- |
Changes the IPA (Ironic Python Agent) image compression algorithm from
default ``gzip`` to ``zstd``. The ``ipa_build_dib_env_default`` dictionary
now includes ``DIB_IPA_COMPRESS_CMD`` set to ``zstd -19``.
The default ``ipa_build_dib_host_packages_extra`` has been changed from
none to ``['zstd']``.