You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: charts/cluster-autoscaler/README.md
+34-3Lines changed: 34 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,7 @@ To create a valid configuration, follow instructions for your cloud provider:
75
75
-[Cluster API](#cluster-api)
76
76
-[Exoscale](#exoscale)
77
77
-[Hetzner Cloud](#hetzner-cloud)
78
+
-[Civo](#civo)
78
79
79
80
### Templating the autoDiscovery.clusterName
80
81
@@ -282,6 +283,23 @@ Each autoscaling group requires an additional `instanceType` and `region` key to
282
283
283
284
Read [cluster-autoscaler/cloudprovider/hetzner/README.md](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/hetzner/README.md) for further information on the setup without helm.
284
285
286
+
### Civo
287
+
288
+
The following parameters are required:
289
+
290
+
- `cloudProvider=civo`
291
+
- `autoscalingGroups=...`
292
+
293
+
When installing the helm chart to the namespace `kube-system`, you can set `secretKeyRefNameOverride` to `civo-api-access`.
294
+
Otherwise specify the following parameters:
295
+
296
+
- `civoApiUrl=https://api.civo.com`
297
+
- `civoApiKey=...`
298
+
- `civoClusterID=...`
299
+
- `civoRegion=...`
300
+
301
+
Read [cluster-autoscaler/cloudprovider/civo/README.md](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/civo/README.md) for further information on the setup without helm.
302
+
285
303
## Uninstalling the Chart
286
304
287
305
To uninstall `my-release`:
@@ -340,6 +358,14 @@ extraVolumeMounts:
340
358
readOnly: true
341
359
```
342
360
361
+
### Custom arguments
362
+
363
+
You can use the `customArgs` value to give any argument to cluster autoscaler command.
364
+
365
+
Typical use case is to give an environment variable as an argument which will be interpolated at execution time.
366
+
367
+
This is helpful when you need to inject values from configmap or secret.
368
+
343
369
## Troubleshooting
344
370
345
371
The chart will succeed even if the container arguments are incorrect. A few minutes after starting `kubectl logs -l "app=aws-cluster-autoscaler" --tail=50` should loop through something like
@@ -413,14 +439,19 @@ vpa:
413
439
| azureUseManagedIdentityExtension | bool |`false`| Whether to use Azure's managed identity extension for credentials. If using MSI, ensure subscription ID, resource group, and azure AKS cluster name are set. You can only use one authentication method at a time, either azureUseWorkloadIdentityExtension or azureUseManagedIdentityExtension should be set. |
414
440
| azureUseWorkloadIdentityExtension | bool |`false`| Whether to use Azure's workload identity extension for credentials. See the project here: https://github.com/Azure/azure-workload-identity for more details. You can only use one authentication method at a time, either azureUseWorkloadIdentityExtension or azureUseManagedIdentityExtension should be set. |
415
441
| azureVMType | string |`"vmss"`| Azure VM type. |
442
+
| civoApiKey | string |`""`| API key for the Civo API. Required if `cloudProvider=civo`|
443
+
| civoApiUrl | string |`"https://api.civo.com"`| URL for the Civo API. Required if `cloudProvider=civo`|
444
+
| civoClusterID | string |`""`| Cluster ID for the Civo cluster. Required if `cloudProvider=civo`|
445
+
| civoRegion | string |`""`| Region for the Civo cluster. Required if `cloudProvider=civo`|
| cloudProvider | string |`"aws"`| The cloud provider where the autoscaler runs. Currently only `gce`, `aws`, `azure`, `magnum`and `clusterapi` are supported. `aws` supported for AWS. `gce` for GCE. `azure` for Azure AKS. `magnum` for OpenStack Magnum, `clusterapi` for Cluster API. |
447
+
| cloudProvider | string |`"aws"`| The cloud provider where the autoscaler runs. Currently only `gce`, `aws`, `azure`, `magnum`, `clusterapi`and `civo` are supported. `aws` supported for AWS. `gce` for GCE. `azure` for Azure AKS. `magnum` for OpenStack Magnum, `clusterapi` for Cluster API. `civo` for Civo Cloud. |
418
448
| clusterAPICloudConfigPath | string |`"/etc/kubernetes/mgmt-kubeconfig"`| Path to kubeconfig for connecting to Cluster API Management Cluster, only used if `clusterAPIMode=kubeconfig-kubeconfig or incluster-kubeconfig`|
419
449
| clusterAPIConfigMapsNamespace | string |`""`| Namespace on the workload cluster to store Leader election and status configmaps |
420
450
| clusterAPIKubeconfigSecret | string |`""`| Secret containing kubeconfig for connecting to Cluster API managed workloadcluster Required if `cloudProvider=clusterapi` and `clusterAPIMode=kubeconfig-kubeconfig,kubeconfig-incluster or incluster-kubeconfig`|
421
451
| clusterAPIMode | string |`"incluster-incluster"`| Cluster API mode, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/clusterapi/README.md#connecting-cluster-autoscaler-to-cluster-api-management-and-workload-clusters Syntax: workloadClusterMode-ManagementClusterMode for `kubeconfig-kubeconfig`, `incluster-kubeconfig` and `single-kubeconfig` you always must mount the external kubeconfig using either `extraVolumeSecrets` or `extraMounts` and `extraVolumes` if you dont set `clusterAPIKubeconfigSecret`and thus use an in-cluster config or want to use a non capi generated kubeconfig you must do so for the workload kubeconfig as well |
422
452
| clusterAPIWorkloadKubeconfigPath | string |`"/etc/kubernetes/value"`| Path to kubeconfig for connecting to Cluster API managed workloadcluster, only used if `clusterAPIMode=kubeconfig-kubeconfig or kubeconfig-incluster`|
423
453
| containerSecurityContext | object |`{}`|[Security context for container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)|
454
+
| customArgs | list |`[]`| Additional custom container arguments. Refer to https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-the-parameters-to-ca for the full list of cluster autoscaler parameters and their default values. List of arguments as strings. |
424
455
| deployment.annotations | object |`{}`| Annotations to add to the Deployment object. |
425
456
| dnsPolicy | string |`"ClusterFirst"`| Defaults to `ClusterFirst`. Valid values are: `ClusterFirstWithHostNet`, `ClusterFirst`, `Default` or `None`. If autoscaler does not depend on cluster DNS, recommended to set this to `Default`. |
426
457
| envFromConfigMap | string |`""`| ConfigMap name to use as envFrom. |
| replicaCount | int |`1`| Desired number of pods |
468
499
| resources | object |`{}`| Pod resource requests and limits. |
469
500
| revisionHistoryLimit | int |`10`| The number of revisions to keep. |
470
-
| secretKeyRefNameOverride | string |`""`| Overrides the name of the Secret to use when loading the secretKeyRef for AWSand Azure env variables |
501
+
| secretKeyRefNameOverride | string |`""`| Overrides the name of the Secret to use when loading the secretKeyRef for AWS, Azure and Civo env variables |
471
502
| securityContext | object |`{}`|[Security context for pod](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)|
472
503
| service.annotations | object |`{}`| Annotations to add to service |
473
504
| service.clusterIP | string |`""`| IP address to assign to service |
Copy file name to clipboardExpand all lines: charts/cluster-autoscaler/README.md.gotmpl
+26Lines changed: 26 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,7 @@ To create a valid configuration, follow instructions for your cloud provider:
75
75
- [Cluster API](#cluster-api)
76
76
- [Exoscale](#exoscale)
77
77
- [Hetzner Cloud](#hetzner-cloud)
78
+
- [Civo](#civo)
78
79
79
80
### Templating the autoDiscovery.clusterName
80
81
@@ -282,6 +283,23 @@ Each autoscaling group requires an additional `instanceType` and `region` key to
282
283
283
284
Read [cluster-autoscaler/cloudprovider/hetzner/README.md](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/hetzner/README.md) for further information on the setup without helm.
284
285
286
+
### Civo
287
+
288
+
The following parameters are required:
289
+
290
+
- `cloudProvider=civo`
291
+
- `autoscalingGroups=...`
292
+
293
+
When installing the helm chart to the namespace `kube-system`, you can set `secretKeyRefNameOverride` to `civo-api-access`.
294
+
Otherwise specify the following parameters:
295
+
296
+
- `civoApiUrl=https://api.civo.com`
297
+
- `civoApiKey=...`
298
+
- `civoClusterID=...`
299
+
- `civoRegion=...`
300
+
301
+
Read [cluster-autoscaler/cloudprovider/civo/README.md](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/civo/README.md) for further information on the setup without helm.
302
+
285
303
## Uninstalling the Chart
286
304
287
305
To uninstall `my-release`:
@@ -340,6 +358,14 @@ extraVolumeMounts:
340
358
readOnly: true
341
359
```
342
360
361
+
### Custom arguments
362
+
363
+
You can use the `customArgs` value to give any argument to cluster autoscaler command.
364
+
365
+
Typical use case is to give an environment variable as an argument which will be interpolated at execution time.
366
+
367
+
This is helpful when you need to inject values from configmap or secret.
368
+
343
369
## Troubleshooting
344
370
345
371
The chart will succeed even if the container arguments are incorrect. A few minutes after starting `kubectl logs -l "app=aws-cluster-autoscaler" --tail=50` should loop through something like
Copy file name to clipboardExpand all lines: charts/cluster-autoscaler/values.yaml
+28-3Lines changed: 28 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -110,13 +110,30 @@ azureVMType: "vmss"
110
110
# azureEnableForceDelete -- Whether to force delete VMs or VMSS instances when scaling down.
111
111
azureEnableForceDelete: false
112
112
113
+
# civoApiUrl -- URL for the Civo API.
114
+
# Required if `cloudProvider=civo`
115
+
civoApiUrl: "https://api.civo.com"
116
+
117
+
# civoApiKey -- API key for the Civo API.
118
+
# Required if `cloudProvider=civo`
119
+
civoApiKey: ""
120
+
121
+
# civoClusterID -- Cluster ID for the Civo cluster.
122
+
# Required if `cloudProvider=civo`
123
+
civoClusterID: ""
124
+
125
+
# civoRegion -- Region for the Civo cluster.
126
+
# Required if `cloudProvider=civo`
127
+
civoRegion: ""
128
+
113
129
# cloudConfigPath -- Configuration file for cloud provider.
114
130
cloudConfigPath: ""
115
131
116
132
# cloudProvider -- The cloud provider where the autoscaler runs.
117
-
# Currently only `gce`, `aws`, `azure`, `magnum`and `clusterapi` are supported.
133
+
# Currently only `gce`, `aws`, `azure`, `magnum`, `clusterapi` and `civo` are supported.
118
134
# `aws` supported for AWS. `gce` for GCE. `azure` for Azure AKS.
119
135
# `magnum` for OpenStack Magnum, `clusterapi` for Cluster API.
136
+
# `civo` for Civo Cloud.
120
137
cloudProvider: aws
121
138
122
139
# clusterAPICloudConfigPath -- Path to kubeconfig for connecting to Cluster API Management Cluster, only used if `clusterAPIMode=kubeconfig-kubeconfig or incluster-kubeconfig`
# Refer to https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-the-parameters-to-ca for the full list of cluster autoscaler
## Optionally specify an array of imagePullSecrets.
@@ -438,5 +463,5 @@ vpa:
438
463
# vpa.containerPolicy -- [ContainerResourcePolicy](https://github.com/kubernetes/autoscaler/blob/vertical-pod-autoscaler/v0.13.0/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go#L159). The containerName is always et to the deployment's container name. This value is required if VPA is enabled.
439
464
containerPolicy: {}
440
465
441
-
# secretKeyRefNameOverride -- Overrides the name of the Secret to use when loading the secretKeyRef for AWSand Azure env variables
466
+
# secretKeyRefNameOverride -- Overrides the name of the Secret to use when loading the secretKeyRef for AWS, Azure and Civo env variables
0 commit comments