[release-0.22] Config schema doc improvements (eksctl-io#2346)

* Improve docs for NodeGroupSGs * Add additional AMI options to config docs
michaelbeaumont · Jun 19, 2020 · 5a2cab7 · 5a2cab7
1 parent 8f72f5b
commit 5a2cab7
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 12 deletions.
diff --git a/pkg/apis/eksctl.io/v1alpha5/assets/schema.json b/pkg/apis/eksctl.io/v1alpha5/assets/schema.json
@@ -675,8 +675,8 @@
       "properties": {
         "ami": {
           "type": "string",
-          "description": "Specify [custom AMIs](usage/custom-ami-support/)",
-          "x-intellij-html-description": "Specify <a href=\"usage/custom-ami-support/\">custom AMIs</a>",
+          "description": "Specify [custom AMIs](usage/custom-ami-support/), \"auto-ssm\", \"auto\", or \"static\"",
+          "x-intellij-html-description": "Specify <a href=\"usage/custom-ami-support/\">custom AMIs</a>, &quot;auto-ssm&quot;, &quot;auto&quot;, or &quot;static&quot;",
           "default": ""
         },
         "amiFamily": {
@@ -1047,13 +1047,21 @@
             "type": "string",
             "default": ""
           },
-          "type": "array"
+          "type": "array",
+          "description": "attaches additional security groups to the nodegroup",
+          "x-intellij-html-description": "attaches additional security groups to the nodegroup"
         },
         "withLocal": {
-          "type": "boolean"
+          "type": "boolean",
+          "description": "attach a security group local to this nodegroup",
+          "x-intellij-html-description": "attach a security group local to this nodegroup",
+          "default": "true"
         },
         "withShared": {
-          "type": "boolean"
+          "type": "boolean",
+          "description": "attach the security group shared among all nodegroups in the cluster",
+          "x-intellij-html-description": "attach the security group shared among all nodegroups in the cluster",
+          "default": "true"
         }
       },
       "preferredOrder": [
@@ -1062,8 +1070,8 @@
         "withLocal"
       ],
       "additionalProperties": false,
-      "description": "holds all SG attributes of a NodeGroup",
-      "x-intellij-html-description": "holds all SG attributes of a NodeGroup"
+      "description": "controls security groups for this nodegroup",
+      "x-intellij-html-description": "controls security groups for this nodegroup"
     },
     "NodeGroupSSH": {
       "properties": {