From 0b8547d7d952f83d6865a935e8e941d7700dd1ff Mon Sep 17 00:00:00 2001
From: Jacob Anders <janders@redhat.com>
Date: Thu, 2 May 2024 18:06:51 +1000
Subject: [PATCH] Make boot_interface customisable

This change adds a boot_interface variable to baremtal group_vars to
provide the user with a simple way of specifying boot_interface for node
enrollment.

Change-Id: Ic23dad7a0371c1cc68aa5f870225d6301ed4ed8e
---
 playbooks/inventory/group_vars/baremetal                  | 8 ++++++++
 playbooks/roles/ironic-enroll-dynamic/tasks/main.yml      | 1 +
 ...make-boot_interface-customisable-554636965176ecbb.yaml | 5 +++++
 3 files changed, 14 insertions(+)
 create mode 100644 releasenotes/notes/make-boot_interface-customisable-554636965176ecbb.yaml

diff --git a/playbooks/inventory/group_vars/baremetal b/playbooks/inventory/group_vars/baremetal
index e3c4773a4..6ddfff801 100644
--- a/playbooks/inventory/group_vars/baremetal
+++ b/playbooks/inventory/group_vars/baremetal
@@ -49,3 +49,11 @@ testing_user: root
 # failed.  Change wait_for_node_deploy to true to cause bifrost to wait for
 # Ironic to show the instance in Active state.
 wait_for_node_deploy: false
+
+# In deployments that use PXE boot and not virtual media, it is common to
+# set boot_interface to ipxe by default, however the value of this parameter
+# depends on the driver being used. While working on virtual media based
+# deployments it may be desirable to give the user an easy way of using
+# options such as  59 # boot_interface: redfish-virtual-media or
+# idrac-redfish-virtual-media - adding a commented-out value for those cases.
+# boot_interface: redfish-virtual-media
diff --git a/playbooks/roles/ironic-enroll-dynamic/tasks/main.yml b/playbooks/roles/ironic-enroll-dynamic/tasks/main.yml
index f24242968..58bae0c64 100644
--- a/playbooks/roles/ironic-enroll-dynamic/tasks/main.yml
+++ b/playbooks/roles/ironic-enroll-dynamic/tasks/main.yml
@@ -28,6 +28,7 @@
     auth_type: "{{ auth_type | default(omit) }}"
     auth: "{{ auth | default(omit) }}"
     ca_cert: "{{ tls_certificate_path | default(omit) }}"
+    boot_interface: "{{ boot_interface | default(omit) }}"
     driver: "{{ driver }}"
     uuid: "{{ uuid | default() }}"
     name: "{{ name | default() }}"
diff --git a/releasenotes/notes/make-boot_interface-customisable-554636965176ecbb.yaml b/releasenotes/notes/make-boot_interface-customisable-554636965176ecbb.yaml
new file mode 100644
index 000000000..1544da043
--- /dev/null
+++ b/releasenotes/notes/make-boot_interface-customisable-554636965176ecbb.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Makes boot_interface customisable. This is used in dynamic enrollment of
+    baremetal node.