84 lines
19 KiB
Markdown
84 lines
19 KiB
Markdown
## Docs
|
|
|
|
All additional docs are kept in the `docs/` folder, this README is solely for documenting the values.yaml keys and values
|
|
|
|
## Values
|
|
|
|
_The values are documented as of HEAD_
|
|
|
|
_Default values are the defaults set in the charts values.yaml, some properties have default configurations in the code for when the property is omitted or invalid_
|
|
|
|
| Key | Description | Default |
|
|
|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
|
|
| `labels` | Set labels to apply to all resources in the chart | |
|
|
| `replicaCount` | Set the number of controller pods | 1 |
|
|
| `syncPeriod` | Set the period in which the controler reconciles the desired runners count | 10m |
|
|
| `githubAPICacheDuration` | Set the cache period for API calls | |
|
|
| `githubEnterpriseServerURL` | Set the URL for a self-hosted GitHub Enterprise Server | |
|
|
| `logLevel` | Set the log level of the controller container | |
|
|
| `authSecret.create` | Deploy the controller auth secret | false |
|
|
| `authSecret.name` | Set the name of the auth secret | controller-manager |
|
|
| `authSecret.github_app_id` | The ID of your GitHub App. **This can't be set at the same time as `authSecret.github_token`** | |
|
|
| `authSecret.github_app_installation_id` | The ID of your GitHub App installation. **This can't be set at the same time as `authSecret.github_token`** | |
|
|
| `authSecret.github_app_private_key` | The multiline string of your GitHub App's private key. **This can't be set at the same time as `authSecret.github_token`** | |
|
|
| `authSecret.github_token` | Your chosen GitHub PAT token. **This can't be set at the same time as the `authSecret.github_app_*`** | |
|
|
| `image.repository` | The "repository/image" of the controller container | summerwind/actions-runner-controller |
|
|
| `image.tag` | The tag of the controller container | |
|
|
| `image.dindSidecarRepositoryAndTag` | The "repository/image" of the dind sidecar container | docker:dind |
|
|
| `image.pullPolicy` | The pull policy of the controller image | IfNotPresent |
|
|
| `metrics.serviceMonitor` | Deploy serviceMonitor kind for for use with prometheus-operator CRDs | false |
|
|
| `metrics.port` | Set port of metrics service | 8443 |
|
|
| `metrics.proxy.enabled` | Deploy kube-rbac-proxy container in controller pod | true |
|
|
| `metrics.proxy.image.repository` | The "repository/image" of the kube-proxy container | quay.io/brancz/kube-rbac-proxy |
|
|
| `metrics.proxy.image.tag` | The tag of the kube-proxy image to use when pulling the container | v0.10.0 |
|
|
| `imagePullSecrets` | Specifies the secret to be used when pulling the controller pod containers | |
|
|
| `fullNameOverride` | Override the full resource names | |
|
|
| `nameOverride` | Override the resource name prefix | |
|
|
| `serviceAccont.annotations` | Set annotations to the service account | |
|
|
| `serviceAccount.create` | Deploy the controller pod under a service account | true |
|
|
| `podAnnotations` | Set annotations for the controller pod | |
|
|
| `podLabels` | Set labels for the controller pod | |
|
|
| `serviceAccount.name` | Set the name of the service account | |
|
|
| `securityContext` | Set the security context for each container in the controller pod | |
|
|
| `podSecurityContext` | Set the security context to controller pod | |
|
|
| `service.port` | Set controller service type | |
|
|
| `service.type` | Set controller service ports | |
|
|
| `topologySpreadConstraints` | Set the controller pod topologySpreadConstraints | |
|
|
| `nodeSelector` | Set the controller pod nodeSelector | |
|
|
| `resources` | Set the controller pod resources | |
|
|
| `affinity` | Set the controller pod affinity rules | |
|
|
| `tolerations` | Set the controller pod tolerations | |
|
|
| `env` | Set environment variables for the controller container | |
|
|
| `priorityClassName` | Set the controller pod priorityClassName | |
|
|
| `scope.watchNamespace` | Tells the controller which namespace to watch if `scope.singleNamespace` is true | |
|
|
| `scope.singleNamespace` | Limit the controller to watch a single namespace | false |
|
|
| `githubWebhookServer.logLevel` | Set the log level of the githubWebhookServer container | |
|
|
| `githubWebhookServer.replicaCount` | Set the number of webhook server pods | 1 |
|
|
| `githubWebhookServer.syncPeriod` | Set the period in which the controller reconciles the resources | 10m |
|
|
| `githubWebhookServer.enabled` | Deploy the webhook server pod | false |
|
|
| `githubWebhookServer.secret.create` | Deploy the webhook hook secret | false |
|
|
| `githubWebhookServer.secret.name` | Set the name of the webhook hook secret | github-webhook-server |
|
|
| `githubWebhookServer.secret.github_webhook_secret_token` | Set the webhook secret token value | |
|
|
| `githubWebhookServer.imagePullSecrets` | Specifies the secret to be used when pulling the githubWebhookServer pod containers | |
|
|
| `githubWebhookServer.nameOveride` | Override the resource name prefix | |
|
|
| `githubWebhookServer.fullNameOveride` | Override the full resource names | |
|
|
| `githubWebhookServer.serviceAccount.create` | Deploy the githubWebhookServer under a service account | true |
|
|
| `githubWebhookServer.serviceAccount.annotations` | Set annotations for the service account | |
|
|
| `githubWebhookServer.serviceAccount.name` | Set the service account name | |
|
|
| `githubWebhookServer.podAnnotations` | Set annotations for the githubWebhookServer pod | |
|
|
| `githubWebhookServer.podLabels` | Set labels for the githubWebhookServer pod | |
|
|
| `githubWebhookServer.podSecurityContext` | Set the security context to githubWebhookServer pod | |
|
|
| `githubWebhookServer.securityContext` | Set the security context for each container in the githubWebhookServer pod | |
|
|
| `githubWebhookServer.resources` | Set the githubWebhookServer pod resources | |
|
|
| `githubWebhookServer.topologySpreadConstraints` | Set the githubWebhookServer pod topologySpreadConstraints | |
|
|
| `githubWebhookServer.nodeSelector` | Set the githubWebhookServer pod nodeSelector | |
|
|
| `githubWebhookServer.tolerations` | Set the githubWebhookServer pod tolerations | |
|
|
| `githubWebhookServer.affinity` | Set the githubWebhookServer pod affinity rules | |
|
|
| `githubWebhookServer.priorityClassName` | Set the githubWebhookServer pod priorityClassName | |
|
|
| `githubWebhookServer.service.type` | Set githubWebhookServer service type | |
|
|
| `githubWebhookServer.service.ports` | Set githubWebhookServer service ports | `[{"port":80, "targetPort:"http", "protocol":"TCP", "name":"http"}]` |
|
|
| `githubWebhookServer.ingress.enabled` | Deploy an ingress kind for the githubWebhookServer | false |
|
|
| `githubWebhookServer.ingress.annotations` | Set annotations for the ingress kind | |
|
|
| `githubWebhookServer.ingress.hosts` | Set hosts configuration for ingress | `[{"host": "chart-example.local", "paths": []}]` |
|
|
| `githubWebhookServer.ingress.tls` | Set tls configuration for ingress | |
|