Merge branch 'stackhpc/2024.1' into sync-2024.1

Author: Alex-Welsh

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

@@ -412,7 +412,8 @@ jobs:
             -v $(pwd)/sct-results:/stack/sct-results \
             -e KAYOBE_ENVIRONMENT -e KAYOBE_VAULT_PASSWORD -e KAYOBE_AUTOMATION_SSH_PRIVATE_KEY \
             $KAYOBE_IMAGE \
-            /stack/kayobe-automation-env/src/kayobe-config/.automation/pipeline/playbook-run.sh '$KAYOBE_CONFIG_PATH/ansible/stackhpc-cloud-tests.yml' -e sct_version=${{ inputs.stackhpc_cloud_tests_version }}
+            /stack/kayobe-automation-env/src/kayobe-config/.automation/pipeline/playbook-run.sh '$KAYOBE_CONFIG_PATH/ansible/stackhpc-cloud-tests.yml' \
+            -e sct_version=${{ inputs.stackhpc_cloud_tests_version }}
         env:
           KAYOBE_AUTOMATION_SSH_PRIVATE_KEY: ${{ steps.ssh_key.outputs.ssh_key }}
 

.github/workflows/stackhpc-container-image-build.yml

@@ -92,17 +92,17 @@ jobs:
       - name: Generate build matrix
         id: set-matrix
         run: |
-          comma=""
-          echo -n "matrix={\"distro\": [" >> $GITHUB_OUTPUT
+          output="{'distro': ["
           if [[ ${{ inputs.rocky-linux-9 }} == 'true' ]]; then
-            echo -n "$comma\"rocky\"" >> $GITHUB_OUTPUT
-            comma=", "
+              output+="{'name': 'rocky', 'release': 9},"
           fi
           if [[ ${{ inputs.ubuntu-noble }} == 'true' ]]; then
-            echo -n "$comma\"ubuntu\"" >> $GITHUB_OUTPUT
-            comma=", "
+              output+="{'name': 'ubuntu', 'release': 'noble'},"
           fi
-          echo "]}" >> $GITHUB_OUTPUT
+          # remove trailing comma
+          output="${output%,}"
+          output+="]}"
+          echo "matrix=$output" >> $GITHUB_OUTPUT
 
       - name: Display container datetime tag
         run: |
@@ -203,7 +203,8 @@ jobs:
         continue-on-error: true
         run: |
           args="${{ inputs.regexes }}"
-          args="$args -e kolla_base_distro=${{ matrix.distro }}"
+          args="$args -e kolla_base_distro=${{ matrix.distro.name }}"
+          args="$args -e kolla_base_distro_version=${{ matrix.distro.release }}"
           args="$args -e kolla_tag=${{ steps.write-kolla-tag.outputs.kolla-tag }}"
           args="$args -e stackhpc_repo_mirror_auth_proxy_enabled=true"
           source venvs/kayobe/bin/activate &&
@@ -221,7 +222,8 @@ jobs:
         id: build_seed_images
         continue-on-error: true
         run: |
-          args="-e kolla_base_distro=${{ matrix.distro }}"
+          args="-e kolla_base_distro=${{ matrix.distro.name }}"
+          args="$args -e kolla_base_distro_version=${{ matrix.distro.release }}"
           args="$args -e kolla_tag=${{ steps.write-kolla-tag.outputs.kolla-tag }}"
           args="$args -e stackhpc_repo_mirror_auth_proxy_enabled=true"
           source venvs/kayobe/bin/activate &&
@@ -236,13 +238,13 @@ jobs:
         if: inputs.seed
 
       - name: Get built container images
-        run: docker image ls --filter "reference=ark.stackhpc.com/stackhpc-dev/*:${{ steps.write-kolla-tag.outputs.kolla-tag }}" > ${{ matrix.distro }}-container-images
+        run: docker image ls --filter "reference=ark.stackhpc.com/stackhpc-dev/*:${{ steps.write-kolla-tag.outputs.kolla-tag }}" > ${{ matrix.distro.name }}-${{ matrix.distro.release }}-container-images
 
       - name: Fail if no images have been built
