From d765fbc5ebb7c1a8f80d4c49f3846107e4f23189 Mon Sep 17 00:00:00 2001
From: Pierre Riteau <pierre@stackhpc.com>
Date: Thu, 11 Feb 2021 10:50:43 +0100
Subject: [PATCH] Update IPA docs and test build with extra-hardware
Change-Id: Id5ed0b594d6270c4a03606caa776bbb291be2694
---
.../reference/ironic-python-agent.rst | 36 ++++---------------
playbooks/kayobe-seed-base/overrides.yml.j2 | 4 ++-
2 files changed, 10 insertions(+), 30 deletions(-)
diff --git a/doc/source/configuration/reference/ironic-python-agent.rst b/doc/source/configuration/reference/ironic-python-agent.rst
index ab5c125c..f0689120 100644
--- a/doc/source/configuration/reference/ironic-python-agent.rst
+++ b/doc/source/configuration/reference/ironic-python-agent.rst
@@ -25,7 +25,7 @@ The following options cover building of IPA images via Diskimage-builder (DIB).
Consult the :diskimage-builder-doc:`Diskimage-builder documentation <>` for
full details.
-The default configuration builds a CentOS 7 ramdisk image which includes the
+The default configuration builds a CentOS 8 ramdisk image which includes the
upstream IPA source code, and has a serial console enabled.
The images are built for Bifrost via ``kayobe seed deployment image build``,
@@ -279,16 +279,6 @@ inspection.
Example: Adding the ``extra-hardware`` collector
------------------------------------------------
-.. note::
-
- The ``hardware`` Python package has dropped support for Python 2. If you
- are using an IPA image that uses Python 2 by default, for example CentOS 7,
- you will need to use a version of the ``hardware`` package that is no
- greater than ``0.23.x``. You can specify the version using the
- ``DIB_IPA_HARDWARE_VERSION`` environment variable. This can be added
- to the ``ipa_build_dib_env_extra`` dictionary in ``${KAYOBE_CONFIG_PATH}/ipa.yml``.
- For example: ``DIB_IPA_HARDWARE_VERSION: "0.23.0"``.
-
The ``extra-hardware`` collector may be used to collect additional information
about hardware during inspection. It is also a requirement for running
benchmarks. This collector depends on the Python `hardware package
@@ -303,29 +293,17 @@ The following example enables the ``extra-hardware`` collector:
ipa_collectors_extra:
- "extra-hardware"
-The `StackHPC image elements
-<https://github.com/stackhpc/stackhpc-image-elements>`__ git repository
-provides an ``ipa-extra-hardware`` element which may be used to install this
-package. It may be used as follows if building an IPA image locally:
+The ``ironic-python-agent-builder`` repository provides an `extra-hardware
+element
+<https://docs.openstack.org/ironic-python-agent-builder/latest/admin/dib.html#ironic-python-agent-ipa-extra-hardware>`__
+which may be used to install this package. It may be used as follows if
+building an IPA image locally:
.. code-block:: yaml
:caption: ``ipa.yml``
ipa_build_dib_elements_extra:
- - "ipa-extra-hardware"
-
- ipa_build_dib_git_elements:
- - repo: "https://github.com/stackhpc/stackhpc-image-elements"
- local: "{{ source_checkout_path }}/stackhpc-image-elements"
- version: "master"
- elements_path: "elements"
-
- ipa_build_dib_env_extra:
- # This is to workaround the fact that pip > 10 will produce an error if
- # you try and uninstall a distuils installed package. Previous versions
- # would remove the metadata only - leaving the code intact, see:
- # https://bugs.launchpad.net/diskimage-builder/+bug/1768135
- DIB_INSTALLTYPE_pip_and_virtualenv: package
+ - "extra-hardware"
Example: Passing additional kernel arguments to IPA
---------------------------------------------------
diff --git a/playbooks/kayobe-seed-base/overrides.yml.j2 b/playbooks/kayobe-seed-base/overrides.yml.j2
index 15aa1030..06173ea8 100644
--- a/playbooks/kayobe-seed-base/overrides.yml.j2
+++ b/playbooks/kayobe-seed-base/overrides.yml.j2
@@ -29,5 +29,7 @@ pip_index_url: "http://{{ zuul_site_mirror_fqdn }}/pypi/simple"
aio_bridge_ports:
- dummy1
-# Build seed deployment images (IPA)
+# Build seed deployment images (IPA) with extra-hardware element
ipa_build_images: true
+ipa_build_dib_elements_extra:
+ - "extra-hardware"
--
GitLab