github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/website/source/docs/state/remote/consul.html.md (about)

     1  ---
     2  layout: "remotestate"
     3  page_title: "Remote State Backend: consul"
     4  sidebar_current: "docs-state-remote-consul"
     5  description: |-
     6    Terraform can store the state remotely, making it easier to version and work with in a team.
     7  ---
     8  
     9  # consul
    10  
    11  Stores the state in the [Consul](https://www.consul.io/) KV store at a given path.
    12  
    13  -> **Note:** Specifying `access_token` directly makes it included in
    14  cleartext inside the persisted, shard state.
    15  Use of the environment variable `CONSUL_HTTP_TOKEN` is recommended.
    16  
    17  ## Example Usage
    18  
    19  ```
    20  terraform remote config \
    21  	-backend=consul \
    22  	-backend-config="path=full/path"
    23  ```
    24  
    25  ## Example Referencing
    26  
    27  ```
    28  data "terraform_remote_state" "foo" {
    29  	backend = "consul"
    30  	config {
    31  		path = "full/path"
    32  	}
    33  }
    34  ```
    35  
    36  ## Configuration variables
    37  
    38  The following configuration options / environment variables are supported:
    39  
    40   * `path` - (Required) Path in the Consul KV store
    41   * `access_token` / `CONSUL_HTTP_TOKEN` - (Required) Access token
    42   * `address` / `CONSUL_HTTP_ADDR` - (Optional) DNS name and port of your Consul endpoint specified in the
    43     format `dnsname:port`. Defaults to the local agent HTTP listener.
    44   * `scheme` - (Optional) Specifies what protocol to use when talking to the given
    45     `address`, either `http` or `https`. SSL support can also be triggered
    46     by setting then environment variable `CONSUL_HTTP_SSL` to `true`.
    47   * `datacenter` - (Optional) The datacenter to use. Defaults to that of the agent.
    48   * `http_auth` / `CONSUL_HTTP_AUTH` - (Optional) HTTP Basic Authentication credentials to be used when
    49     communicating with Consul, in the format of either `user` or `user:pass`.