From cea2b49c15389a254855f7f8956f5e3ef71822bf Mon Sep 17 00:00:00 2001 From: Ryan Uber Date: Thu, 11 Sep 2014 11:34:58 -0700 Subject: [PATCH] website: update consul keys documentation --- website/source/docs/agent/options.html.markdown | 7 +++++++ website/source/docs/commands/keys.html.markdown | 5 +++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index 01149ef590..2a60a4309c 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -85,10 +85,17 @@ The options below are all specified on the command-line. it relies on proper configuration. Nodes in the same datacenter should be on a single LAN. +* `-persist-keyring` - This flag enables persistence of changes to the + encryption keys used in the gossip pools. By default, any modifications to + the keyring via the [consul keys](/docs/command/keys.html) command will be + lost when the agent shuts down. + * `-encrypt` - Specifies the secret key to use for encryption of Consul network traffic. This key must be 16-bytes that are base64 encoded. The easiest way to create an encryption key is to use `consul keygen`. All nodes within a cluster must share the same encryption key to communicate. + If keyring persistence is enabled, the given key will only be used if there is + no pre-existing keyring. Otherwise, Consul will emit a warning and continue. * `-join` - Address of another agent to join upon starting up. This can be specified multiple times to specify multiple agents to join. If Consul is diff --git a/website/source/docs/commands/keys.html.markdown b/website/source/docs/commands/keys.html.markdown index 785025b348..beb9f38945 100644 --- a/website/source/docs/commands/keys.html.markdown +++ b/website/source/docs/commands/keys.html.markdown @@ -23,8 +23,9 @@ responsibility of the operator to ensure that only the required encryption keys are installed on the cluster. You can ensure that a key is not installed using the `-list` and `-remove` options. -By default, modifications made using this command will be persisted in the -Consul agent's data directory. This functionality can be altered via the +By default, modifications made using this command will **NOT** be persisted, and +will be lost when the agent shuts down. You can alter this behavior via the +`-persist-keyring` option in the [Agent Configuration](/docs/agent/options.html). All variations of the keys command will return 0 if all nodes reply and there