Skip to content

Commit e03f706

Browse files
committed
update clusterapi readme with node group limit info
this change is adding an extra note to the readme to help users understand how the autoscaler works when it is outside the minimum and mamximum limits. it is being added to help inform users and also because the readme is embedded in clusterapi documentation.
1 parent 6b55dc9 commit e03f706

File tree

1 file changed

+7
-0
lines changed
  • cluster-autoscaler/cloudprovider/clusterapi

1 file changed

+7
-0
lines changed

cluster-autoscaler/cloudprovider/clusterapi/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,13 @@ There are two annotations that control how a cluster resource should be scaled:
186186
The autoscaler will monitor any `MachineSet`, `MachineDeployment`, or `MachinePool` containing
187187
both of these annotations.
188188

189+
> Note: The cluster autoscaler does not enforce the node group sizes. If a node group is
190+
> below the minimum number of nodes, or above the maximum number of nodes, the cluster
191+
> autoscaler will not scale that node group up or down. The cluster autoscaler can be configured
192+
> to enforce the minimum node group size by enabling the `--enforce-node-group-min-size` flag.
193+
> Please see [this entry in the Cluster Autoscaler FAQ](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#my-cluster-is-below-minimum--above-maximum-number-of-nodes-but-ca-did-not-fix-that-why)
194+
> for more information.
195+
189196
> Note: `MachinePool` support in cluster-autoscaler requires a provider implementation
190197
> that supports the new "MachinePool Machines" feature. MachinePools in Cluster API are
191198
> considered an [experimental feature](https://cluster-api.sigs.k8s.io/tasks/experimental-features/experimental-features.html#active-experimental-features) and are not enabled by default.

0 commit comments

Comments
 (0)