website: update docs for state show
This commit is contained in:
parent
f6692e66ac
commit
5737c0a13b
|
@ -63,7 +63,9 @@ func (c *StateShowCommand) Run(args []string) int {
|
|||
output := make([]string, 0, len(is.Attributes)+1)
|
||||
output = append(output, fmt.Sprintf("id | %s", is.ID))
|
||||
for _, k := range keys {
|
||||
output = append(output, fmt.Sprintf("%s | %s", k, is.Attributes[k]))
|
||||
if k != "id" {
|
||||
output = append(output, fmt.Sprintf("%s | %s", k, is.Attributes[k]))
|
||||
}
|
||||
}
|
||||
|
||||
// Output
|
||||
|
|
|
@ -3,7 +3,7 @@ layout: "commands-state"
|
|||
page_title: "Command: state list"
|
||||
sidebar_current: "docs-state-sub-list"
|
||||
description: |-
|
||||
The `terraform init` command is used to initialize a Terraform configuration using another module as a skeleton.
|
||||
The terraform state list command is used to list resources within a Terraform state.
|
||||
---
|
||||
|
||||
# Command: state list
|
||||
|
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
layout: "commands-state"
|
||||
page_title: "Command: state show"
|
||||
sidebar_current: "docs-state-sub-show"
|
||||
description: |-
|
||||
The `terraform state show` command is used to show the attributes of a single resource in the Terraform state.
|
||||
---
|
||||
|
||||
# Command: state show
|
||||
|
||||
The `terraform state show` command is used to show the attributes of a
|
||||
single resource in the
|
||||
[Terraform state](/docs/state/index.html).
|
||||
|
||||
## Usage
|
||||
|
||||
Usage: `terraform state show [options] PATTERN`
|
||||
|
||||
The command will show the attributes of a single resource in the
|
||||
state file that matches the given pattern.
|
||||
|
||||
The attributes are listed in alphabetical order (with the except of "id"
|
||||
which is always at the top). They are outputted in a way that is easy
|
||||
to parse on the command-line.
|
||||
|
||||
This command requires a pattern that points to a single resource in the
|
||||
state. Patterns are
|
||||
in [resource addressing format](/docs/commands/state/addressing.html).
|
||||
|
||||
The command-line flags are all optional. The list of available flags are:
|
||||
|
||||
* `-state=path` - Path to the state file. Defaults to "terraform.tfstate".
|
||||
|
||||
## Example: Show a Resource
|
||||
|
||||
The example below shows a resource:
|
||||
|
||||
```
|
||||
$ terraform state show module.foo.packet_device.worker[0]
|
||||
id = 6015bg2b-b8c4-4925-aad2-f0671d5d3b13
|
||||
billing_cycle = hourly
|
||||
created = 2015-12-17T00:06:56Z
|
||||
facility = ewr1
|
||||
hostname = prod-xyz01
|
||||
locked = false
|
||||
...
|
||||
```
|
|
@ -20,6 +20,10 @@
|
|||
<li<%= sidebar_current("docs-state-sub-list") %>>
|
||||
<a href="/docs/commands/state/list.html">list</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-state-sub-show") %>>
|
||||
<a href="/docs/commands/state/show.html">show</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
Loading…
Reference in New Issue