Update documentation by adding a note regarding default_secret_name.

hashicorp · Mar 15, 2022 · f4c68cf · f4c68cf
1 parent c419925
commit f4c68cf
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 1 deletion.
diff --git a/kubernetes/data_source_kubernetes_service_account_test.go b/kubernetes/data_source_kubernetes_service_account_test.go
@@ -125,7 +125,7 @@ variable "token_name" {
 
 resource "kubernetes_service_account" "test" {
   metadata {
-   name = "%s"
+    name = "%s"
   }
   secret {
     name = var.token_name

diff --git a/website/docs/d/service_account.html.markdown b/website/docs/d/service_account.html.markdown
@@ -55,6 +55,8 @@ The following arguments are supported:
 * `secret` - A list of secrets associated with the service account.
 * `default_secret_name` - Name of the default secret, containing service account token, created & managed by the service.
 
+~> default_secret_name will try to find the secret containing the service account token that Kubernetes automatically created for the service account. In cases where there are multiple tokens and the provider cannot determine which was created by Kubernetes this attribute will be empty. When there is only one token associated with the service account this will be returned.
+
 ### `image_pull_secret`
 
 #### Attributes

diff --git a/website/docs/d/service_account_v1.html.markdown b/website/docs/d/service_account_v1.html.markdown
@@ -55,6 +55,8 @@ The following arguments are supported:
 * `secret` - A list of secrets associated with the service account.
 * `default_secret_name` - Name of the default secret, containing service account token, created & managed by the service.
 
+~> default_secret_name will try to find the secret containing the service account token that Kubernetes automatically created for the service account. In cases where there are multiple tokens and the provider cannot determine which was created by Kubernetes this attribute will be empty. When there is only one token associated with the service account this will be returned.
+
 ### `image_pull_secret`
 
 #### Attributes

diff --git a/website/docs/r/default_service_account.html.markdown b/website/docs/r/default_service_account.html.markdown
@@ -81,6 +81,8 @@ exported:
 
 * `default_secret_name` - Name of the default secret, containing service account token, created & managed by the service.
 
+~> default_secret_name will try to find the secret containing the service account token that Kubernetes automatically created for the service account. In cases where there are multiple tokens and the provider cannot determine which was created by Kubernetes this attribute will be empty. When there is only one token associated with the service account this will be returned.
+
 ## Destroying
 
 If you remove a `kubernetes_default_service_account` resource from your configuration, Terraform will send a delete request to the Kubernetes API. Kubernetes will automatically replace this service account, but any customizations will be lost. If you no longer want to manage a default service account with Terraform, use `terraform state rm` to remove it from state before removing the configuration.

diff --git a/website/docs/r/default_service_account_v1.html.markdown b/website/docs/r/default_service_account_v1.html.markdown
@@ -81,6 +81,8 @@ exported:
 
 * `default_secret_name` - Name of the default secret, containing service account token, created & managed by the service.
 
+~> default_secret_name will try to find the secret containing the service account token that Kubernetes automatically created for the service account. In cases where there are multiple tokens and the provider cannot determine which was created by Kubernetes this attribute will be empty. When there is only one token associated with the service account this will be returned.
+
 ## Destroying
 
 If you remove a `kubernetes_default_service_account_v1` resource from your configuration, Terraform will send a delete request to the Kubernetes API. Kubernetes will automatically replace this service account, but any customizations will be lost. If you no longer want to manage a default service account with Terraform, use `terraform state rm` to remove it from state before removing the configuration.

diff --git a/website/docs/r/service_account.html.markdown b/website/docs/r/service_account.html.markdown
@@ -83,6 +83,8 @@ exported:
 
 * `default_secret_name` - Name of the default secret, containing service account token, created & managed by the service.
 
+~> default_secret_name will try to find the secret containing the service account token that Kubernetes automatically created for the service account. In cases where there are multiple tokens and the provider cannot determine which was created by Kubernetes this attribute will be empty. When there is only one token associated with the service account this will be returned.
+
 ## Import
 
 Service account can be imported using the namespace and name, e.g.

diff --git a/website/docs/r/service_account_v1.html.markdown b/website/docs/r/service_account_v1.html.markdown
@@ -83,6 +83,8 @@ exported:
 
 * `default_secret_name` - Name of the default secret, containing service account token, created & managed by the service.
 
+~> default_secret_name will try to find the secret containing the service account token that Kubernetes automatically created for the service account. In cases where there are multiple tokens and the provider cannot determine which was created by Kubernetes this attribute will be empty. When there is only one token associated with the service account this will be returned.
+
 ## Import
 
 Service account can be imported using the namespace and name, e.g.