ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

website: fix remote config docs

This commit is contained in:
Mitchell Hashimoto 2015-04-07 14:50:10 -07:00
parent 18f2e13275
commit c9fe0c1b34
1 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
website/source/docs/commands/remote-config.html.markdown
View File

@ -33,32 +33,33 @@ By default, `remote config` will look for the "terraform.tfstate" file, but that
can be specified by the `-state` flag. If no state file exists, a blank can be specified by the `-state` flag. If no state file exists, a blank
state will be configured. state will be configured.
When enabling remote storage, use the `-backend-config` flag to set
the required configuration variables as documented below. See the example
below this section for more details.
When remote storage is disabled, the existing remote state is migrated When remote storage is disabled, the existing remote state is migrated
to a local file. This defaults to the `-state` path during restore. to a local file. This defaults to the `-state` path during restore.
The following backends are supported: The following backends are supported:
* Atlas - Stores the state in Atlas. Requires the `-name` and `-access-token` flag. * Atlas - Stores the state in Atlas. Requires the `name` and `access-token`
The `-address` flag can optionally be provided. variables. The `address` variable can optionally be provided.
* Consul - Stores the state in the KV store at a given path. * Consul - Stores the state in the KV store at a given path.
Requires the `path` flag. The `-address` and `-access-token` Requires the `path` variable. The `address` and `access-token`
flag can optionally be provided. Address is assumed to be the variables can optionally be provided. Address is assumed to be the
local agent if not provided. local agent if not provided.
* HTTP - Stores the state using a simple REST client. State will be fetched * HTTP - Stores the state using a simple REST client. State will be fetched
via GET, updated via POST, and purged with DELETE. Requires the `-address` flag. via GET, updated via POST, and purged with DELETE. Requires the `address` variable.
The command-line flags are all optional. The list of available flags are: The command-line flags are all optional. The list of available flags are:
* `-address=url` - URL of the remote storage server. Required for HTTP backend, * `-backend=Atlas` - The remote backend to use. Must be one of the above
optional for Atlas and Consul. supported backends.
* `-access-token=token` - Authentication token for state storage server. * `-backend-config="k=v"` - Specify a configuration variable for a backend.
Required for Atlas backend, optional for Consul. This is how you set the required variables for the backends above.
* `-backend=Atlas` - Specifies the type of remote backend. Must be one
of Atlas, Consul, or HTTP. Defaults to Atlas.
* `-backup=path` - Path to backup the existing state file before * `-backup=path` - Path to backup the existing state file before
modifying. Defaults to the "-state" path with ".backup" extension. modifying. Defaults to the "-state" path with ".backup" extension.
@ -67,12 +68,6 @@ The command-line flags are all optional. The list of available flags are:
* `-disable` - Disables remote state management and migrates the state * `-disable` - Disables remote state management and migrates the state
to the `-state` path. to the `-state` path.
* `-name=name` - Name of the state file in the state storage server.
Required for Atlas backend.
* `-path=path` - Path of the remote state in Consul. Required for the
Consul backend.
* `-pull=true` - Controls if the remote state is pulled before disabling * `-pull=true` - Controls if the remote state is pulled before disabling
or after enabling. This defaults to true to ensure the latest state or after enabling. This defaults to true to ensure the latest state
is available under both conditions. is available under both conditions.
@ -80,3 +75,15 @@ The command-line flags are all optional. The list of available flags are:
* `-state=path` - Path to read state. Defaults to "terraform.tfstate" * `-state=path` - Path to read state. Defaults to "terraform.tfstate"
unless remote state is enabled. unless remote state is enabled.
## Example: Consul
The example below will push your remote state to Consul. Note that for
this example, it would go to the public Consul demo. In practice, you
should use your own private Consul server:
```
$ terraform remote config \
-backend=consul \
-backend-config="address=demo.consul.io:80" \
-backend-config="path=tf"
```