From 06f6785df50f79d900fe458de6d9190a9257abfd Mon Sep 17 00:00:00 2001
From: Jake Hutchinson <jake@stackhpc.com>
Date: Mon, 9 Dec 2024 11:51:46 +0000
Subject: [PATCH] Documentation

---
 doc/source/configuration/ipa.rst              | 34 +++++++++++++++++++
 .../environments/ci-builder/inventory/hosts   |  1 +
 .../ipa-build-workflow-cde24f3b9e3e0667.yaml  |  6 ++++
 3 files changed, 41 insertions(+)
 create mode 100644 doc/source/configuration/ipa.rst
 create mode 100644 releasenotes/notes/ipa-build-workflow-cde24f3b9e3e0667.yaml

diff --git a/doc/source/configuration/ipa.rst b/doc/source/configuration/ipa.rst
new file mode 100644
index 000000000..276878b68
--- /dev/null
+++ b/doc/source/configuration/ipa.rst
@@ -0,0 +1,34 @@
+.. _ipa:
+
+=========================
+Ironic Python Agent (IPA)
+=========================
+
+Release Train IPA
+=================
+
+StackHPC provides built Ironic Python Agent (IPA) images in Release Train
+through Ark.
+
+These images are built in a CI using a Kayobe workflow :kayobe-doc:
+`Kayobe documentation <configuration/reference/ironic-python-agent.html>`
+and are configured in this repository.
+
+Release Train IPA is used by Bifrost and Overcloud Ironic by default in
+StackHPC Kayobe Configuration, and is pulled in to Inspector when running 
+``kayobe seed service deploy`` for Bifrost or ``kayobe overcloud post configure``
+for Ironic. This behaviour can be disabled in `stackhpc-ipa-images.yml`:
+
+.. code-block:: yaml
+
+    stackhpc_ipa_image_bifrost_enabled: false
+    stackhpc_ipa_image_overcloud_enabled: false
+
+You can also override the distribution version pulled in during deployment,
+to do this you can change ``stackhpc_ipa_image_version`` to be the opposite
+distribution. For example, the case of switching to Ubuntu 22.04 on a Rocky 9
+cloud:
+
+.. code-block:: yaml
+
+    stackhpc_ipa_image_version: "{{ stackhpc_ubuntu_jammy_ipa_image_version }}"
diff --git a/etc/kayobe/environments/ci-builder/inventory/hosts b/etc/kayobe/environments/ci-builder/inventory/hosts
index 722a42d1b..e2b89f71b 100644
--- a/etc/kayobe/environments/ci-builder/inventory/hosts
+++ b/etc/kayobe/environments/ci-builder/inventory/hosts
@@ -3,6 +3,7 @@
 [ofed-builder:children]
 seed
 
+# This is neccesary to run `overcloud deployment image build`
 [controllers]
 builder
 
diff --git a/releasenotes/notes/ipa-build-workflow-cde24f3b9e3e0667.yaml b/releasenotes/notes/ipa-build-workflow-cde24f3b9e3e0667.yaml
new file mode 100644
index 000000000..fb5130b5f
--- /dev/null
+++ b/releasenotes/notes/ipa-build-workflow-cde24f3b9e3e0667.yaml
@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Adds a new build workflow to Release Train for building IPA
+    images, and deployment for Release Train IPA images to Bifrost
+    and Ironic inspector.