Add missing documentation (#196)

* release 0.9.0 Signed-off-by: Eytan Avisror <[email protected]> * add missing docs Signed-off-by: Eytan Avisror <[email protected]>
keikoproj · Nov 14, 2020 · 13cd2e8 · 13cd2e8
1 parent 964bbf1
commit 13cd2e8
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/docs/EKS.md b/docs/EKS.md
@@ -505,3 +505,11 @@ Any update to the configmap will trigger a reconcile for instancegroups which ar
 This is enforced via the `status.configMD5` field, which has an MD5 hash of the last seen configmap data, this guarantees consistency with the values defined in the configmap.
 
 This also makes upgrades easier across a managed cluster, an operator can now simply modify the default value for `image` and trigger an upgrade across all instance groups.
+
+## Annotations
+
+| Annotation Key | Annotation Value | Purpose |
+|----------------|------------------|---------|
+|instancemgr.keikoproj.io/cluster-autoscaler-enabled|"true"|setting this annotation to true will add the relevant cluster-autoscaler EC2 tags according to cluster name, taints, and labels|
+|instancemgr.keikoproj.io/os-family|either "windows", "bottlerocket", or "amazonlinux2" (default)|this is required if you are running a windows or bottlerocket based AMI, by default the controller will try to bootstrap an amazonlinux2 AMI|
+|instancemgr.keikoproj.io/default-labels|comma-seprarated key-value string e.g. "label1=value1,label2=value2"|allows overriding the default node labels added by the controller, by default the role label is added depending on the cluster version|
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -53,6 +53,15 @@ iam:GetInstanceProfile
 iam:PassRole
 ec2:DescribeSecurityGroups
 ec2:DescribeSubnets
+ec2:DescribeInstanceTypeOfferings
+ec2:DescribeInstanceTypes
+ec2:DescribeLaunchTemplates
+ec2:DescribeLaunchTemplateVersions
+ec2:CreateLaunchTemplate
+ec2:CreateLaunchTemplateVersion
+ec2:ModifyLaunchTemplate
+ec2:DeleteLaunchTemplate
+ec2:DeleteLaunchTemplateVersions
 autoscaling:CreateOrUpdateTags
 autoscaling:DeleteTags
 autoscaling:SuspendProcesses

diff --git a/docs/README.md b/docs/README.md
@@ -2,4 +2,8 @@
 
 - [Installation](https://github.com/keikoproj/instance-manager/blob/master/docs/INSTALL.md)
 - [FAQ](https://github.com/keikoproj/instance-manager/blob/master/docs/FAQ.md)
-- [EKS Provisioner API Reference](https://github.com/keikoproj/instance-manager/blob/master/docs/EKS.md)
+
+## EKS Provisioner
+
+- [API Reference](https://github.com/keikoproj/instance-manager/blob/master/docs/EKS.md#api-reference)
+- [Annotations](https://github.com/keikoproj/instance-manager/blob/master/docs/EKS.md#annotations)