-
Notifications
You must be signed in to change notification settings - Fork 9.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Terraform/Remote State documentation to provider/resource section.
Issue #2074
- Loading branch information
1 parent
aaa922c
commit 0f551d6
Showing
6 changed files
with
112 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
website/source/docs/providers/terraform/index.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
layout: "terraform" | ||
page_title: "Provider: Terraform" | ||
sidebar_current: "docs-terraform-index" | ||
description: |- | ||
The Terraform provider is used to access meta data from shared infrastructure. | ||
--- | ||
|
||
# Terraform Provider | ||
|
||
The terraform provider exposes resources to access state meta data | ||
for Terraform outputs from shared infrastructure. | ||
|
||
The terraform provider is what we call a _logical provider_. This has no | ||
impact on how it behaves, but conceptually it is important to understand. | ||
The terraform provider doesn't manage any _physical_ resources; it isn't | ||
creating servers, writing files, etc. It is used to access the outputs | ||
of other Terraform states to be used as inputs for resources. | ||
Examples will explain this best. | ||
|
||
Use the navigation to the left to read about the available resources. | ||
|
||
## Example Usage | ||
|
||
``` | ||
# Shared infrastructure state stored in Atlas | ||
resource "terraform_remote_state" "vpc" { | ||
backend = "atlas" | ||
config { | ||
path = "hashicorp/vpc-prod" | ||
} | ||
} | ||
resource "aws_instance" "foo" { | ||
# ... | ||
subnet_id = "${terraform_remote_state.vpc.output.subnet_id}" | ||
} | ||
``` |
42 changes: 42 additions & 0 deletions
42
website/source/docs/providers/terraform/r/remote_state.html.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
layout: "terraform" | ||
page_title: "Terraform: terraform_remote_state" | ||
sidebar_current: "docs-terraform-resource-remote-state" | ||
description: |- | ||
Accesses state meta data from a remote backend. | ||
--- | ||
|
||
# remote\_state | ||
|
||
Retrieves state meta data from a remote backend | ||
|
||
## Example Usage | ||
|
||
``` | ||
resource "terraform_remote_state" "vpc" { | ||
backend = "atlas" | ||
config { | ||
path = "hashicorp/vpc-prod" | ||
} | ||
} | ||
resource "aws_instance" "foo" { | ||
# ... | ||
subnet_id = "${terraform_remote_state.vpc.output.subnet_id}" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `backend` - (Required) The remote backend to use. | ||
* `config` - (Optional) The configuration of the remote backend. | ||
|
||
## Attributes Reference | ||
|
||
The following attributes are exported: | ||
|
||
* `backend` - See Argument Reference above. | ||
* `config` - See Argument Reference above. | ||
* `output` - The values of the configured `outputs` for the root module referenced by the remote state. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<% wrap_layout :inner do %> | ||
<% content_for :sidebar do %> | ||
<div class="docs-sidebar hidden-print affix-top" role="complementary"> | ||
<ul class="nav docs-sidenav"> | ||
<li<%= sidebar_current("docs-home") %>> | ||
<a href="/docs/providers/index.html">« Documentation Home</a> | ||
</li> | ||
|
||
<li<%= sidebar_current("docs-terraform-index") %>> | ||
<a href="/docs/providers/terraform/index.html">Terraform Provider</a> | ||
</li> | ||
|
||
<li<%= sidebar_current(/^docs-terraform-resource/) %>> | ||
<a href="#">Resources</a> | ||
<ul class="nav nav-visible"> | ||
<li<%= sidebar_current("docs-terraform-resource-remote-state") %>> | ||
<a href="/docs/providers/terraform/r/remote_state.html">terraform_remote_state</a> | ||
</li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</div> | ||
<% end %> | ||
<%= yield %> | ||
<% end %> |