-
|
Hi everyone, I am wondering because I want to fetch the statistics available in ORG > Settings > Runner-Groups for normal GH runners through the API. ARC runner statistics: Thanks in advance! |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 6 replies
-
|
I had a similar challenge and after a bit of try and error found out following: export GH_API_BASE="https://api.github.com" # or https://github.enterprise.com/api/v3 for GitHub Enterprise Server
export GITHUB_TOKEN=ghp_abc1234 # GitHub access token with runner permissions (and org admin)
export SCALESET_ID="1" # The ID of the scaleset; can be easily seen in the URL when looking at the scaleset
export ORG="tobias-something-something" # The name of your organization
export RUNNER_REGISTRATION_URL="https://github.com/$ORG" # The URL to register runners on
export REGISTRATION_TOKEN=$(curl -u token:$GITHUB_TOKEN "$GH_API_BASE/orgs/$ORG/actions/runners/registration-token" -X POST -d '' | jq .token -r)
export PIPELINE_INFOS=$(curl -H "Authorization: RemoteAuth $REGISTRATION_TOKEN" -H "Content-Type: application/json" -d '{"url": "'$RUNNER_REGISTRATION_URL'", "runnerEvent": "register"}' "$GH_API_BASE/actions/runner-registration" -v -X POST)
export JWT_TOKEN=$(echo "$PIPELINE_INFOS" | jq -r .token)
export PIPELINE_URL=$(echo "$PIPELINE_INFOS" | jq -r .url)
curl -H "Authorization: Bearer $JWT_TOKEN" -H "Content-Type: application/json" "$PIPELINE_URL/_apis/runtime/runnerscalesets/$SCALESET_ID?api-version=6.0-preview" | jq .
{
"labels": [
{
"type": "system",
"id": 1,
"name": "my-autoscaling-set"
}
],
"createdOn": "2024-05-20T08:19:29.49Z",
"runnerSetting": {
"id": 0,
"runnerGroupId": null,
"name": null,
"version": null,
"ephemeral": true,
"status": 0
},
"runnerJitConfigUrl": "https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/generatejitconfig?api-version=6.0-preview",
"getAcquirableJobsUrl": "https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/acquirablejobs?api-version=6.0-preview",
"acquireJobsUrl": "https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/acquirejobs?api-version=6.0-preview",
"createSessionUrl": "https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/sessions?api-version=6.0-preview",
"statistics": {
"totalAvailableJobs": 0,
"totalAcquiredJobs": 0,
"totalAssignedJobs": 0,
"totalRunningJobs": 0,
"totalRegisteredRunners": 0,
"totalBusyRunners": 0,
"totalIdleRunners": 0
},
"id": 1,
"name": "my-autoscaling-set",
"queueName": "runnerscaleset-1",
"runnerGroupId": 1,
"runnerGroupName": "Default",
"enabled": true,
"status": "offline"
}Creating a ScalesetTo create a new scaleset you need to follow step 1 and 2 and then can create one using a POST request: curl -H "Authorization: Bearer $JWT_TOKEN" -H "Content-Type: application/json" "$PIPELINE_URL/_apis/runtime/runnerscalesets?api-version=6.0-preview" -d '{
"name": "my-autoscaling-set",
"runnerGroupId": 1,
"runnerSetting": {
"ephemeral": true,
"disableUpdate": true
}
}' |
Beta Was this translation helpful? Give feedback.
-
|
This is quite amazing! Thank you for sharing! To add onto this, you can curl -X PUT -H "Authorization: Bearer $JWT_TOKEN" -H "Content-Type: application/json" "$PIPELINE_URL/_apis/runtime/runnerscalesets/$SCALESET_ID?api-version=6.0-preview" -d '{
"name": "testeroni",
}' | jqI'm not really sure now how to delete the created runner scale set though, since the scope of the curl -X DELETE -H "Authorization: Bearer $JWT_TOKEN" -H "Content-Type: application/json" "$PIPELINE_URL/_apis/runtime/runnerscalesets/$SCALESET_ID?api-version=6.0-preview"
{"$id":"1","innerException":null,"message":"The user 'System:PublicAccess;aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' is not authorized to access this resource.","typeName":"Microsoft.TeamFoundation.Framework.Server.UnauthorizedRequestException, Microsoft.TeamFoundation.Framework.Server","typeKey":"UnauthorizedRequestException","errorCode":0,"eventId":3000}% Additionally, next thing to make sense and understand is how to use the returned |
Beta Was this translation helpful? Give feedback.
-
Deleting Scale SetYour DELETE-request is correct. My assumption is that the JWT_TOKEN might have expired in the meantime and you need to request a new one (step 2). For me deleting the scale sets is working with this request: curl -H "Authorization: Bearer $JWT_TOKEN" -H "Content-Type: application/json" "$PIPELINE_URL/_apis/runtime/runnerscalesets/$SCALESET_ID?api-version=6.0-preview" -X DELETERunner JIT ConfigThe Runner JIT config is a quite cool new addition. It allows you to create, for the specific scale set, the const startup_script = `#!/bin/bash
trap "shutdown now" ERR
runuser -l ${user} -c "export ACTIONS_RUNNER_INPUT_JITCONFIG=${jitConfig.encodedJITConfig} && /opt/actions-runner/run.sh"
shutdown now
`;To actually get the JITconfig you can perform a request against the $ curl -H "Authorization: Bearer $JWT_TOKEN" -H "Content-Type: application/json" "$PIPELINE_URL/_apis/runtime/runnerscalesets/$SCALESET_ID/generatejitconfig?api-version=6.0-preview" -d '{"name": "scaleset-runner-1", "workFolder": "/_work"}' | jq .
{
"runner": {
"maxParallelism": null,
"currentParallelism": null,
"createdOn": "0001-01-01T00:00:00",
"id": 33,
"runnerGroupId": 1,
"runnerScaleSetId": 1,
"name": "scaleset-runner-1",
"version": "2.316.1",
"enabled": true,
"ephemeral": true,
"isElastic": false,
"disableUpdate": false,
"status": 0
},
"encodedJITConfig": "eyIucnVubmVyIjoiZXlKQloyVnVkRWxrSWpvaU16TWlMQ0pCWjJWdWRFNWhiV1VpT2lKelkyRnNaWE5sZEMxeWRXNXVaWEl0TVNJc0lrUnBjMkZpYkdWVmNHUmhkR1VpT2lKR1lXeHpaU0lzSWtWd2FHVnRaWEpoYkNJNklsUnlkV1VpTENKUWIyOXNTV1FpT2lJeElpd2lVRzl2YkU1aGJXVWlPbTUxYkd3c0lsTmxjblpsY2xWeWJDSTZJbWgwZEhCek9pOHZjR2x3Wld4cGJtVnpaMmgxWW1WMWN6RTBMbUZqZEdsdmJuTXVaMmwwYUhWaWRYTmxjbU52Ym5SbGJuUXVZMjl0TDAxT01tNXZlVVI1Um5aUmRGUnBiMmQ2ZDI0d2FVNHdTbFF5V0ZocGIzTTBSWGN6ZWtjMFpGTjJjMFpzYTFSaWQzVklMeUlzSWxKMWJtNWxjbE5qWVd4bFUyVjBTV1FpT2lJeElpd2lVblZ1Ym1WeVUyTmhiR1ZUWlhST1lXMWxJam9pYlhrdFlYVjBiM05qWVd4cGJtY3RjMlYwSWl3aVYyOXlhMFp2YkdSbGNpSTZJaTlmZDI5eWF5SjkiLCIuY3JlZGVudGlhbHMiOiJleUpUWTJobGJXVWlPaUpQUVhWMGFDSXNJa1JoZEdFaU9uc2lRMnhwWlc1MFNXUWlPaUpqTmpObE9HSmpNQzA1TjJFM0xUUTVORFF0WVRVeFlpMWpOalEzTldNeFpXSXdNamNpTENKQmRYUm9iM0pwZW1GMGFXOXVWWEpzSWpvaWFIUjBjSE02THk5d2FYQmxiR2x1WlhObmFIVmlaWFZ6TVRRdVlXTjBhVzl1Y3k1bmFYUm9kV0oxYzJWeVkyOXVkR1Z1ZEM1amIyMHZUVTR5Ym05NVJIbEdkbEYwVkdsdlozcDNiakJwVGpCS1ZESllXR2x2Y3pSRmR6TjZSelJrVTNaelJteHJWR0ozZFVndlgyRndhWE12YjJGMWRHZ3lMM1J2YTJWdUluMTkiLCIuY3JlZGVudGlhbHNfcnNhcGFyYW1zIjoiZXlKa0lqb2ljRlV2VFhaRk4weGlWMDlSV0dzME1FOUVjMUpEWWxkSlJ6UlhXalZ0TlVwVFdFSXpWMXBJTVdZMWNHZHhRMGhMVERNM1JHaEdORTEzYURkNk5XcDFUQzlwYTA5UFFXMVZjMGRITkRGNVpFaGhkVUlyTTB0aGFGSjVNakZyYWs5eVJrRndjSE15V21nelZFVnFWRWxXUm1kRlEweFJPWGQ1VlZReVVHOTFlVUpCUWpONk9FcG1aR3hFVjNBeVdVNVdaVWxTZFZneWFHTjFlSFZSVms1YVdHTlhZVTlyYWl0T2RrMHhiRUkxZFVsWFVIWlBibmh6V1c5Q2JtdzVNbEYxY0ZGS09GRXliMmxCUWxCV01WWmtlVlpvTTBOaGNrZHRUREppTTNKelF6UkNWbW81TlVSVGEyWXZNRFZoZUdOelVHcGxWR0ZNYlM5MGIwOTZRbUZqYVc4ME9FYzRZa0V3Y201bE9EY3pZblZ4VERaUFpsZHlXbUpaYVVOaE0yVkNkRkJ0ZVZKTlJFNVVVbkkxYjBOd2N6TktRVzlPZEdaRlpsUlBVM3BzWWpkS1pqVTJOV2hxZWxwTWEyeGtjeTkzZDNGME1qUlJQVDBpTENKa2NDSTZJbVoxYTB4NVJtSnlWazV4T0ROQ1ZEUnVMMUp6WjB3emIwbFpSVEpzWVVsb1YwNXZSMHhpYURGek5sWkZialZqWkVZeVFUQkpjbEpRSzAxU1lXMWhhWEZTTUZKblpFZExObTFRWVRsMVMzcEhjVFZuTkRSbFRXSlNhRzFhVlRaYVkyRlZWVXg2YVhBMU9YSkNiWGRQT0N0TGNGRk5heTlNWW5sSVlYWmFSR1pTUkhWUmMwcDNMekV5VmtaNlFWRlBTVGM0YkUwNFdtZERWV2hFWW1VM1lYQk5OVlpzYkhwcFkyWjJhejBpTENKa2NTSTZJbXdyUVZBME5FbFVRVGRXTUVNNVZrZ3pPV0pwYUV0UVpsRnpPRWszZUM5a1YyeExOV3BqZW05WE9EZzViM1pZUm5aWUswUkhSVmx3YUhFelpVMHdiSFJFVTJsRU0ydDJRbmh4Ym5aRmRUQkZZMVJ0TlRWUk5ESmhUWGRPZDNOTFNVbzNRWGREV1NzM01qbFlkakUxYUhCalUzQnpiV0pIUWxGemFFcHVNVE5wYm01d1ZsVldXSFZ2ZW5SQkswSnZOMFZLZWxOa1lYaEViVVZrUWxkbVduWnZLM1ZJYzJ4NGIxZGFPRDBpTENKbGVIQnZibVZ1ZENJNklrRlJRVUlpTENKcGJuWmxjbk5sVVNJNkltTlFWR2h3UlU1UVJVWjNRVUpYVVV0TlMyUjRXVTlDVTB0SWFVbENTeTlEY1ZCTk5sZEJaMFEzWW05cGIyNXVVaXRDWlZKdFVuVkhha1E1YVVGVVRqQkVjMGQwZGpSQ2NrTldObkJGWmpJM1REUXJZM3A1U2xwWE5ERmhORU4zZDNsUVFsbEJSbUkxUW5Sa01DOXdlRTVyZURGallVWlhTMVkyZVdGRFRIVjVZalpQVkRKR1NrSlZWVWhWTVdzd1dWWlpSVFEwY0ZwRk9DdEJSVzFZUkdWeVVrTlJjVFJ3Ykd0NWN6MGlMQ0p0YjJSMWJIVnpJam9pZEZJellUUjViRzFqYlRjMFdXSlVlVWh0U0c5SGVFNVVaVGQwWjNKWGJVTllXU3RGV1U1UlVIQjZRWFZpTjFkVlEyUXhTR1ptYkZCMWQyTnVNbFF5TjBOV1pUVXdXVmR6WXpsdlUwSTFWMFZLTHpCWk5USllLMEpoUTNZeE5FTjRlWFEzU2poRk1UTnJRMEYyV0RnMlFXSnBTREpGY1hsUmEzQndiR1J6WTI5VGNFSndjR3hVT0dGbWNHTkZPQ3QyTTJkTE0yeEZRVXRxTVZoVFYwc3JUbUZFVG5Ockx5OVZTMU40VWxONU5VNUNTSGcwY1V4amFYSXZiRUpMWjNaMkwzSXJlbmxCTmtFMVN6ZEJRalpXSzJOaVoxYzFTelJCVlRSTVpVaFFXa2x0TlVkblpIRXJhVUpzTm5Gd1VuZEljMEZ0U1hkdFVUa3dValkyVEZRNVdEaGthamg2TkZwak5HOUpZWGhOVVcxMlZsbEhRbTlWYm14eFZrbFlkRWRwWTJ4QlRVUlBNMHA1VFRGTU5pOW5ZazVoUmtJMFVVMUxRazl4UjA0NGFuQTJaM1JXUW1WRk5FWlFXR2xwVm5KU2J6Wm5hM1ozUFQwaUxDSndJam9pT0ZFclZVNDNiMHhxZFVaMmRGaFpSSGQwTm5sV1VtUjFTamRTTDJ4SFVVbzVkVmxpUkU1V1ZGTlZjVUZ5V1dSWmVEVnJXbmxxTWxkcE5VUm5PSFZ1Y0ZJNVNGSmlUbFZ6WkhKSVVFOUJkRlpHV0ZSNGVuQnRWV3hzZFhkRWFDOXlaR0V6VVV0emFXdHRlVmhDU1hOaFpVRmxZWEIyZVVsbE9YVXphazRyTlV0c2JXWkViVlJITlhwblpuQmFlbVkzUjFKYWNtbzVTbmhXT1VnMk5HNXdlVWhoTjJGU2NGQkJjMVZyUFNJc0luRWlPaUozUm1SRVdFVTBXVmxMVm1seFpISXpUa2hVVW5SWlFYcExhVGhyY1dGVllscEhhV3BNUldoUmRrOVNMMUpFUkdORWIyWk1MM2d5YVRNeU5XbDNZMEZ2UVZGU1ZtRjNkVm95VUV0RFNUUjVaRTVLT0doSGNIY3lWMmw2YlhaWGRXUnRlWGN2ZVU5cVduSjNZak1yYjI5NFoyTXhkelJ3Ymt4elZIUTJjMEU1U2s5TlFsSkhPVUZwUmtwUmMwWlpXbmt2WWl0cGMxZGlRMkpaZVhoNlRFeDVMM2RtTDFWU2FWRnlZMk05SW4wPSJ9"
}How to actually run a workflow job using a scale setCompared to normal self-hosted runners, getting a job to run is a bit more complicated. I found that a workflow run lives through multiple stages. As soon as it is triggerd it is available as an
Getting messages from the message queueIn theory you could relay solely on the message queue to get updates about any changes. After receiving and processing a message you can delete it to get the next available message: MESSAGE_ID=2
$ curl -H "Authorization: Bearer $MESSAGE_TOKEN" -H "Content-Type: application/json" "https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/messages/$MESSAGE_ID?sessionId=2e932f60-e9e5-4b08-abd6-63f675d3f014&api-version=6.0-preview" -sS -X DELETEAlternatively you can as well use the query parameter curl -H "Authorization: Bearer $MESSAGE_TOKEN" -H "Content-Type: application/json" "https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/messages?sessionId=2e932f60-e9e5-4b08-abd6-63f675d3f014&api-version=6.0-preview&lastMessageId=3" -sS | jq .
{
"messageId": 4,
"messageType": "RunnerScaleSetJobMessages",
"body": "[{\"messageType\":\"JobAvailable\",\"acquireJobUrl\":\"https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/jobs/37/acquire?api-version=6.0-preview\",\"runnerRequestId\":37,\"repositoryName\":\"potential-sniffle\",\"ownerName\":\"tobias-something-something\",\"workflowRunId\":9221057903,\"jobWorkflowRef\":\"tobias-something-something/potential-sniffle/.github/workflows/blank.yml@refs/heads/main\",\"jobDisplayName\":\"build\",\"eventName\":\"workflow_dispatch\",\"requestLabels\":[\"my-autoscaling-set\"],\"queueTime\":\"2024-05-24T08:31:32.4433333Z\"}]",
"statistics": {
"totalAvailableJobs": 1,
"totalAcquiredJobs": 1,
"totalAssignedJobs": 1,
"totalRunningJobs": 0,
"totalRegisteredRunners": 0,
"totalBusyRunners": 0,
"totalIdleRunners": 0
}
}Deleting a message sessionTo terminate a message session you can send a curl -H "Authorization: Bearer $MESSAGE_TOKEN" -H "Content-Type: application/json" "https://pipelinesghubeus14.actions.githubusercontent.com/MN2noyDyFvQtTiogzwn0iN0JT2XXios4Ew3zG4dSvsFlkTbwuH/_apis/runtime/runnerscalesets/1/sessions/2e932f60-e9e5-4b08-abd6-63f675d3f014?api-version=6.0-preview" -sS -X DELETE |
Beta Was this translation helpful? Give feedback.
-
|
Amazing, thank you! Must have been quite the work to get all of that information! |
Beta Was this translation helpful? Give feedback.
-
|
Thanks @Shegox for your great insights! I downloaded the runner from my enterprise GH instance Settings/Actions/Runners/New Runner linking to As you mentioned above, we can use the
The runner then also seems to be working but is failing to complete my job. I'm trying to run following workflow, which I can run successfully on our enterprise runners. The only error I can find in I was reading that this is a bug related to using ubuntu:latest. |
Beta Was this translation helpful? Give feedback.
-
|
The error sound like a permission problem with your specified work directory. Make sure that small improvement: instead |
Beta Was this translation helpful? Give feedback.
-
|
Thank you @Shegox Worked perfectly with creating |
Beta Was this translation helpful? Give feedback.
Deleting Scale Set
Your DELETE-request is correct. My assumption is that the JWT_TOKEN might have expired in the meantime and you need to request a new one (step 2). For me deleting the scale sets is working with this request:
Runner JIT Config
The Runner JIT config is a quite cool new addition. It allows you to create, for the specific scale set, the
.runner,.credentialsand.credentials_rsaparamsand returns them directly. These can then be used when performing a./run.shof the action runner start script.The neat t…