suggested changes

Author: bertiethorpe

.github/bin/get-s3-image.sh

@@ -12,15 +12,15 @@ bucket_name=$2
 echo "Checking if image $image_name exists in OpenStack"
 image_exists=$(openstack image list --name "$image_name" -f value -c Name)
 
-if [ "$image_exists" == "$image_name" ]; then
+if [ -n $image_exists ]; then
     echo "Image $image_name already exists in OpenStack."
 else
     echo "Image $image_name not found in OpenStack. Getting it from S3."
 
     wget https://object.arcus.openstack.hpc.cam.ac.uk/swift/v1/AUTH_3a06571936a0424bb40bc5c672c4ccb1/$bucket_name/$image_name --progress=dot:giga
 
     echo "Uploading image $image_name to OpenStack..."
-    openstack image create --file "$image_name" --disk-format qcow2 "$image_name" --progress
+    openstack image create --file $image_name --disk-format qcow2 $image_name --progress
 
     echo "Image $image_name has been uploaded to OpenStack."
 fi

.github/workflows/upload-release-image.yml.sample

@@ -1,13 +1,16 @@
-# This workflow dispatch is to be used on a downstream ansible-slurm-appliance repository. The workflow takes two inputs:
-# image name, and s3 bucket name. The image is searched for in the environment set openstack, and if not found there, 
-# downloads it from the ARCUS S3 bucket specified. The workflow then uploads the image to the openstack.
+# This workflow can be used to fetch images published by StackHPC and upload them to a client's OpenStack. 
+# The workflow takes two inputs:
+# - image name
+# - s3 bucket name
+# and first checks to see if the image exists in the target OpenStack. If the image doesn't exist, it is downloaded 
+# from StackHPC's public S3 bucket and then uploaded to the target OpenStack.
 #
 # To use this workflow in a downstream ansible-slurm-appliance repository simply copy it into .github/workflows
 # and give it an appropriate name, e.g.
 # cp .github/workflows/upload-s3-image.yml.sample .github/workflows/upload-s3-image.yml
 #
-# In order for the workflow to access the openstack, credentials in the form of a clouds.yaml file must be provided by a
-# secret. This secret should have the name OS_CLOUD_YAML to be found by the workflow.
+# In order for the workflow to access the target OpenStack, an application credential clouds.yaml file must be 
+# added as a repository secret named OS_CLOUD_YAML.
 # Details on the contents of the clouds.yaml file can be found at https://docs.openstack.org/keystone/latest/user/application_credentials.html
 
 name: Upload release images to client sites from s3
@@ -53,15 +56,11 @@ jobs:
         if: cancelled()
         run: |
           . venv/bin/activate
-          image_hanging=$(openstack image list --name ${{ inputs.image_name }} -f value -c ID)
-          if [ -n "$image_hanging" ]; then
+          image_hanging=$(openstack image list --name ${{ inputs.image_name }} -f value -c ID -c Status | grep -v ' queued$' | awk '{print $1}'
+          if [ -n $image_hanging ]; then
             echo "Cleaning up OpenStack image with ID: $image_hanging"
             openstack image delete $image_hanging
           else
             echo "No image ID found, skipping cleanup."
           fi
-        shell: bash
-
-      - name: Confirm Success
-        if: success()
-        run: echo "Deployment succeeded, no cleanup needed."
+        shell: bash

README.md

@@ -151,4 +151,4 @@ The `.github` directory contains a set of sample workflows which can be used by
 
 - An [upgrade check](.github/workflows/upgrade-check.yml.sample) workflow which automatically checks this upstream stackhpc/ansible-slurm-appliance repo for new releases and proposes a pull request to the downstream site-specific repo when a new release is published.
 
-- An [image upload](.github/workflows/upload-s3-image.yml.sample) workflow dispatch which takes an image name, downloads it from ARCUS s3 bucket if available, and uploads to downstream environment openstack.
+- An [image upload](.github/workflows/upload-s3-image.yml.sample) workflow which takes an image name, downloads it from StackHPC's public S3 bucket if available, and uploads it to the target OpenStack cloud.