mirror of https://github.com/opentffoundation/opentf.git synced 2026-02-18 04:01:08 -05:00

Files

Chris Arcand f521ba6cd7 Remove 'enhanced' backend type distinction

As explained in the changes: The 'enhanced' backend terminology, which
only truly pertains to the 'remote' backend with a single API (Terraform
Cloud/Enterprise's), has been found to be a confusing vestige which need
only be explained in the context of the 'remote' backend.

These changes reorient the explanation(s) of backends to pertain more
directly to their primary purpose, which is storage of state snapshots
(and not implementing operations).

That Terraform operations are still _implemented_ by the literal
`Backend` and `Enhanced` interfaces is inconsequential a user of
Terraform, an internal detail.

2021-12-07 16:29:51 -06: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

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