Files
opentf/website/docs/language/settings/backends/etcdv3.html.md
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

1.9 KiB

layout, page_title, sidebar_current, description
layout page_title sidebar_current description
language Backend Type: etcdv3 docs-backends-types-standard-etcdv3 Terraform can store state remotely in etcd 3.x.

etcdv3

Kind: Standard (with locking)

Stores the state in the etcd KV store with a given prefix.

This backend supports state locking.

Example Configuration

terraform {
  backend "etcdv3" {
    endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"]
    lock      = true
    prefix    = "terraform-state/"
  }
}

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

Data Source Configuration

data "terraform_remote_state" "foo" {
  backend = "etcdv3"
  config = {
    endpoints = ["etcd-1:2379", "etcd-2:2379", "etcd-3:2379"]
    lock      = true
    prefix    = "terraform-state/"
  }
}

Configuration variables

The following configuration options / environment variables are supported:

  • endpoints - (Required) The list of 'etcd' endpoints which to connect to.
  • username / ETCDV3_USERNAME - (Optional) Username used to connect to the etcd cluster.
  • password / ETCDV3_PASSWORD - (Optional) Password used to connect to the etcd cluster.
  • prefix - (Optional) An optional prefix to be added to keys when to storing state in etcd. Defaults to "".
  • lock - (Optional) Whether to lock state access. Defaults to true.
  • cacert_path - (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers.
  • cert_path - (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification.
  • key_path - (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification.