Add scripts for fixing Ansible playbook paths

Alex-Welsh · Alex-Welsh · commit d6bc9ed90ec7 · 2025-07-07T16:44:46.000+01:00
Ansible playbooks have been moved to sub-directories. This has the
potential to break a lot of symlink hooks. To make the transition
easier, this change includes a magic script which will fix symlink
paths.

Also added docs and fixed existing symlink paths
diff --git a/doc/source/operations/upgrading-openstack.rst b/doc/source/operations/upgrading-openstack.rst
@@ -165,6 +165,22 @@ For example:
          - "pulp:http_2xx:{{ pulp_url }}/pulp/api/v3/status/"
       enabled: "{{ seed_pulp_container_enabled | bool }}"
 
+Ansible playbook subdirectories
+--------------------------------------
+
+The playbooks under ``etc/kayobe/ansible`` have been subdivided into different
+categories to make them easier to navigate. This change may result in merge
+conflicts where playbooks have been edited downstream, and broken hooks where
+symlinks have been used.
+
+To mitigate the impact of these changes, two scripts have been added:
+
+* ``tools/get-new-playbook-path.sh`` - Returns the new category of a given
+  playbook. For example ``tools/get-new-playbook-path.sh
+  deploy-os-capacity-exporter.yml`` returns ``deployment/``
+* ``tools/magic-symlink-fix.sh`` - Uses the previous script to attempt to fix
+  any broken symlinks in the kayobe configuration.
+
 Known issues
 ============
 
