Add explanatory comments for Caracal changes

Author: Alex-Welsh

.github/workflows/stackhpc-all-in-one.yml

@@ -264,6 +264,8 @@ jobs:
         run: |
           docker image pull $KAYOBE_IMAGE
 
+      # Reboot to ensure hostname does not contain .novalocal suffix
+      # See remote exec provisioner in vm.tf
       - name: Reboot
         run: |
           docker run -t --rm \

etc/kayobe/stackhpc.yml

@@ -145,6 +145,9 @@ stackhpc_kolla_source_version: "stackhpc/{{ openstack_release }}"
 
 # Kolla Ansible source repository.
 stackhpc_kolla_ansible_source_url: "https://github.com/stackhpc/kolla-ansible"
+# FIXME: Waiting for
+# https://review.opendev.org/c/openstack/kolla-ansible/+/926198 to merge and
+# sync to stackhpc/2024.1
 # stackhpc_kolla_ansible_source_version: "stackhpc/{{ openstack_release }}"
 stackhpc_kolla_ansible_source_version: "fix-prometheus"
 

terraform/aio/vm.tf

@@ -89,7 +89,8 @@ resource "null_resource" "kayobe-aio" {
       # current images, /tmp is noexec, so the path must be changed
       script_path = "/home/${var.ssh_username}/start.sh"
     }
-
+    # In Caracal, OVN fails on Rocky 9 hosts with hostnames that contain a
+    # subdomain (a dot in the name)
     inline = [
       "#!/bin/sh",
       "echo 'connected!'",