-        run: if [ $(wc -l < ${{ matrix.distro }}-container-images) -le 1 ]; then exit 1; fi
+        run: if [ $(wc -l < ${{ matrix.distro.name }}-${{ matrix.distro.release }}-container-images) -le 1 ]; then exit 1; fi
 
       - name: Scan built container images
-        run: src/kayobe-config/tools/scan-images.sh ${{ matrix.distro }} ${{ steps.write-kolla-tag.outputs.kolla-tag }}
+        run: src/kayobe-config/tools/scan-images.sh ${{ matrix.distro.name }}-${{ matrix.distro.release }} ${{ steps.write-kolla-tag.outputs.kolla-tag }}
 
       - name: Move image scan logs to output artifact
         run: mv image-scan-output image-build-logs/image-scan-output
@@ -297,7 +299,7 @@ jobs:
       - name: Upload output artifact
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ matrix.distro }}-logs
+          name: ${{ matrix.distro.name }}-${{ matrix.distro.release }}-logs
           path: image-build-logs
           retention-days: 7
         if: ${{ !cancelled() }}

.github/workflows/stackhpc-update-kolla.yml

@@ -0,0 +1,29 @@
+name: Update Kolla versions
+
+on:
+  # Allow manual executions
+  workflow_dispatch:
+  # Run weekly on Tuesday
+  schedule:
+    - cron: '0 0 * * 2'
+
+jobs:
+  update-from-branch:
+    name: Update dependencies
+    strategy:
+      matrix:
+        include:
+          - version: stackhpc/2023.1
+            codename: Antelope
+          - version: stackhpc/2024.1
+            codename: Caracal
+          - version: stackhpc/master
+            codename: master
+    uses: ./.github/workflows/update-dependencies.yml
+    with:
+      openstack_version: ${{ matrix.version }}
+      openstack_codename: ${{ matrix.codename }}
+    permissions:
+      contents: write
+      pull-requests: write
+    if: github.repository == 'stackhpc/stackhpc-kayobe-config'

.github/workflows/update-dependencies.yml

@@ -1,11 +1,16 @@
 name: Update dependencies
 
 on:
-  # Allow manual executions
-  workflow_dispatch:
-  # Run nightly
-  schedule:
-    - cron: '0 0 * * *'
+  workflow_call:
+    inputs:
+      openstack_version:
+        description: OpenStack version
+        type: string
+        required: true
+      openstack_codename:
+        description: OpenStack codename
+        type: string
+        required: true
 
 jobs:
   propose_github_release_updates:
@@ -38,20 +43,14 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
+          ref: ${{ inputs.openstack_version }}
           path: ${{ github.workspace }}/src/kayobe-config
 
-      - name: Determine OpenStack release
-        id: openstack_release
-        run: |
-          BRANCH=$(awk -F'=' '/defaultbranch/ {print $2}' .gitreview)
-          echo "openstack_release=${BRANCH}" | sed -E "s,(stable|unmaintained)/,," >> $GITHUB_OUTPUT
-        working-directory: ${{ github.workspace }}/src/kayobe-config
-
       - name: Checkout the dependency repo
         uses: actions/checkout@v4
         with:
           repository: ${{ matrix.repository }}
-          ref: stackhpc/${{ steps.openstack_release.outputs.openstack_release }}
+          ref: ${{ inputs.openstack_version }}
           fetch-tags: true
           path: ${{ github.workspace }}/src/${{ matrix.key }}
 
@@ -78,10 +77,17 @@ jobs:
           path: ${{ github.workspace }}/src/kayobe-config
           commit-message: >-
             Bump ${{ matrix.key }} to ${{ steps.latest_tag.outputs.latest_tag }}
-          branch: update-dependency/${{ matrix.key }}
+          author: stackhpc-ci <22933334+stackhpc-ci@users.noreply.github.com>
+          branch: update-dependency/${{ matrix.key }}/${{ inputs.openstack_version }}
           delete-branch: true
           title: >-
             Bump ${{ matrix.key }} to ${{ steps.latest_tag.outputs.latest_tag }}
           body: >
-            This PR was created automatically to update
+            This PR was created automatically to update ${{ inputs.openstack_version }}
             ${{ matrix.key }} to ${{ steps.latest_tag.outputs.latest_tag }}.
