Compare commits
45
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c974e98471 | ||
|
|
913a6c443b | ||
|
|
aeda0a5af4 | ||
|
|
c841c96f1c | ||
|
|
256f252d31 | ||
|
|
145b7e382f | ||
|
|
0015641f99 | ||
|
|
1208e1216e | ||
|
|
ebe67dba45 | ||
|
|
5cb859334b | ||
|
|
3fe477d93e | ||
|
|
f3ab19d2b8 | ||
|
|
40342b1e2a | ||
|
|
d9d8d097da | ||
|
|
e346584c2d | ||
|
|
be0376b5b5 | ||
|
|
7e0eae99a6 | ||
|
|
01adae723f | ||
|
|
e37307f46f | ||
|
|
23bfd4848d | ||
|
|
a2a8af97b6 | ||
|
|
60ce378d14 | ||
|
|
dde6b4631c | ||
|
|
fe39658434 | ||
|
|
cec89c5b7b | ||
|
|
7442885c99 | ||
|
|
6d1c317b90 | ||
|
|
45800be002 | ||
|
|
16a9c915cb | ||
|
|
c2f0a53402 | ||
|
|
5f370484a7 | ||
|
|
8104f571eb | ||
|
|
4cc97e220a | ||
|
|
8155f87a58 | ||
|
|
83fb2e2837 | ||
|
|
1f22d2441c | ||
|
|
e9e5ca3282 | ||
|
|
51aa04a4b2 | ||
|
|
39ffa2e560 | ||
|
|
b1dcbc44e6 | ||
|
|
287d3410da | ||
|
|
c549549283 | ||
|
|
a2aa9f9ea9 | ||
|
|
dd4c9f2481 | ||
|
|
8b43e9e5c9 |
@@ -1,6 +1,6 @@
|
|||||||
# GitHub Actions Runner Scale Set Client (Public Preview)
|
# GitHub Actions Runner Scale Set Client (Private Preview)
|
||||||
|
|
||||||
> Status: **Public Preview** – While the API is stable, interfaces and examples in this repository may change.
|
> Status: **Private Preview** – While the API is stable, interfaces and examples in this repository may change.
|
||||||
|
|
||||||
This repository provides a standalone Go client for the GitHub Actions **Runner Scale Set** APIs. It is extracted from the `actions-runner-controller` project so that platform teams, integrators, and infrastructure providers can build **their own custom autoscaling solutions** for GitHub Actions runners.
|
This repository provides a standalone Go client for the GitHub Actions **Runner Scale Set** APIs. It is extracted from the `actions-runner-controller` project so that platform teams, integrators, and infrastructure providers can build **their own custom autoscaling solutions** for GitHub Actions runners.
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ You do *not* need to adopt the full controller (and Kubernetes) to take advantag
|
|||||||
|
|
||||||
A runner scale set is a group of self-hosted runners that autoscales based on workflow demand. Here's how it works:
|
A runner scale set is a group of self-hosted runners that autoscales based on workflow demand. Here's how it works:
|
||||||
|
|
||||||
1. **Registration**: You create a scale set with a name, which also serves as the label workflows use to target it (e.g., `runs-on: my-scale-set`). Multiple labels can be assigned per scale set. Like regular self-hosted runners, scale sets can be registered at the repository, organization, or enterprise level.
|
1. **Registration**: You create a scale set with a name, which also serves as the label workflows use to target it (e.g., `runs-on: my-scale-set`). Like regular self-hosted runners, scale sets can be registered at the repository, organization, or enterprise level.
|
||||||
2. **Polling**: Your scale set client continuously polls the API, reporting its maximum capacity (how many runners it can produce).
|
2. **Polling**: Your scale set client continuously polls the API, reporting its maximum capacity (how many runners it can produce).
|
||||||
3. **Job matching**: GitHub matches jobs to your scale set based on the label and runner group policies, just like regular self-hosted runners.
|
3. **Job matching**: GitHub matches jobs to your scale set based on the label and runner group policies, just like regular self-hosted runners.
|
||||||
4. **Scaling signal**: The API responds with how many runners your scale set needs online (`statistics.TotalAssignedJobs`).
|
4. **Scaling signal**: The API responds with how many runners your scale set needs online (`statistics.TotalAssignedJobs`).
|
||||||
|
|||||||
Reference in New Issue
Block a user