Add warning note to each backend page

This commit is contained in:
Laura Pacilio 2022-06-08 16:32:01 -04:00
parent 89dbd6a26b
commit 53d0661785
16 changed files with 47 additions and 16 deletions

View File

@ -45,7 +45,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options / environment variables are supported: The following configuration options / environment variables are supported:

View File

@ -230,7 +230,10 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options are supported: The following configuration options are supported:

View File

@ -43,11 +43,11 @@ There are some important limitations on backend configuration:
- A configuration can only provide one backend block. - A configuration can only provide one backend block.
- A backend block cannot refer to named values (like input variables, locals, or data source attributes). - A backend block cannot refer to named values (like input variables, locals, or data source attributes).
### Managing Credentials ### Credentials and Sensitive Data
Backends store state in a remote service, which allows multiple people to access it. Accessing remote state generally requires access credentials, since state data contains extremely sensitive information. Backends store state in a remote service, which allows multiple people to access it. Accessing remote state generally requires access credentials, since state data contains extremely sensitive information.
!> **Warning:** We recommend using environment variables to supply sensitive credentials and other data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. This can leak sensitive credentials. !> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. This can leak sensitive credentials.
Terraform writes the backend configuration in plain text in two separate files. Terraform writes the backend configuration in plain text in two separate files.
- The `.terraform/terraform.tfstate` file contains the backend configuration for the current working directory. - The `.terraform/terraform.tfstate` file contains the backend configuration for the current working directory.

View File

@ -35,7 +35,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options / environment variables are supported: The following configuration options / environment variables are supported:

View File

@ -45,7 +45,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options or environment variables are supported: The following configuration options or environment variables are supported:

View File

@ -32,7 +32,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options are supported: The following configuration options are supported:

View File

@ -37,7 +37,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options / environment variables are supported: The following configuration options / environment variables are supported:

View File

@ -73,7 +73,9 @@ the path of the service account key. Terraform will use that key for authenticat
Terraform can impersonate a Google Service Account as described [here](https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials). A valid credential must be provided as mentioned in the earlier section and that identity must have the `roles/iam.serviceAccountTokenCreator` role on the service account you are impersonating. Terraform can impersonate a Google Service Account as described [here](https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials). A valid credential must be provided as mentioned in the earlier section and that identity must have the `roles/iam.serviceAccountTokenCreator` role on the service account you are impersonating.
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options are supported: The following configuration options are supported:

View File

@ -38,7 +38,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options / environment variables are supported: The following configuration options / environment variables are supported:

View File

@ -44,7 +44,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options are supported: The following configuration options are supported:

View File

@ -35,7 +35,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options are supported: The following configuration options are supported:

View File

@ -69,7 +69,9 @@ data "terraform_remote_state" "network" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options or environment variables are supported: The following configuration options or environment variables are supported:

View File

@ -64,6 +64,8 @@ data "terraform_remote_state" "network" {
## Configuration Variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options or environment variables are supported: The following configuration options or environment variables are supported:
- `conn_str` - (Required) Postgres connection string; a `postgres://` URL - `conn_str` - (Required) Postgres connection string; a `postgres://` URL

View File

@ -173,7 +173,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options are supported: The following configuration options are supported:

View File

@ -142,6 +142,8 @@ This backend requires the configuration of the AWS Region and S3 state storage.
### Credentials and Shared Configuration ### Credentials and Shared Configuration
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration is required: The following configuration is required:
* `region` - (Required) AWS Region of the S3 Bucket and DynamoDB Table (if used). This can also be sourced from the `AWS_DEFAULT_REGION` and `AWS_REGION` environment variables. * `region` - (Required) AWS Region of the S3 Bucket and DynamoDB Table (if used). This can also be sourced from the `AWS_DEFAULT_REGION` and `AWS_REGION` environment variables.

View File

@ -39,7 +39,9 @@ data "terraform_remote_state" "foo" {
} }
``` ```
## Configuration variables ## Configuration Variables
!> **Warning:** We recommend using environment variables to supply credentials and other sensitive data. If you use `-backend-config` or hardcode these values directly in your configuration, Terraform will include these values in both state and plan files. Refer to [Credentials and Sensitive Data](/language/settings/backends/configuration#credentials-and-sensitive-data) for details.
The following configuration options are supported: The following configuration options are supported: