Skip to content

Commit

Permalink
Some small changes to the SSH doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelbeaumont committed Feb 12, 2021
1 parent d075f91 commit 47dced0
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
12 changes: 6 additions & 6 deletions pkg/apis/eksctl.io/v1alpha5/assets/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -1590,18 +1590,18 @@
},
"publicKey": {
"type": "string",
"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."
"description": "Contents of public key to authorize",
"x-intellij-html-description": "Contents of public key to authorize"
},
"publicKeyName": {
"type": "string",
"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."
"description": "Public key name in EC2 to authorize",
"x-intellij-html-description": "Public key name in EC2 to authorize"
},
"publicKeyPath": {
"type": "string",
"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",
"description": "The path to the SSH public key to authorize",
"x-intellij-html-description": "The path to the SSH public key to authorize",
"default": "~/.ssh/id_rsa.pub"
},
"sourceSecurityGroupIds": {
Expand Down
6 changes: 3 additions & 3 deletions pkg/apis/eksctl.io/v1alpha5/schema.go

Large diffs are not rendered by default.

11 changes: 5 additions & 6 deletions pkg/apis/eksctl.io/v1alpha5/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -1062,20 +1062,19 @@ 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
// If Allow is true the SSH configuration provided is used, otherwise it is ignored. Only one of
// PublicKeyPath, PublicKey or PublicKeyName can be configured
Allow *bool `json:"allow"`
//+optional The path to the SSH public key to allow access to the nodes
// The path to the SSH public key to authorize
// Defaults to `"~/.ssh/id_rsa.pub"`
PublicKeyPath *string `json:"publicKeyPath,omitempty"`
// +optional Public key to be added to the nodes SSH keychain.
// Contents of public key to authorize
PublicKey *string `json:"publicKey,omitempty"`
// +optional Public key name in EC2 to be added to the nodes SSH keychain.
// Public key name in EC2 to authorize
PublicKeyName *string `json:"publicKeyName,omitempty"`
// +optional

SourceSecurityGroupIDs []string `json:"sourceSecurityGroupIds,omitempty"`
// Enables the ability to [SSH onto nodes using SSM](/introduction#ssh-access)
// +optional
EnableSSM *bool `json:"enableSsm,omitempty"`
}

Expand Down

0 comments on commit 47dced0

Please sign in to comment.