Merge "Improve Ironic pin_release_version configuration"

ansible/group_vars/all.yml

@@ -779,9 +779,6 @@ openstack_logging_debug: "False"
 
 openstack_region_name: "RegionOne"
 
-# Variable defined the pin_release_version, apply for rolling upgrade process
-openstack_previous_release_name: "2024.1"
-
 # A list of policy file formats that are supported by Oslo.policy
 supported_policy_format_list:
   - policy.yaml

ansible/roles/ironic/defaults/main.yml

@@ -390,3 +390,11 @@ ironic_ks_user_roles:
 ironic_enable_tls_backend: "{{ kolla_enable_tls_backend }}"
 
 ironic_copy_certs: "{{ kolla_copy_ca_into_containers | bool or ironic_enable_tls_backend | bool }}"
+
+# Configuration for Ironic rolling upgrades
+# This variable controls the pin_release_version setting in Ironic
+# It should only be set when performing a slow rolling upgrade process
+# where you need to maintain compatibility between different versions
+# during the upgrade. For direct version jumps, this should be unset.
+# See: https://docs.openstack.org/ironic/latest/configuration/config.html#DEFAULT.pin_release_version
+ironic_pin_release_version: ""

ansible/roles/ironic/tasks/rolling_upgrade.yml

@@ -1,10 +1,14 @@
 ---
 - import_tasks: config-host.yml
 
-# Pin release version
+# Pin release version for rolling upgrades
+# This is only needed when performing a slow rolling upgrade process
+# where you need to maintain compatibility between different versions
+# during the upgrade. For direct version jumps, this section can be skipped.
 - import_tasks: config.yml
   vars:
-    pin_release_version: "{{ openstack_previous_release_name }}"
+    pin_release_version: "{{ ironic_pin_release_version }}"
+  when: ironic_pin_release_version | length > 0
 
 - import_tasks: check-containers.yml
 

releasenotes/notes/improve-ironic-pin-release-version-8f9e2b3c4d5a6b7c.yaml

@@ -0,0 +1,11 @@
+---
+upgrade:
+  - |
+    Improved the configuration of Ironic's pin_release_version setting by:
+
+    - Dropping variable ``openstack_previous_release_name`` and replacing
+      it with ``ironic_pin_release_version``
+    - Making the setting optional by default
+    - Adding proper documentation explaining when to use this setting
+
+    See `documentation for pin_release_version <https://docs.openstack.org/ironic/latest/configuration/config.html#DEFAULT.pin_release_version>`_ for more details.