Merge pull request openstack-k8s-operators#397 from jpodivin/secretfi…

…elddesc Explaining that secret is actually just a name of the secret
bshephar · Sep 8, 2023 · 27eb828 · 27eb828
2 parents 468c5d2 + 007c8ea
commit 27eb828
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/api/v1beta1/common.go b/api/v1beta1/common.go
@@ -84,8 +84,9 @@ type NodeSection struct {
 
 // NodeTemplate is a specification of the node attributes that override top level attributes.
 type NodeTemplate struct {
-	// AnsibleSSHPrivateKeySecret Private SSH Key secret containing private SSH
-	// key for connecting to node. Must be of the form:
+	// AnsibleSSHPrivateKeySecret Name of a private SSH key secret containing
+	// private SSH key for connecting to node.
+	// The named secret must be of the form:
 	// Secret.data.ssh-privatekey: <base64 encoded private key contents>
 	// <https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets>
 	// +kubebuilder:validation:Optional

diff --git a/docs/openstack_dataplanenodeset.md b/docs/openstack_dataplanenodeset.md
@@ -91,7 +91,7 @@ NodeTemplate is a specification of the node attributes that override top level a
 
 | Field | Description | Scheme | Required |
 | ----- | ----------- | ------ | -------- |
-| ansibleSSHPrivateKeySecret | AnsibleSSHPrivateKeySecret Private SSH Key secret containing private SSH key for connecting to node. Must be of the form: Secret.data.ssh-privatekey: <base64 encoded private key contents> <https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets> | string | false |
+| ansibleSSHPrivateKeySecret | AnsibleSSHPrivateKeySecret Name of a private SSH key secret containing private SSH key for connecting to node. The named secret must be of the form: Secret.data.ssh-privatekey: <base64 encoded private key contents> <https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets> | string | false |
 | nodes | Nodes - Map of Node Names and node specific data. Values here override defaults in the upper level section. | map[string][NodeSection](#nodesection) | true |
 | networkAttachments | NetworkAttachments is a list of NetworkAttachment resource names to pass to the ansibleee resource which allows to connect the ansibleee runner to the given network | []string | false |
 | networkConfig | NetworkConfig - Network configuration details. Contains os-net-config related properties. | [NetworkConfigSection](#networkconfigsection) | false |

diff --git a/docs/openstack_dataplaneservice.md b/docs/openstack_dataplaneservice.md
@@ -92,7 +92,7 @@ NodeTemplate is a specification of the node attributes that override top level a
 
 | Field | Description | Scheme | Required |
 | ----- | ----------- | ------ | -------- |
-| ansibleSSHPrivateKeySecret | AnsibleSSHPrivateKeySecret Private SSH Key secret containing private SSH key for connecting to node. Must be of the form: Secret.data.ssh-privatekey: <base64 encoded private key contents> <https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets> | string | false |
+| ansibleSSHPrivateKeySecret | AnsibleSSHPrivateKeySecret Name of a private SSH key secret containing private SSH key for connecting to node. The named secret must be of the form: Secret.data.ssh-privatekey: <base64 encoded private key contents> <https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets> | string | false |
 | nodes | Nodes - Map of Node Names and node specific data. Values here override defaults in the upper level section. | map[string][NodeSection](#nodesection) | true |
 | networkAttachments | NetworkAttachments is a list of NetworkAttachment resource names to pass to the ansibleee resource which allows to connect the ansibleee runner to the given network | []string | false |
 | networkConfig | NetworkConfig - Network configuration details. Contains os-net-config related properties. | [NetworkConfigSection](#networkconfigsection) | false |