Skip to content

Commit 35ac28c

Browse files
authored
chore: Update README to prevent KSA misconfiguration (#1143)
* Update README to prevent KSA misconfiguration Update the documentation of the workload identity module to address issue #1065 * Update workload identity variables definition
1 parent 04ee10b commit 35ac28c

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

modules/workload-identity/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ already bear the `"iam.gke.io/gcp-service-account"` annotation.
100100
| cluster\_name | Cluster name. Required if using existing KSA. | `string` | `""` | no |
101101
| gcp\_sa\_name | Name for the Google service account; overrides `var.name`. | `string` | `null` | no |
102102
| impersonate\_service\_account | An optional service account to impersonate for gcloud commands. If this service account is not specified, the module will use Application Default Credentials. | `string` | `""` | no |
103-
| k8s\_sa\_name | Name for the Kubernetes service account; overrides `var.name`. | `string` | `null` | no |
103+
| k8s\_sa\_name | Name for the Kubernetes service account; overrides `var.name`. `cluster_name` and `location` must be set when this input is specified. | `string` | `null` | no |
104104
| location | Cluster location (region if regional cluster, zone if zonal cluster). Required if using existing KSA. | `string` | `""` | no |
105105
| name | Name for both service accounts. The GCP SA will be truncated to the first 30 chars if necessary. | `string` | n/a | yes |
106106
| namespace | Namespace for the Kubernetes service account | `string` | `"default"` | no |

modules/workload-identity/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ variable "location" {
4949
}
5050

5151
variable "k8s_sa_name" {
52-
description = "Name for the Kubernetes service account; overrides `var.name`."
52+
description = "Name for the Kubernetes service account; overrides `var.name`. `cluster_name` and `location` must be set when this input is specified."
5353
type = string
5454
default = null
5555
}

0 commit comments

Comments
 (0)