diff --git a/etc/kayobe/environments/ci-multinode/hooks/overcloud-host-configure/pre.d/10-fix-hostname.yml b/etc/kayobe/environments/ci-multinode/hooks/overcloud-host-configure/pre.d/10-fix-hostname.yml
@@ -1 +1 @@
-../../../../../ansible/fix-hostname.yml
+../../../../../ansible/fixes/fix-hostname.yml
diff --git a/etc/kayobe/hooks/control-host-bootstrap/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/control-host-bootstrap/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/control-host-upgrade/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/control-host-upgrade/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/infra-vm-host-configure/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/infra-vm-host-configure/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/infra-vm-host-configure/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/infra-vm-host-configure/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/infra-vm-service-deploy/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/infra-vm-service-deploy/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/infra-vm-service-deploy/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/infra-vm-service-deploy/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/overcloud-host-configure/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/overcloud-host-configure/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/overcloud-host-configure/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/overcloud-host-configure/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/overcloud-host-configure/pre.d/pci-passthrough.yml b/etc/kayobe/hooks/overcloud-host-configure/pre.d/pci-passthrough.yml
@@ -1 +1 @@
-../../../ansible/pci-passthrough.yml
+../../../ansible/maintenance/pci-passthrough.yml
diff --git a/etc/kayobe/hooks/overcloud-host-package-update/post.d/10-fix-grub-rl9.yml b/etc/kayobe/hooks/overcloud-host-package-update/post.d/10-fix-grub-rl9.yml
@@ -1 +1 @@
-../../../ansible/fix-grub-rl9.yml
+../../../ansible/fixes/fix-grub-rl9.yml
diff --git a/etc/kayobe/hooks/overcloud-host-upgrade/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/overcloud-host-upgrade/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/overcloud-host-upgrade/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/overcloud-host-upgrade/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/overcloud-service-deploy/post.d/deploy-os-capacity-exporter.yml b/etc/kayobe/hooks/overcloud-service-deploy/post.d/deploy-os-capacity-exporter.yml
@@ -1 +1 @@
-../../../ansible/deploy-os-capacity-exporter.yml
+../../../ansible/deployment/deploy-os-capacity-exporter.yml
diff --git a/etc/kayobe/hooks/overcloud-service-deploy/post.d/deploy-radosgw-usage-exporter.yml b/etc/kayobe/hooks/overcloud-service-deploy/post.d/deploy-radosgw-usage-exporter.yml
@@ -1 +1 @@
-../../../ansible/deploy-radosgw-usage-exporter.yml
+../../../ansible/deployment/deploy-radosgw-usage-exporter.yml
diff --git a/etc/kayobe/hooks/overcloud-service-deploy/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/overcloud-service-deploy/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/overcloud-service-deploy/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/overcloud-service-deploy/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/overcloud-service-reconfigure/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/overcloud-service-reconfigure/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/overcloud-service-reconfigure/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/overcloud-service-reconfigure/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/overcloud-service-upgrade/post.d/deploy-os-capacity-exporter.yml b/etc/kayobe/hooks/overcloud-service-upgrade/post.d/deploy-os-capacity-exporter.yml
@@ -1 +1 @@
-../../../ansible/deploy-os-capacity-exporter.yml
+../../../ansible/deployment/deploy-os-capacity-exporter.yml
diff --git a/etc/kayobe/hooks/overcloud-service-upgrade/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/overcloud-service-upgrade/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/overcloud-service-upgrade/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/overcloud-service-upgrade/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/seed-host-configure/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/seed-host-configure/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/seed-host-configure/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/seed-host-configure/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/seed-hypervisor-host-configure/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/seed-hypervisor-host-configure/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/seed-hypervisor-host-configure/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/seed-hypervisor-host-configure/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/etc/kayobe/hooks/seed-service-deploy/pre.d/check-kayobe-version.yml b/etc/kayobe/hooks/seed-service-deploy/pre.d/check-kayobe-version.yml
@@ -1 +1 @@
-../../../ansible/check-kayobe-version.yml
+../../../ansible/tools/check-kayobe-version.yml
diff --git a/etc/kayobe/hooks/seed-service-deploy/pre.d/check-kolla-ansible-version.yml b/etc/kayobe/hooks/seed-service-deploy/pre.d/check-kolla-ansible-version.yml
@@ -1 +1 @@
-../../../ansible/check-kolla-ansible-version.yml
+../../../ansible/tools/check-kolla-ansible-version.yml
diff --git a/releasenotes/notes/ansible-playbook-categories-4abf3a4246d45cba.yaml b/releasenotes/notes/ansible-playbook-categories-4abf3a4246d45cba.yaml
@@ -0,0 +1,12 @@
+---
+upgrade:
+  - |
+    The playbooks under ``etc/kayobe/ansible`` have been subdivided into
+    different categories to make them easier to navigate. This change may
+    result in merge conflicts where playbooks have been edited downstream, and
+    broken hooks where symlinks have been used.
+
+    To mitigate the impact of these changes, two scripts have been added to
+    help fix broken links. ``tools/get-new-playbook-path.sh`` returns the new
+    category of a given playbook, and ``tools/magic-symlink-fix.sh`` attempts
+    to fix any broken symlinks in the kayobe configuration.
diff --git a/tools/get-new-playbook-path.sh b/tools/get-new-playbook-path.sh
@@ -0,0 +1,139 @@
+#!/bin/bash
+
+# Script to determine the new directory of a playbook based on its name.
+
+# Check if an argument is provided
+if [ "$#" -ne 1 ]; then
+    echo "Usage: $0 <playbook-name>"
+    exit 1
+fi
+
+PLAYBOOK_NAME="$1"
+
+# Arrays for specific cases
+PULP_PLAYBOOKS=(
+    "pulp-container-publish.yml"
+    "pulp-container-sync.yml"
+    "pulp-host-image-download.yml"
+    "pulp-repo-promote-production.yml"
+    "pulp-amphora-image-download.yml"
+    "pulp-repo-publish.yml"
+    "pulp-artifact-promote.yml"
+    "pulp-repo-sync.yml"
+    "pulp-artifact-upload.yml"
+    "pulp-sync-publish-promote.yml"
+    "pulp-auth-proxy.yml"
+)
+CEPH_PLAYBOOKS=(
+    "cephadm-keys.yml"
+    "cephadm-pools.yml"
+    "cephadm-commands-post.yml"
+    "cephadm.yml"
+    "cephadm-commands-pre.yml"
+    "ceph-enter-maintenance.yml"
+    "cephadm-crush-rules.yml"
+    "ceph-exit-maintenance.yml"
+    "cephadm-deploy.yml"
+    "cephadm-ec-profiles.yml"
+    "cephadm-gather-keys.yml"
+)
+VAULT_PLAYBOOKS=(
+    "vault-deploy-overcloud.yml"
+    "vault-deploy-seed.yml"
+    "vault-generate-backend-tls.yml"
+    "vault-generate-internal-tls.yml"
+    "vault-generate-test-external-tls.yml"
+    "vault-unseal-overcloud.yml"
+    "vault-unseal-seed.yml"
+    "vault-deploy-barbican.yml"
+)
+BAO_PLAYBOOKS=(
+    "openbao-deploy-overcloud.yml"
+    "openbao-deploy-seed.yml"
+    "openbao-generate-backend-tls.yml"
+    "openbao-generate-internal-tls.yml"
+    "openbao-generate-test-external-tls.yml"
+    "openbao-unseal-overcloud.yml"
+    "openbao-unseal-seed.yml"
+    "openbao-deploy-barbican.yml"
+)
+FIXES_PLAYBOOKS=(
+    "ovn-fix-chassis-priorities.yml"
+    "run-container-hotfix.yml"
+    "fix-grub-rl9.yml"
+    "fix-hostname.yml"
+    "fix-houston.yml"
+    "fix-networking.yml"
+    "hotfix-containers.yml"
+    "rabbitmq-reset.yml"
+    "purge-command-not-found.yml"
+)
+DEPLOYMENT_PLAYBOOKS=(
+    "deploy-github-runner.yml"
+    "deploy-os-capacity-exporter.yml"
+    "deploy-radosgw-usage-exporter.yml"
+    "smartmon-tools.yml"
+    "wazuh-agent.yml"
+    "wazuh-manager.yml"
+    "wazuh-secrets.yml"
+    "write-github-workflows.yml"
+)
+MAINTENANCE_PLAYBOOKS=(
+    "nova-compute-disable.yml"
+    "nova-compute-drain.yml"
+    "nova-compute-enable.yml"
+    "reboot.yml"
+    "rekey-hosts.yml"
+    "reset-bls-entries.yml"
+    "stop-openstack-services.yml"
+    "pci-passthrough.yml"
+    "ubuntu-upgrade.yml"
+    "cis.yml"
+    "octavia-amphora-image-build.yml"
+    "octavia-amphora-image-register.yml"
+)
+TOOLS_PLAYBOOKS=(
+    "advise-run.yml"
+    "build-ofed-rocky.yml"
+    "check-kayobe-version.yml"
+    "check-kolla-ansible-version.yml"
+    "check-kolla-images-py.yml"
+    "check-tags.yml"
+    "configure-aio-resources.yml"
+    "configure-vxlan.yml"
+    "diagnostics.yml"
+    "docker-registry-login.yml"
+    "firewalld-watchdog.yml"
+    "growroot.yml"
+    "install-doca.yml"
+    "install-pre-commit-hooks.yml"
+    "openstack-host-image-upload.yml"
+    "prometheus-network-names.yml"
+    "prometheus.yml.j2"
+    "push-ofed.yml"
+    "rsyslog.yml"
+    "stackhpc-cloud-tests.yml"
+)
+
+
+# Match name
+if [[ " ${PULP_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "pulp/"
+elif [[ " ${CEPH_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "ceph/"
+elif [[ " ${VAULT_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "vault/"
+elif [[ " ${BAO_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "bao/"
+elif [[ " ${FIXES_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "fixes/"
+elif [[ " ${DEPLOYMENT_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "deployment/"
+elif [[ " ${MAINTENANCE_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "maintenance/"
+elif [[ " ${TOOLS_PLAYBOOKS[*]} " =~ [[:space:]]$PLAYBOOK_NAME[[:space:]] ]]; then
+    echo "tools/"
+else
+    echo "Error: Unknown playbook name '$PLAYBOOK_NAME'" >&2
+    exit 1
+fi
diff --git a/tools/magic-symlink-fix.sh b/tools/magic-symlink-fix.sh
@@ -0,0 +1,43 @@
+#!/bin/bash
+
+# Script to fix broken symlinks to playbooks by updating their paths.
+
+# Ensure KAYOBE_CONFIG_PATH is defined
+if [[ -z "$KAYOBE_CONFIG_PATH" ]]; then
+    echo "Error: KAYOBE_CONFIG_PATH is not defined."
+    exit 1
+fi
+
+pushd "$KAYOBE_CONFIG_PATH/../.." > /dev/null
+
+HELPER_SCRIPT="$KAYOBE_CONFIG_PATH/../../tools/get-new-playbook-path.sh"
+
+# Find all broken symlinks
+for symlink in $(find . -xtype l); do
+
+    # Set up vars
+    symlink_directory=$(dirname "$symlink")
+    target=$(readlink "$symlink")
+    playbook_name=$(basename "$target")
+
+    # Get new directory name
+    new_directory=$("$HELPER_SCRIPT" "$playbook_name")
+    if [[ -z "$new_directory" ]]; then
+        echo "Warning: Could not determine new dir for playbook '$playbook_name' - Skipping '$symlink'"
+        continue
+    fi
+
+    # Construct the new target path & check it actually exists
+    new_target=$(dirname "$target")/$new_directory$playbook_name
+    if [[ ! -e "$symlink_directory/$new_target" ]]; then
+        echo "Warning: New target '$symlink_directory/$new_target' does not exist. Skipping '$symlink'."
+        exit 0
+        continue
+    fi
+
+    # Update the symlink
+    ln -sf "$new_target" "$symlink"
+    echo "Updated symlink: $symlink -> $new_target"
+done
+
+popd > /dev/null

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-../../../../../ansible/fix-hostname.yml`
	`1`	`+../../../../../ansible/fixes/fix-hostname.yml`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-../../../ansible/check-kayobe-version.yml`
	`1`	`+../../../ansible/tools/check-kayobe-version.yml`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-../../../ansible/check-kolla-ansible-version.yml`
	`1`	`+../../../ansible/tools/check-kolla-ansible-version.yml`