Update cluster autoscaler addon documentation for newly added flags #1714
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ption Signed-off-by: archups <archupsawant@gmail.com>
kubermatic-bot
added
the
dco-signoff: yes
kubermatic-bot
added
the
size/L
|
/hold |
kubermatic-bot
added
the
do-not-merge/hold
xmudrii
requested changes
Jul 23, 2024
Comment on lines
49
to
83
| To find out how to override embedded add-ons, please check the [Addons document][embedded-addons]. | ||
|
|
||
| If you are facing issue similar to the one described over [here][enforce-node-group-min-size] in the [Cluster Autoscaler FAQ][ca-faq], pass down the param `CLUSTER_AUTOSCALER_ENFORCE_NODE_GROUP_MIN_SIZE` to the cluster autoscaler addon as shown below: | ||
|
|
||
| ```yaml | ||
| apiVersion: kubeone.k8c.io/v1beta2 | ||
| kind: KubeOneCluster | ||
| versions: | ||
| kubernetes: '1.29.4' ## kubernetes version | ||
| cloudProvider: ## This field is sourced automatically if terraform is used for the cluster | ||
| aws: {} | ||
| addons: | ||
| enable: true | ||
| addons: | ||
| - name: cluster-autoscaler | ||
| params: | ||
| CLUSTER_AUTOSCALER_ENFORCE_NODE_GROUP_MIN_SIZE: "true" | ||
| ``` | ||
|
|
||
| If you are facing issue similar to the one described over [here][balance-similar-node-groups] in the [Cluster Autoscaler FAQ][ca-faq], pass down the param `CLUSTER_AUTOSCALER_BALANCE_SIMILAR_NODE_GROUP` to the cluster autoscaler addon as shown below: | ||
|
|
||
| ```yaml | ||
| apiVersion: kubeone.k8c.io/v1beta2 | ||
| kind: KubeOneCluster | ||
| versions: | ||
| kubernetes: '1.29.4' ## kubernetes version | ||
| cloudProvider: ## This field is sourced automatically if terraform is used for the cluster | ||
| aws: {} | ||
| addons: | ||
| enable: true | ||
| addons: | ||
| - name: cluster-autoscaler | ||
| params: | ||
| CLUSTER_AUTOSCALER_BALANCE_SIMILAR_NODE_GROUP: "true" | ||
| ``` |
There was a problem hiding this comment.
Can we put this in the step 1 instead, in an information or a warning block? This step is more about modifying the cluster-autoscaler itself (i.e. YAML manifests), but this is more about additionally configuring the cluster-autoscaler addon.
Comment on lines
251
to
252
| [enforce-node-group-min-size]: 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 | ||
| [balance-similar-node-groups]: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#im-running-cluster-with-nodes-in-multiple-zones-for-ha-purposes-is-that-supported-by-cluster-autoscaler |
There was a problem hiding this comment.
Can you instead use permalinks here?
| To find out how to override embedded add-ons, please check the [Addons document][embedded-addons]. For more information regarding available configuration parameters and options, please check the [Cluster Autoscaler FAQ][ca-faq]. | ||
| To find out how to override embedded add-ons, please check the [Addons document][embedded-addons]. | ||
|
|
||
| If you are facing issue similar to the one described over [here][enforce-node-group-min-size] in the [Cluster Autoscaler FAQ][ca-faq], pass down the param `CLUSTER_AUTOSCALER_ENFORCE_NODE_GROUP_MIN_SIZE` to the cluster autoscaler addon as shown below: |
There was a problem hiding this comment.
Suggested change
| If you are facing issue similar to the one described over [here][enforce-node-group-min-size] in the [Cluster Autoscaler FAQ][ca-faq], pass down the param `CLUSTER_AUTOSCALER_ENFORCE_NODE_GROUP_MIN_SIZE` to the cluster autoscaler addon as shown below: | |
| If you're facing an issue where your [cluster is below the minimum or above the maximum number of nodes, but the cluster-autoscaler is not fixing it][ca-faq], you need to pass down the `CLUSTER_AUTOSCALER_ENFORCE_NODE_GROUP_MIN_SIZE` parameter to the cluster-autoscaler addon as shown below: |
| CLUSTER_AUTOSCALER_ENFORCE_NODE_GROUP_MIN_SIZE: "true" | ||
| ``` | ||
|
|
||
| If you are facing issue similar to the one described over [here][balance-similar-node-groups] in the [Cluster Autoscaler FAQ][ca-faq], pass down the param `CLUSTER_AUTOSCALER_BALANCE_SIMILAR_NODE_GROUP` to the cluster autoscaler addon as shown below: |
There was a problem hiding this comment.
Suggested change
| If you are facing issue similar to the one described over [here][balance-similar-node-groups] in the [Cluster Autoscaler FAQ][ca-faq], pass down the param `CLUSTER_AUTOSCALER_BALANCE_SIMILAR_NODE_GROUP` to the cluster autoscaler addon as shown below: | |
| If you're running a cluster with nodes in the multiple zones for the HA purposes, consider setting the `CLUSTER_AUTOSCALER_BALANCE_SIMILAR_NODE_GROUP` parameter to `true` as shown below. For more information about this parameter, check the [Cluster Autoscaler FAQ][balance-similar-node-groups]. |
There was a problem hiding this comment.
Additionally, to make it easier to follow the document, maybe we should provide just one YAML example with both arguments set, eventually with a comment that you can remove the parameter that you don't need.
| Once it has been deleted, you can check the cluster to ensure that the cluster autoscaler has been deleted using the command `kubectl get pods -n kube-system`. | ||
|
|
||
|
|
||
| ## Customize KKP Autoscaler |
There was a problem hiding this comment.
Same as for the KubeOne document, I'd recommend using permalinks here.
|
|
||
| ## Customize KKP Autoscaler | ||
|
|
||
| You can customize the cluster autoscaler addon in order to override the cluster autoscaler deployment definition to set or pass the required flag(s) by following the instructions provided over [here](https://docs.kubermatic.com/kubermatic/v2.25/architecture/concept/kkp-concepts/addons/#custom-addons), if you are facing any of the below mentioned issues as described in the [cluster autoscaler FAQs](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md): |
There was a problem hiding this comment.
What about something like this:
Suggested change
| You can customize the cluster autoscaler addon in order to override the cluster autoscaler deployment definition to set or pass the required flag(s) by following the instructions provided over [here](https://docs.kubermatic.com/kubermatic/v2.25/architecture/concept/kkp-concepts/addons/#custom-addons), if you are facing any of the below mentioned issues as described in the [cluster autoscaler FAQs](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md): | |
| You can customize the cluster autoscaler addon in order to override the cluster autoscaler deployment definition to set or pass the required flag(s) by following the instructions provided [in the Addons document](https://docs.kubermatic.com/kubermatic/v2.25/architecture/concept/kkp-concepts/addons/#custom-addons). | |
| ### Suggestions and Known Issues | |
| Some of [the know issues in the cluster-autoscaler](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md) can be mitigated by adjusting the cluster-autoscaler deployment to pass additional flags, for example: |
There was a problem hiding this comment.
Also please use ref to access other KKP documents, such as {{< ref "../../architecture/concept/kkp-concepts/addons/#custom-addons" >}} (I didn't test this URL, please make sure to test it and fix it if needed).
kubermatic-bot
added
size/M
Signed-off-by: archups <archupsawant@gmail.com>
archups
force-pushed
the
update-cluster-autoscaler-docs
branch
from
d84de37
to
f30d6da
Compare
|
KubeOne part LGTM, @embik do you want to take care of the KKP part? |
|
LGTM label has been added. Git tree hash: 9fb50e767f1e789ab5df72d591ec070d46b801cf
|
kubermatic-bot
removed
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: embik The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubermatic-bot
added
the
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is related to kubermatic/kubeone#3305 and kubermatic/kubeone#3306 changes for KubeOne.
Also added documentation for the customization of KKP Autoscaler addon.