From 46291c18235d2eaac5e0003377a2b7870c75cdc4 Mon Sep 17 00:00:00 2001 From: toast-gear Date: Thu, 28 Apr 2022 16:04:16 +0100 Subject: [PATCH] docs: highlight the new scale down delay flag --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9bcaf81f..4af3f47a 100644 --- a/README.md +++ b/README.md @@ -489,9 +489,14 @@ A `RunnerDeployment` or `RunnerSet` can scale the number of runners between `min #### Anti-Flapping Configuration -For both pull driven or webhook driven scaling an anti-flapping implementation is included, by default a runner won't be scaled down within 10 minutes of it having been scaled up. This delay is configurable by including the attribute `scaleDownDelaySecondsAfterScaleOut:` in a `HorizontalRunnerAutoscaler` kind's `spec:`. +For both pull driven or webhook driven scaling an anti-flapping implementation is included, by default a runner won't be scaled down within 10 minutes of it having been scaled up. -This configuration has the final say on if a runner can be scaled down or not regardless of the chosen scaling method. Depending on your requirements, you may want to consider adjusting this by setting the `scaleDownDelaySecondsAfterScaleOut:` attribute. +This anti-flap configuration also has the final say on if a runner can be scaled down or not regardless of the chosen scaling method. + +This delay is configurable via 2 methods: + +1. By setting a new default via the controller's `--default-scale-down-delay` flag +2. By setting by setting the attribute `scaleDownDelaySecondsAfterScaleOut:` in a `HorizontalRunnerAutoscaler` kind's `spec:`. Below is a complete basic example of one of the pull driven scaling metrics.