+
+            GitHub Release Changelog:
+            https://github.com/stackhpc/${{ matrix.key }}/releases/tag/${{ steps.latest_tag.outputs.latest_tag }}
+          labels: |
+            automated
+            ${{ inputs.openstack_codename }}

doc/source/configuration/cephadm.rst

@@ -206,8 +206,8 @@ Pools
 ~~~~~
 
 The following example pools should be sufficient to work with the
-default `external Ceph
-configuration <https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html>`__
+default :kolla-ansible-doc:`external Ceph
+configuration <reference/storage/external-ceph-guide.html>`
 for Cinder, Cinder backup, Glance, and Nova in Kolla Ansible.
 
 .. code:: yaml
@@ -234,8 +234,8 @@ Keys
 ~~~~
 
 The following example keys should be sufficient to work with the default
-`external Ceph
-configuration <https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html>`__
+:kolla-ansible-doc:`external Ceph
+configuration <reference/storage/external-ceph-guide.html>`
 for Cinder, Cinder backup, Glance, and Nova in Kolla Ansible.
 
 .. code:: yaml
@@ -351,7 +351,7 @@ RADOS Gateways
 
 RADOS Gateway integration is described in the :kolla-ansible-doc:`Kolla Ansible
 documentation
-<https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html#radosgw>`.
+<reference/storage/external-ceph-guide.html#radosgw>`.
 
 RADOS Gateways (RGWs) are defined with the following:
 

doc/source/configuration/ci-cd.rst

@@ -118,7 +118,7 @@ Runner Deployment
     The repository permissions for a fine-grained personal access token should be; :code:`Actions: R/W, Administration: R/W, Metadata: R`
     Once the key has been obtained, add it to :code:`secrets.yml` under :code:`secrets_github_access_token`
 
-7. If the host is an actual Infra VM then please refer to upstream `Infrastructure VMs <https://docs.openstack.org/kayobe/latest/configuration/reference/infra-vms.html>`__ documentation for additional configuration and steps.
+7. If the host is an actual Infra VM then please refer to upstream :kayobe-doc:`Infrastructure VMs <configuration/reference/infra-vms.html>` documentation for additional configuration and steps.
 
 8. Run :code:`kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/deploy-github-runner.yml`
 

doc/source/configuration/cloudkitty.rst

@@ -8,8 +8,8 @@ Configuring in kayobe-config
 By default, CloudKitty uses Gnocchi and Ceilometer as the collector and fetcher
 backends. Unless the system has a specific reason not to, we recommend instead
 using Prometheus as the backend for both. The following instructions explain
-how to do this. Also, see the `Kolla Ansible docs on CloudKitty
-<https://docs.openstack.org/kolla-ansible/latest/reference/rating/cloudkitty-guide.html>`__
+how to do this. Also, see the :kolla-ansible-doc:`Kolla Ansible docs on CloudKitty
+<reference/rating/cloudkitty-guide.html>`
 for more details.
 
 Enable CloudKitty and disable InfluxDB, as we are using OpenSearch as the

doc/source/configuration/vault.rst

@@ -167,6 +167,15 @@ cannot be unsealed with an expired certificate.
 Certificates generation
 =======================
 
+.. note::
+
+   Generating certificates will fail if the Vault on the overcloud is sealed. This will happen whenever the vault containers are restarted. To unseal the
+   overcloud Vault, run:
+
+   .. code-block::
+
+      kayobe playbook run $KAYOBE_CONFIG_PATH/ansible/vault-unseal-overcloud.yml
+
 Create the external TLS certificates (testing only)
 ---------------------------------------------------
 

doc/source/index.rst

@@ -12,8 +12,8 @@ Overview
 ========
 
 This documentation covers the StackHPC Kayobe configuration. It is intended to
-complement, rather than replace, the upstream :kayobe-doc:`Kayobe </>`,
-:kolla-doc:`Kolla </>` and :kolla-ansible-doc:`Kolla Ansible </>`
+complement, rather than replace, the upstream :kayobe-doc:`Kayobe <>`,
+:kolla-doc:`Kolla <>` and :kolla-ansible-doc:`Kolla Ansible<>`
 documentation.
 
 The configuration includes various things, such as: