From a82e020daab6873e6f782a645f9faf76d993c655 Mon Sep 17 00:00:00 2001 From: Yusuke Kuoka Date: Wed, 5 May 2021 14:59:36 +0900 Subject: [PATCH] Add notes for unreleased features (#526) --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index d5cf7836..fc9b5436 100644 --- a/README.md +++ b/README.md @@ -284,6 +284,11 @@ example-runnerdeploy2475ht2qbr mumoshu/actions-runner-controller-ci Running ##### Note on scaling to/from 0 +> This is a documentation about a unreleased version of actions-runner-controller. +> +> It would be great if you could try building the latest controller image following https://github.com/actions-runner-controller/actions-runner-controller#contributing if you are eager to test it early and help +> developers by reporting any bugs :smile: + You can either delete the runner deployment, or update it to have `replicas: 0`, so that there will be 0 runner pods in the cluster. This, in combination with e.g. `cluster-autoscaler`, enables you to save your infrastructure cost when there's no need to run Actions jobs. ```yaml @@ -554,6 +559,11 @@ See ["activity types"](https://docs.github.com/en/actions/reference/events-that- #### Autoscaling to/from 0 +> This is a documentation about a unreleased version of actions-runner-controller. +> +> It would be great if you could try building the latest controller image following https://github.com/actions-runner-controller/actions-runner-controller#contributing if you are eager to test it early and help +> developers by reporting any bugs :smile: + Previously, we've discussed about [how to scale a RunnerDeployment to/from 0](#note-on-scaling-tofrom-0) To automate the process of scaling to/from 0, you can use `HorizontalRunerAutoscaler` with a caveat. @@ -574,6 +584,11 @@ Similarly, Webhook-based autoscaling works regarless of there are active runners #### Scheduled Overrides +> This is a documentation about a unreleased version of actions-runner-controller. +> +> It would be great if you could try building the latest controller image following https://github.com/actions-runner-controller/actions-runner-controller#contributing if you are eager to test it early and help +> developers by reporting any bugs :smile: + `Scheduled Overrides` allows you to configure HorizontalRunnerAutosaler so that its Spec gets updated only during a certain period of time. usually, this feature is used for following scenarios: