Optionally keep self-hosted-runners allocated after creating them #11
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,10 +3,6 @@ name: create-azure-self-hosted-runners | |
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| runner_scope: | ||
| type: choice | ||
| required: true | ||
|
|
@@ -23,14 +19,26 @@ on: | |
| type: string | ||
| required: false | ||
| description: Repo to deploy the runner to. Only needed if runner_scope is set to "repo-level" (defaults to current repository) | ||
| deallocate_immediately: | ||
| type: string | ||
| required: true | ||
| description: Deallocate the runner immediately after creating it (useful for spinning up runners preemptively) | ||
| default: false | ||
|
|
||
| env: | ||
| ACTIONS_RUNNER_SCOPE: ${{ github.event.inputs.runner_scope }} | ||
| ACTIONS_RUNNER_ORG: "${{ github.event.inputs.runner_org || github.repository_owner }}" | ||
| ACTIONS_RUNNER_REPO: "${{ github.event.inputs.runner_repo || github.event.repository.name }}" | ||
| DEALLOCATE_IMMEDIATELY: ${{ github.event.inputs.deallocate_immediately }} | ||
| # This has to be a public URL that the VM can access after creation | ||
| POST_DEPLOYMENT_SCRIPT_URL: https://raw.githubusercontent.com/${{ github.repository }}/${{ github.ref }}/azure-self-hosted-runners/post-deployment-script.ps1 | ||
| # Note that you'll need "p" (arm64 processor) and ideally "d" (local temp disk). The number 8 stands for 8 CPU-cores. | ||
| # For a convenient overview of all arm64 VM types, see e.g. https://azureprice.net/?_cpuArchitecture=Arm64 | ||
| AZURE_VM_TYPE: Standard_D8plds_v5 | ||
| # At the time of writing, "eastus", "eastus2" and "westus2" were among the cheapest region for the VM type we're using. | ||
| # For more information, see https://learn.microsoft.com/en-us/azure/virtual-machines/dplsv5-dpldsv5-series (which | ||
| # unfortunately does not have more information about price by region) | ||
| AZURE_VM_REGION: westus2 | ||
|
|
||
| # The following secrets are required for this workflow to run: | ||
| # AZURE_CREDENTIALS - Credentials for the Azure CLI. It's recommended to set up a resource | ||
|
|
@@ -42,24 +50,8 @@ env: | |
| # AZURE_VM_USERNAME - Username of the VM so you can RDP into it | ||
| # AZURE_VM_PASSWORD - Password of the VM so you can RDP into it | ||
| jobs: | ||
| create-runner: | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| vm_name: ${{ steps.generate-vm-name.outputs.vm_name }} | ||
| steps: | ||
|
|
@@ -103,12 +95,12 @@ jobs: | |
| run: | | ||
| case "$ACTIONS_RUNNER_SCOPE" in | ||
| "org-level") | ||
| ACTIONS_API_URL="https://api.github.com/repos/$ACTIONS_RUNNER_ORG/actions/runners/registration-token" | ||
| ACTIONS_RUNNER_REGISTRATION_URL="https://github.com/$ACTIONS_RUNNER_ORG" | ||
| ;; | ||
| "repo-level") | ||
| ACTIONS_API_URL="https://api.github.com/repos/$ACTIONS_RUNNER_ORG/$ACTIONS_RUNNER_REPO/actions/runners/registration-token" | ||
| ACTIONS_RUNNER_REGISTRATION_URL="https://github.com/$ACTIONS_RUNNER_ORG/$ACTIONS_RUNNER_REPO" | ||
| ;; | ||
| *) | ||
| echo "Unsupported runner scope: $ACTIONS_RUNNER_SCOPE" | ||
|
|
@@ -124,7 +116,32 @@ jobs: | |
| $ACTIONS_API_URL \ | ||
| | jq --raw-output .token) | ||
| echo "::add-mask::$ACTIONS_RUNNER_TOKEN" | ||
|
|
||
| # The Azure VM type we use has blazing-fast local, temporary storage available as the D:\ drive. | ||
| # The only downside is that, after dellocation, the contents of this disk (including the Actions Runner), | ||
dennisameling marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # are destroyed. Let's only use it when we don't immediately deallocate the VM. | ||
| if [[ "$DEALLOCATE_IMMEDIATELY" == "true" ]]; then | ||
| ACTIONS_RUNNER_PATH="C:\a" | ||
| else | ||
| ACTIONS_RUNNER_PATH="D:\a" | ||
| fi | ||
|
|
||
| AZURE_ARM_PARAMETERS=$(tr '\n' ' ' <<-END | ||
| githubActionsRunnerRegistrationUrl="$ACTIONS_RUNNER_REGISTRATION_URL" | ||
| githubActionsRunnerToken="$ACTIONS_RUNNER_TOKEN" | ||
| postDeploymentPsScriptUrl="$POST_DEPLOYMENT_SCRIPT_URL" | ||
| virtualMachineName="${{ steps.generate-vm-name.outputs.vm_name }}" | ||
| virtualMachineSize="$AZURE_VM_TYPE" | ||
| publicIpAddressName1="${{ steps.generate-vm-name.outputs.vm_name }}-ip" | ||
| adminUsername="${{ secrets.AZURE_VM_USERNAME }}" | ||
| adminPassword="${{ secrets.AZURE_VM_PASSWORD }}" | ||
| stopService="$DEALLOCATE_IMMEDIATELY" | ||
| githubActionsRunnerPath="$ACTIONS_RUNNER_PATH" | ||
| location="$AZURE_VM_REGION" | ||
| END | ||
| ) | ||
|
|
||
| echo "AZURE_ARM_PARAMETERS=$AZURE_ARM_PARAMETERS" >> $GITHUB_ENV | ||
|
There was a problem hiding this comment. Is it really possible to put multi-line values into There was a problem hiding this comment. Ah, you need a There was a problem hiding this comment. I tested it locally, and There was a problem hiding this comment. Ah, I missed that the |
||
|
|
||
| - name: Azure Login | ||
| uses: azure/login@v1 | ||
|
|
@@ -135,9 +152,10 @@ jobs: | |
| with: | ||
| resourceGroupName: ${{ secrets.AZURE_RESOURCE_GROUP }} | ||
| template: ./azure-self-hosted-runners/azure-arm-template.json | ||
| parameters: ./azure-self-hosted-runners/azure-arm-template-example-parameters.json ${{ env.AZURE_ARM_PARAMETERS }} | ||
|
|
||
| - name: Deallocate the VM for later use | ||
| if: env.DEALLOCATE_IMMEDIATELY == 'true' | ||
| uses: azure/CLI@v1 | ||
| with: | ||
| azcliversion: 2.43.0 | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| name: delete azure-self-hosted-runner | ||
| run-name: Delete ${{ inputs.runner_name }} | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| runner_name: | ||
| type: string | ||
| required: true | ||
| description: The name of the runner that needs to be deleted | ||
|
|
||
| env: | ||
| ACTIONS_RUNNER_NAME: ${{ github.event.inputs.runner_name }} | ||
|
|
||
| # The following secrets are required for this workflow to run: | ||
| # AZURE_CREDENTIALS - Credentials for the Azure CLI. It's recommended to set up a resource | ||
| # group specifically for self-hosted Actions Runners. | ||
| # az ad sp create-for-rbac --name "{YOUR_DESCRIPTIVE_NAME_HERE}" --role contributor \ | ||
| # --scopes /subscriptions/{SUBSCRIPTION_ID_HERE}/resourceGroups/{RESOURCE_GROUP_HERE} \ | ||
| # --sdk-auth | ||
| # AZURE_RESOURCE_GROUP - Resource group to create the runner(s) in | ||
| jobs: | ||
| delete-runner: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Azure Login | ||
| uses: azure/login@v1 | ||
| with: | ||
| creds: ${{ secrets.AZURE_CREDENTIALS }} | ||
| - name: Delete VM '${{ env.ACTIONS_RUNNER_NAME }}' | ||
| uses: azure/CLI@v1 | ||
| with: | ||
| azcliversion: 2.43.0 | ||
| inlineScript: | | ||
| az vm delete -n "$ACTIONS_RUNNER_NAME" -g ${{ secrets.AZURE_RESOURCE_GROUP }} --yes | ||
|
There was a problem hiding this comment. This works, kind of. But it leaves two resources behind, the network security group and the virtual network:
@dennisameling you mentioned previously that we could avoid that by reusing a single resource? Or is there a way to pass one or two There was a problem hiding this comment. Let's see whether 4c2ba65 works. There was a problem hiding this comment. Looks like this is a known issue: Azure/azure-cli#22158 We might need 1-2 additional There was a problem hiding this comment. It also looks like There was a problem hiding this comment. Indeed, it does not work.
I guess we need 2 additional CLI calls, but we know the exact name i.e. we do not have to identify the resources via a separate call. There was a problem hiding this comment.
Yep - looks like that should be pretty straightforward: https://learn.microsoft.com/en-us/cli/azure/network/nsg?view=azure-cli-latest#az-network-nsg-delete There was a problem hiding this comment. We actually need three CLI calls, for vnet, nsg and public-ip |
||
| az network nsg delete -n "$ACTIONS_RUNNER_NAME"-nsg -g ${{ secrets.AZURE_RESOURCE_GROUP }} | ||
| az network vnet delete -n "$ACTIONS_RUNNER_NAME"-vnet -g ${{ secrets.AZURE_RESOURCE_GROUP }} | ||
| az network public-ip delete -n "$ACTIONS_RUNNER_NAME"-ip -g ${{ secrets.AZURE_RESOURCE_GROUP }} | ||
Uh oh!
There was an error while loading. Please reload this page.