From 28b2e9764be8a4cff7a9b5827f812e8023f854c4 Mon Sep 17 00:00:00 2001 From: Graham Land Date: Thu, 18 Oct 2018 13:18:08 +0100 Subject: [PATCH] Prerequisite of consul agent on terraform node for state locking to work. Debugged state locking issue with customer - customer presumed consul agent wasn't required as this page doesn't mention that fact. Without the agent Consul backend can be used but state locking is not possible. --- website/docs/backends/types/consul.html.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/docs/backends/types/consul.html.md b/website/docs/backends/types/consul.html.md index 79d726fb97..48c773f7e9 100644 --- a/website/docs/backends/types/consul.html.md +++ b/website/docs/backends/types/consul.html.md @@ -14,6 +14,8 @@ Stores the state in the [Consul](https://www.consul.io/) KV store at a given pat This backend supports [state locking](/docs/state/locking.html). +__Note:__ Consul agent must be installed on the node running terraform for [sessions](https://www.consul.io/docs/internals/sessions.html) and session locking to work. + ## Example Configuration ```hcl @@ -59,3 +61,4 @@ The following configuration options / environment variables are supported: * `ca_file` / `CONSUL_CAFILE` - (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. +