Skip to content

Commit 0efec8b

Browse files
authored
Improve service account secret docs example (#2407)
The examples currently cause problems for users as per issue #1943 This changes the examples to suggest using: - generate_name for the secret - wait_for_service_account_token for the secret - not using the secret attribute of the service_account terraform resource - which seems to do nothing as it doesn't map to the kubernetes manifest schema - creates a dependency in the wrong direction
1 parent fc5b9ed commit 0efec8b

File tree

4 files changed

+24
-10
lines changed

4 files changed

+24
-10
lines changed

website/docs/r/secret.html.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,12 @@ resource "kubernetes_secret" "example" {
9090
annotations = {
9191
"kubernetes.io/service-account.name" = "my-service-account"
9292
}
93+
94+
generate_name = "my-service-account-"
9395
}
9496
95-
type = "kubernetes.io/service-account-token"
97+
type = "kubernetes.io/service-account-token"
98+
wait_for_service_account_token = true
9699
}
97100
```
98101

website/docs/r/secret_v1.html.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,12 @@ resource "kubernetes_secret_v1" "example" {
9090
annotations = {
9191
"kubernetes.io/service-account.name" = "my-service-account"
9292
}
93+
94+
generate_name = "my-service-account-"
9395
}
9496
95-
type = "kubernetes.io/service-account-token"
97+
type = "kubernetes.io/service-account-token"
98+
wait_for_service_account_token = true
9699
}
97100
```
98101

website/docs/r/service_account.html.markdown

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,19 @@ resource "kubernetes_service_account" "example" {
1919
metadata {
2020
name = "terraform-example"
2121
}
22-
secret {
23-
name = "${kubernetes_secret.example.metadata.0.name}"
24-
}
2522
}
2623
2724
resource "kubernetes_secret" "example" {
2825
metadata {
29-
name = "terraform-example"
26+
annotations = {
27+
"kubernetes.io/service-account.name" = kubernetes_service_account.example.metadata.0.name
28+
}
29+
30+
generate_name = "terraform-example-"
3031
}
32+
33+
type = "kubernetes.io/service-account-token"
34+
wait_for_service_account_token = true
3135
}
3236
```
3337

website/docs/r/service_account_v1.html.markdown

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,19 @@ resource "kubernetes_service_account_v1" "example" {
1919
metadata {
2020
name = "terraform-example"
2121
}
22-
secret {
23-
name = "${kubernetes_secret_v1.example.metadata.0.name}"
24-
}
2522
}
2623
2724
resource "kubernetes_secret_v1" "example" {
2825
metadata {
29-
name = "terraform-example"
26+
annotations = {
27+
"kubernetes.io/service-account.name" = kubernetes_service_account_v1.example.metadata.0.name
28+
}
29+
30+
generate_name = "terraform-example-"
3031
}
32+
33+
type = "kubernetes.io/service-account-token"
34+
wait_for_service_account_token = true
3135
}
3236
```
3337

0 commit comments

Comments
 (0)