actions/actions-runner-controller
1
0
Fork 0
mirror of https://github.com/actions/actions-runner-controller.git synced 2025-12-28 12:37:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: Organizational RunnerDeployment Autoscaling

Browse Source 
Enhances #57 to add support for organizational runners.

As GitHub Actions does not have an appropriate API for this, this is the spec you need:

```
apiVersion: actions.summerwind.dev/v1alpha1
kind: RunnerDeployment
metadata:
  name: myrunners
spec:
  minReplicas: 1
  maxReplicas: 3
  autoscaling:
    metrics:
    - type: TotalNumberOfQueuedAndProgressingWorkflowRuns
      repositories:
      # Assumes that you have `github.com/myorg/myrepo1` repo
      - myrepo1
      - myrepo2
  template:
    spec:
      organization: myorg
```

It works by collecting "in_progress" and "queued" workflow runs for the repositories `myrepo1` and `myrepo2` to autoscale the number of replicas, assuming you have this organizational runner deployment only for those two repositories.

For example, if `myrepo1` had 1 `in_progress` and 2 `queued` workflow runs, and `myrepo2` had 4 `in_progress` and 8 `queued` workflow runs at the time of running the reconcilation loop on the runner deployment, it will scale replicas to 1 + 2 + 4 + 8 = 15.

Perhaps we might be better add a kind of "ratio" setting so that you can configure the controller to create e.g. 2x runners than demanded. But that's another story.

Ref #10
This commit is contained in:
Yusuke Kuoka
2020-07-03 09:05:46 +09:00
parent f1556ff060
commit eca6917c6a
6 changed files with 321 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
config/crd/bases/actions.summerwind.dev_runnerdeployments.yaml
View File

@@ -46,6 +46,27 @@ spec:
spec:
description: RunnerReplicaSetSpec defines the desired state of RunnerDeployment
properties:
autoscaling:
description: Autoscaling is set various configuration options for autoscaling
this runner deployment.
properties:
metrics:
items:
properties:
repositoryNames:
description: RepositoryNames is the list of repository names
to be used for calculating the metric. For example, a repository
name is the REPO part of `github.com/USER/REPO`.
items:
type: string
type: array
type:
description: Type is the type of metric to be used for autoscaling.
The only supported Type is TotalNumberOfQueuedAndProgressingWorkflowRuns
type: string
type: object
type: array
type: object
maxReplicas:
description: MinReplicas is the maximum number of replicas the deployment
is allowed to scale