actions/actions-runner-controller
1
0
Fork 0
mirror of https://github.com/actions/actions-runner-controller.git synced 2025-12-17 15:44:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: styling fixes (#359)

Browse Source 
* docs: styling fixes

* docs: grammer fixes
This commit is contained in:
callum-tait-pbx
2021-03-01 00:44:35 +00:00
committed by GitHub
parent 584590e97c
commit 9c7372a8e0
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -45,8 +45,8 @@ Install the custom resource and actions-runner-controller with `kubectl` or `hel
`kubectl`: `kubectl`:
```shell ```shell
# REPLACE "v0.16.1" with the latest release # REPLACE "v0.17.0" with the version you wish to deploy
kubectl apply -f https://github.com/summerwind/actions-runner-controller/releases/download/v0.16.1/actions-runner-controller.yaml kubectl apply -f https://github.com/summerwind/actions-runner-controller/releases/download/v0.17.0/actions-runner-controller.yaml
``` ```
`helm`: `helm`:
@@ -297,7 +297,7 @@ With this scaling metric we are required to define a list of repositories within
The scale out performance is controlled via the manager containers startup `--sync-period` argument. The default value is set to 10 minutes to prevent default deployments rate limiting themselves from the GitHub API. The scale out performance is controlled via the manager containers startup `--sync-period` argument. The default value is set to 10 minutes to prevent default deployments rate limiting themselves from the GitHub API.
**Kustomize Config :** The period can be customised in the `config/default/manager_auth_proxy_patch.yaml` patch **Kustomize Config :** The period can be customised in the `config/default/manager_auth_proxy_patch.yaml` patch<br />
**Helm Config :** `syncPeriod` **Helm Config :** `syncPeriod`
**Benefits of this metric** **Benefits of this metric**
@@ -340,7 +340,7 @@ spec:
``` ```
Additionally, the `HorizontalRunnerAutoscaler` also has an anti-flapping option that prevents periodic loop of scaling up and down. Additionally, the `HorizontalRunnerAutoscaler` also has an anti-flapping option that prevents periodic loop of scaling up and down.
By default, it doesn't scale down until the grace period of 10 minutes passes after a scale up. The grace period can be configured however by adding the setting `scaleDownDelaySecondsAfterScaleUp` in the `HorizontalRunnerAutoscaler` `spec`: By default, it doesn't scale down until the grace period of 10 minutes passes after a scale up. The grace period can be configured however by adding the setting `scaleDownDelaySecondsAfterScaleOut` in the `HorizontalRunnerAutoscaler` `spec`:
```yaml ```yaml
spec: spec:
@@ -349,9 +349,9 @@ spec:
**PercentageRunnersBusy** **PercentageRunnersBusy**
This metric the HorizontalRunnerAutoscaler will pole GitHub based on the configuration sync period for the number of busy runners which live in the RunnerDeployment namespace and scale based on the settings The `HorizontalRunnerAutoscaler` will pole GitHub based on the configuration sync period for the number of busy runners which live in the RunnerDeployment's namespace and scale based on the settings
**Kustomize Config :** The period can be customised in the `config/default/manager_auth_proxy_patch.yaml` patch **Kustomize Config :** The period can be customised in the `config/default/manager_auth_proxy_patch.yaml` patch<br />
**Helm Config :** `syncPeriod` **Helm Config :** `syncPeriod`
**Benefits of this metric** **Benefits of this metric**