Skip to content

Commit

Permalink
[release-0.22] Config schema doc improvements (eksctl-io#2346)
Browse files Browse the repository at this point in the history
* Improve docs for NodeGroupSGs

* Add additional AMI options to config docs
  • Loading branch information
michaelbeaumont committed Jun 19, 2020
1 parent 8f72f5b commit 5a2cab7
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 12 deletions.
22 changes: 15 additions & 7 deletions pkg/apis/eksctl.io/v1alpha5/assets/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": [
Expand All @@ -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": {
Expand Down
Loading

0 comments on commit 5a2cab7

Please sign in to comment.