Merge pull request #10 from gitpod-io/wv/add-label-input

Add label input to allow recreating the VM

Author: WVerlaek

.github/workflows/create-vm.yml

@@ -7,6 +7,12 @@ on:
         type: string
         required: false
         default: "default"
+      # If set, use this label instead of generating a random one (and 'task' will be ignored).
+      # Useful to recreate a runner VM that got shutdown.
+      label:
+        type: string
+        required: false
+        default: ""
     secrets:
       gcp_credentials:
         required: true
@@ -30,19 +36,20 @@ jobs:
         uses: actions/checkout@v4
       - name: Authenticate to Google Cloud
         id: auth
-        if: github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name      
+        if: github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name
         uses: google-github-actions/auth@v1
         with:
           credentials_json: ${{ secrets.gcp_credentials }}
       - name: Activate GCP service account
         id: gcloud-auth
-        if: github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name      
+        if: github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name
         shell: bash
         run: |
           gcloud auth activate-service-account --key-file ${{ steps.auth.outputs.credentials_file_path }}
       - id: create-runner
         uses: gitpod-io/gce-github-runner@main
         with:
           runner_token: ${{ secrets.runner_token }}
-          task: ${{ inputs.task }}        
+          task: ${{ inputs.task }}
+          label: ${{ inputs.label }}
           gcp_credentials: ${{ secrets.gcp_credentials }}

action.sh

@@ -28,6 +28,7 @@ disk_size=
 image_project=
 image=
 image_family=
+label=
 scopes=
 shutdown_timeout=
 task=
@@ -44,6 +45,7 @@ while getopts_long :h opt \
 	image_project optional_argument \
 	image optional_argument \
 	image_family optional_argument \
+	label optional_argument \
 	scopes required_argument \
 	shutdown_timeout required_argument \
 	task required_argument \
@@ -79,6 +81,9 @@ while getopts_long :h opt \
 	image_family)
 		image_family=${OPTLARG-$image_family}
 		;;
+	label)
+		label=${OPTLARG-$label}
+		;;
 	scopes)
 		scopes=$OPTLARG
 		;;
@@ -102,6 +107,10 @@ done
 
 function start_vm {
 	VM_ID="runner-$(echo ${GITHUB_RUN_ID}-${GITHUB_RUN_NUMBER}-${task} | sha1sum | cut -f 1 -d " ")"
+	if [ ! -z "${label}" ]; then
+		echo "Label provided, using it as VM ID (${label})"
+		VM_ID="${label}"
+	fi
 
 	if [ ! -z "$(gcloud compute instances list | grep "${VM_ID}")" ]; then
 		# the VM already exists.
@@ -114,7 +123,7 @@ function start_vm {
 	fi
 
 	echo "Starting GCE VM ..."
-	if [ -z "$runner_token" ]; then 
+	if [ -z "$runner_token" ]; then
 		echo "❌ runner_token parameter is required"
 		exit 1
 	fi
@@ -123,7 +132,7 @@ function start_vm {
 		-H "Authorization: Bearer $runner_token" \
 		"https://api.github.com/repos/$GITHUB_REPOSITORY/actions/runners/registration-token" |
 		jq -r .token)
-	if [ -z "$RUNNER_TOKEN" ]; then 
+	if [ -z "$RUNNER_TOKEN" ]; then
 		echo "❌ Failed to get a registration token"
 		exit 1
 	fi
@@ -202,10 +211,10 @@ REMOVE_TOKEN=\$(curl \
 	-H "Accept: application/vnd.github+json" \
 	-H "Authorization: Bearer ${RUNNER_TOKEN}" \
 	https://api.github.com/repos/${GITHUB_REPOSITORY}/actions/runners/remove-token | jq .token --raw-output)
-if [ -z "\$REMOVE_TOKEN" ]; then 
+if [ -z "\$REMOVE_TOKEN" ]; then
 	echo "❌ Failed to get a removal token"
 	exit 0
-fi 
+fi
 
 su -s /bin/bash -c "cd /actions-runner/;/actions-runner-1/config.sh remove --token \${REMOVE_TOKEN}" runner
 su -s /bin/bash -c "cd /actions-runner/;/actions-runner-2/config.sh remove --token \${REMOVE_TOKEN}" runner

action.yml

@@ -39,6 +39,11 @@ inputs:
   image_family:
     description: The image family for the operating system that the boot disk will be initialized with.
     required: false
+  label:
+    description: >-
+      Runner label. Can be set to override the VM name to recreate a runner with a specific label,
+      e.g. to replace a runner that was shutdown. If set, 'task' will be ignored.
+    required: false
   scopes:
     description: Scopes granted to the VM, defaults to full access (cloud-platform).
     default: cloud-platform
@@ -108,5 +113,6 @@ runs:
           --image_project=${{ inputs.image_project }} \
           --image=${{ inputs.image }} \
           --image_family=${{ inputs.image_family }} \
+          --label=${{ inputs.label }} \
           --boot_disk_type=pd-ssd \
           --task=${{ inputs.task }}