From a038f8c43bd18249b7634f5fe2f7aec05c83423e Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Wed, 28 Aug 2019 19:59:39 -0700 Subject: [PATCH] website: In 0.12, terraform_remote_state syntax differs from backend config --- .../terraform/d/remote_state.html.md | 27 +++++++++++++------ .../providers/terraform/index.html.markdown | 7 +++-- 2 files changed, 24 insertions(+), 10 deletions(-) diff --git a/website/docs/providers/terraform/d/remote_state.html.md b/website/docs/providers/terraform/d/remote_state.html.md index 4214a3c76..e3e6358c8 100644 --- a/website/docs/providers/terraform/d/remote_state.html.md +++ b/website/docs/providers/terraform/d/remote_state.html.md @@ -24,8 +24,12 @@ use interpolations when configuring them. ```hcl data "terraform_remote_state" "vpc" { backend = "remote" + config = { - name = "hashicorp/vpc-prod" + organization = "hashicorp" + workspaces = { + name = "vpc-prod" + } } } @@ -49,19 +53,26 @@ The following arguments are supported: * `backend` - (Required) The remote backend to use. * `workspace` - (Optional) The Terraform workspace to use, if the backend supports workspaces. -* `config` - (Optional; block) The configuration of the remote backend. The - `config` block can use any arguments that would be valid in the equivalent - `terraform { backend "" { ... } }` block. See - [the documentation of your chosen backend](/docs/backends/types/index.html) - for details. -* `defaults` - (Optional; block) Default values for outputs, in case the state +* `config` - (Optional; object) The configuration of the remote backend. + Although this argument is listed as optional, most backends require + some configuration. + + The `config` object can use any arguments that would be valid in the + equivalent `terraform { backend "" { ... } }` block. See + [the documentation of your chosen backend](/docs/backends/types/index.html) + for details. + + -> **Note:** If the backend configuration requires a nested block, specify + it here as a normal attribute with an object value. (For example, + `workspaces = { ... }` instead of `workspaces { ... }`.) +* `defaults` - (Optional; object) Default values for outputs, in case the state file is empty or lacks a required output. ## Attributes Reference In addition to the above, the following attributes are exported: -* (v0.12+) `outputs` - An object containing every root-level +* (v0.12+) `outputs` - An object containing every root-level [output](/docs/configuration/outputs.html) in the remote state. * (<= v0.11) `` - Each root-level [output](/docs/configuration/outputs.html) in the remote state appears as a top level attribute on the data source. diff --git a/website/docs/providers/terraform/index.html.markdown b/website/docs/providers/terraform/index.html.markdown index 6ccc56bca..8327958b1 100644 --- a/website/docs/providers/terraform/index.html.markdown +++ b/website/docs/providers/terraform/index.html.markdown @@ -18,10 +18,13 @@ Use the navigation to the left to read about the available data sources. ```hcl # Shared infrastructure state stored in Atlas data "terraform_remote_state" "vpc" { - backend = "atlas" + backend = "remote" config { - name = "hashicorp/vpc-prod" + organization = "hashicorp" + workspaces = { + name = "vpc-prod" + } } }