Skip to content

Commit 219c745

Browse files
authored
docs: Cluster Autoscaler is deployed on the management cluster (#608)
**What problem does this PR solve?**: **Which issue(s) this PR fixes**: Fixes # **How Has This Been Tested?**: <!-- Please describe the tests that you ran to verify your changes. Provide output from the tests and any manual steps needed to replicate the tests. --> **Special notes for your reviewer**: <!-- Use this to provide any additional information to the reviewers. This may include: - Best way to review the PR. - Where the author wants the most review attention on. - etc. -->
1 parent 1e3f7ce commit 219c745

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/content/addons/cluster-autoscaler.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,15 @@ title = "Cluster Autoscaler"
33
icon = "fa-solid fa-up-right-and-down-left-from-center"
44
+++
55

6-
By leveraging CAPI cluster lifecycle hooks, this handler deploys [Cluster Autoscaler] on the new cluster at the
7-
`AfterControlPlaneInitialized` phase.
6+
By leveraging CAPI cluster lifecycle hooks, this handler deploys [Cluster Autoscaler] on the management cluster
7+
for every Cluster at the `AfterControlPlaneInitialized` phase.Unlike other addons, the Cluster Autoscaler
8+
is deployed on the management cluster because it also interacts with the CAPI resources to scale the number of Machines.
9+
The Cluster Autoscaler Pod will not start on the management cluster until the CAPI resources are [pivoted][Pivot]
10+
to that management cluster.
11+
12+
> Note the Cluster Autoscale controller needs to be running for any scaling operations to occur,
13+
> just updating the min and max size annotations in the Cluster object will not be enough.
14+
> You can however manually change the number of replicas by modifying the MachineDeployment object directly.
815
916
Deployment of Cluster Autoscaler is opt-in via the [provider-specific cluster configuration]({{< ref ".." >}}).
1017

@@ -38,10 +45,11 @@ spec:
3845
cluster.x-k8s.io/cluster-api-autoscaler-node-group-max-size: "3"
3946
cluster.x-k8s.io/cluster-api-autoscaler-node-group-min-size: "1"
4047
name: md-0
41-
# Remove the replicas field, otherwise the topology controller will revert back the autoscaler's changes
48+
# Do not set the replicas field, otherwise the topology controller will revert back the autoscaler's changes
4249
```
4350

4451
To deploy the addon via `ClusterResourceSet` replace the value of `strategy` with `ClusterResourceSet`.
4552

4653
[Cluster Autoscaler]: https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/cloudprovider/clusterapi
4754
[Cluster API Add-on Provider for Helm]: https://github.com/kubernetes-sigs/cluster-api-addon-provider-helm
55+
[Pivot]: https://main.cluster-api.sigs.k8s.io/clusterctl/commands/move#pivot

0 commit comments

Comments
 (0)