Skip to content

Commit 55e0424

Browse files
Add Warnings about sensitive Google Credentials in Remote State (#5953) (#4239)
Signed-off-by: Modular Magician <[email protected]>
1 parent 3c62b93 commit 55e0424

File tree

5 files changed

+14
-9
lines changed

5 files changed

+14
-9
lines changed

.changelog/5953.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:none
2+
3+
```

website/docs/d/client_config.html.markdown

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ description: |-
1111

1212
Use this data source to access the configuration of the Google Cloud provider.
1313

14+
-> **Warning**: This resource persists a sensitive credential in the [remote state](https://www.terraform.io/language/state/sensitive-data) used by Terraform.
15+
Please take appropriate measures to protect your remote state.
16+
1417
## Example Usage
1518

1619
```tf
@@ -34,8 +37,6 @@ data "google_container_cluster" "my_cluster" {
3437
}
3538
3639
provider "kubernetes" {
37-
load_config_file = false
38-
3940
host = "https://${data.google_container_cluster.my_cluster.endpoint}"
4041
token = data.google_client_config.default.access_token
4142
cluster_ca_certificate = base64decode(

website/docs/d/client_openid_userinfo.html.markdown

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ authentication with GKE and configure an RBAC role for the email used.
1919

2020
~> This resource will only work as expected if the provider is configured to
2121
use the `https://www.googleapis.com/auth/userinfo.email` scope! You will
22-
receive an error otherwise.
22+
receive an error otherwise. The provider uses this scope by default.
2323

2424
## Example Usage - exporting an email
2525

@@ -47,8 +47,6 @@ data "google_container_cluster" "my_cluster" {
4747
}
4848
4949
provider "kubernetes" {
50-
load_config_file = false
51-
5250
host = "https://${data.google_container_cluster.my_cluster.endpoint}"
5351
token = data.google_client_config.provider.access_token
5452
cluster_ca_certificate = base64decode(

website/docs/r/container_cluster.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Manages a Google Kubernetes Engine (GKE) cluster. For more information see
1919
[the official documentation](https://cloud.google.com/container-engine/docs/clusters)
2020
and [the API reference](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters).
2121

22-
~> **Note:** All arguments and attributes, including basic auth username and
22+
~> **Warning:** All arguments and attributes, including basic auth username and
2323
passwords as well as certificate outputs will be stored in the raw state as
24-
plaintext. [Read more about sensitive data in state](/language/state/sensitive-data.html).
24+
plaintext. [Read more about sensitive data in state](https://www.terraform.io/language/state/sensitive-data).
2525

2626
## Example Usage - with a separately managed node pool (recommended)
2727

@@ -999,7 +999,7 @@ exported:
999999
to authenticate to the cluster endpoint.
10001000

10011001
* `master_auth.0.cluster_ca_certificate` - Base64 encoded public certificate
1002-
that is the root of trust for the cluster.
1002+
that is the root certificate of the cluster.
10031003

10041004
* `master_version` - The current version of the master in the cluster. This may
10051005
be different than the `min_master_version` set in the config if the master

website/docs/r/google_service_account_key.html.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ description: |-
99

1010
# google_service_account_key
1111

12-
Creates and manages service account keys, which allow the use of a service account outside of Google Cloud.
12+
Creates and manages service account keys, which allow the use of a service account with Google Cloud.
13+
14+
-> **Warning**: This resource persists a sensitive credential in plaintext in the [remote state](https://www.terraform.io/language/state/sensitive-data) used by Terraform.
15+
Please take appropriate measures to protect your remote state.
1316

1417
* [API documentation](https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts.keys)
1518
* How-to Guides

0 commit comments

Comments
 (0)