mirror of https://github.com/opentffoundation/opentf.git synced 2026-02-19 07:01:10 -05:00

Files

Nick Fagerlund 8cfcd82be3 website: Language: Remove several ghost pages, update links

During the language/CLI docs reorg, we noticed several pages that were no longer
viable; some were redundant, some useless, and some just very obsolete.

Since we were trying to avoid breaking links at the time, we opted to remove
them from the navs and leave them as "ghost pages" — still accessible, but not
findable.

This commit finally cleans these ghosts up and updates any remaining links to
relevant modern pages. Bustin' makes me feel good. 👻🚫

2021-01-22 12:22:21 -08:00

2.4 KiB

Raw Blame History

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
language	Backend Type: consul	docs-backends-types-standard-consul	Terraform can store state in Consul.

consul

Kind: Standard (with locking)

Stores the state in the Consul KV store at a given path.

This backend supports state locking.

Example Configuration

terraform {
  backend "consul" {
    address = "consul.example.com"
    scheme  = "https"
    path    = "full/path"
  }
}

Note that for the access credentials we recommend using a partial configuration.

Data Source Configuration

data "terraform_remote_state" "foo" {
  backend = "consul"
  config = {
    path = "full/path"
  }
}

Configuration variables

The following configuration options / environment variables are supported:

path - (Required) Path in the Consul KV store
access_token / CONSUL_HTTP_TOKEN - (Required) Access token
address / CONSUL_HTTP_ADDR - (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. Defaults to the local agent HTTP listener.
scheme - (Optional) Specifies what protocol to use when talking to the given address, either http or https. SSL support can also be triggered by setting then environment variable CONSUL_HTTP_SSL to true.
datacenter - (Optional) The datacenter to use. Defaults to that of the agent.
http_auth / CONSUL_HTTP_AUTH - (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
gzip - (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
lock - (Optional) false to disable locking. This defaults to true, but will require session permissions with Consul and at least kv write permissions on $path/.lock to perform locking.
ca_file / CONSUL_CACERT - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
cert_file / CONSUL_CLIENT_CERT - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of key_file.
key_file / CONSUL_CLIENT_KEY - (Optional) A path to a PEM-encoded private key, required if cert_file is specified.

2.4 KiB Raw Blame History

consul

Example Configuration

Data Source Configuration

Configuration variables

2.4 KiB

Raw Blame History