website: add token setup callout to remote backend docs (#24109)

This commit is contained in:
im2nguyen 2020-02-18 16:28:12 -08:00 committed by GitHub
parent d41981eabb
commit 4f10504ca0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 19 deletions

View File

@ -91,7 +91,13 @@ set or requires a specific version of Terraform for remote operations, we
recommend that you create your remote workspaces on Terraform Cloud before
running any remote operations against them.
## Example Configuration
## Example Configurations and References
-> **Note:** We recommend omitting the token from the configuration, and instead using
[`terraform login`](/docs/commands/login.html) or manually configuring
`credentials` in the [CLI config file](/docs/commands/cli-config.html#credentials).
### Basic Configuration
```hcl
# Using a single workspace:
@ -119,23 +125,7 @@ terraform {
}
```
## Example Reference
```hcl
data "terraform_remote_state" "foo" {
backend = "remote"
config = {
organization = "company"
workspaces = {
name = "workspace"
}
}
}
```
## Example configuration using CLI input
### Using CLI Input
```hcl
# main.tf
@ -161,6 +151,22 @@ Running `terraform init` with the backend file:
terraform init -backend-config=backend.hcl
```
### Example Reference
```hcl
data "terraform_remote_state" "foo" {
backend = "remote"
config = {
organization = "company"
workspaces = {
name = "workspace"
}
}
}
```
## Configuration variables
The following configuration options are supported:
@ -185,7 +191,7 @@ The following configuration options are supported:
(minus the prefix) are used on the command line for Terraform CLI workspaces.
If omitted, only the default workspace can be used. This option conflicts with `name`.
-> **Note** You must use the `name` key when configuring a `terraform_remote_state`
-> **Note:** You must use the `name` key when configuring a `terraform_remote_state`
data source that retrieves state from another Terraform Cloud workspace. The `prefix` key is only
intended for use when configuring an instance of the remote backend.