update wording

eksctl-io · Feb 12, 2021 · dc07e25 · dc07e25
1 parent ce864ff
commit dc07e25
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 17 deletions.
diff --git a/pkg/apis/eksctl.io/v1alpha5/assets/schema.json b/pkg/apis/eksctl.io/v1alpha5/assets/schema.json
@@ -1574,8 +1574,8 @@
       "properties": {
         "allow": {
           "type": "boolean",
-          "description": "If Allow is true the SSH configuration provided is used, otherwise it is ignored. Only one of PublicKeyPath, PublicKey and PublicKeyName can be configured",
-          "x-intellij-html-description": "If Allow is true the SSH configuration provided is used, otherwise it is ignored. Only one of PublicKeyPath, PublicKey and PublicKeyName can be configured"
+          "description": "If Allow is true the SSH configuration provided is used, otherwise it is ignored. Only one of PublicKeyPath, PublicKey or PublicKeyName can be configured",
+          "x-intellij-html-description": "If Allow is true the SSH configuration provided is used, otherwise it is ignored. Only one of PublicKeyPath, PublicKey or PublicKeyName can be configured"
         },
         "enableSsm": {
           "type": "boolean",
@@ -1584,18 +1584,19 @@
         },
         "publicKey": {
           "type": "string",
-          "description": "Public key to be added to the nodes SSH keychain. If Allow is false this value is ignored.",
-          "x-intellij-html-description": "Public key to be added to the nodes SSH keychain. If Allow is false this value is ignored."
+          "description": "Public key to be added to the nodes SSH keychain.",
+          "x-intellij-html-description": "Public key to be added to the nodes SSH keychain."
         },
         "publicKeyName": {
           "type": "string",
-          "description": "Public key name in EC2 to be added to the nodes SSH keychain. If Allow is false this value is ignored.",
-          "x-intellij-html-description": "Public key name in EC2 to be added to the nodes SSH keychain. If Allow is false this value is ignored."
+          "description": "Public key name in EC2 to be added to the nodes SSH keychain.",
+          "x-intellij-html-description": "Public key name in EC2 to be added to the nodes SSH keychain."
         },
         "publicKeyPath": {
           "type": "string",
-          "description": "The path to the SSH public key to be added to the nodes SSH keychain. If Allow is true this value defaults to \"~/.ssh/id_rsa.pub\", otherwise the value is ignored.",
-          "x-intellij-html-description": "The path to the SSH public key to be added to the nodes SSH keychain. If Allow is true this value defaults to &quot;~/.ssh/id_rsa.pub&quot;, otherwise the value is ignored."
+          "description": "The path to the SSH public key to allow access to the nodes",
+          "x-intellij-html-description": "The path to the SSH public key to allow access to the nodes",
+          "default": "~/.ssh/id_rsa.pub"
         },
         "sourceSecurityGroupIds": {
           "items": {

diff --git a/pkg/apis/eksctl.io/v1alpha5/schema.go b/pkg/apis/eksctl.io/v1alpha5/schema.go
diff --git a/pkg/apis/eksctl.io/v1alpha5/types.go b/pkg/apis/eksctl.io/v1alpha5/types.go
@@ -1059,15 +1059,14 @@ type (
 	// NodeGroupSSH holds all the ssh access configuration to a NodeGroup
 	NodeGroupSSH struct {
 		// +optional If Allow is true the SSH configuration provided is used, otherwise it is ignored. Only one of
-		// PublicKeyPath, PublicKey and PublicKeyName can be configured
+		// PublicKeyPath, PublicKey or PublicKeyName can be configured
 		Allow *bool `json:"allow"`
-		// +optional The path to the SSH public key to be added to the nodes SSH keychain. If Allow is true this value
-		// defaults to "~/.ssh/id_rsa.pub", otherwise the value is ignored.
+		//+optional The path to the SSH public key to allow access to the nodes
+		// Defaults to `"~/.ssh/id_rsa.pub"`
 		PublicKeyPath *string `json:"publicKeyPath,omitempty"`
-		// +optional Public key to be added to the nodes SSH keychain. If Allow is false this value is ignored.
+		// +optional Public key to be added to the nodes SSH keychain.
 		PublicKey *string `json:"publicKey,omitempty"`
-		// +optional Public key name in EC2 to be added to the nodes SSH keychain. If Allow is false this value
-		// is ignored.
+		// +optional Public key name in EC2 to be added to the nodes SSH keychain.
 		PublicKeyName *string `json:"publicKeyName,omitempty"`
 		// +optional
 		SourceSecurityGroupIDs []string `json:"sourceSecurityGroupIds,omitempty"`