Feat: Instruct users to setup prerequisites before cluster autoscaler…

… addon. (#50) * fix- update readme for CA prerequisites and node group tags * fix- update complete's example ca creation instruction * doc: updated CA readme and default config value * doc: updated CA readme and default config value * feat: updated NTH values according to best practice * feat: updated NTH values according to best practice --------- Co-authored-by: Anmol Nagpal <[email protected]>
clouddrove · May 27, 2024 · c54228f · c54228f
1 parent 8ba4fa1
commit c54228f
Show file tree

Hide file tree

Showing 4 changed files with 427 additions and 48 deletions.
diff --git a/addons/cluster-autoscaler/README.md b/addons/cluster-autoscaler/README.md
@@ -4,6 +4,10 @@ Cluster Autoscaler is a tool that automatically adjusts the size of the Kubernet
 - there are pods that failed to run in the cluster due to insufficient resources.
 - there are nodes in the cluster that have been underutilized for an extended period of time and their pods can be placed on other existing nodes.
 
+## Prerequisites
+Auto-discovery finds ASGs tags as below and automatically manages them based on the min and max size specified in the ASG.
+- Tag the ASGs with keys to match .Values.autoDiscovery.tags, by default: `k8s.io/cluster-autoscaler/enabled` and `k8s.io/cluster-autoscaler/<YOUR CLUSTER NAME>` with value `true` and `1`
+
 ## Installation
 Below terraform script shows how to use Cluster Autoscaler Terraform Addon, A complete example is also given [here](https://github.com/clouddrove/terraform-helm-eks-addons/blob/master/_examples/complete/main.tf).
 ```hcl