website: update consul keys documentation

pull/336/head
Ryan Uber 10 years ago
parent 6b41e98964
commit cea2b49c15

@ -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 it relies on proper configuration. Nodes in the same datacenter should be on a single
LAN. 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 * `-encrypt` - Specifies the secret key to use for encryption of Consul
network traffic. This key must be 16-bytes that are base64 encoded. The 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 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. 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 * `-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 specified multiple times to specify multiple agents to join. If Consul is

@ -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 are installed on the cluster. You can ensure that a key is not installed using
the `-list` and `-remove` options. the `-list` and `-remove` options.
By default, modifications made using this command will be persisted in the By default, modifications made using this command will **NOT** be persisted, and
Consul agent's data directory. This functionality can be altered via the 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). [Agent Configuration](/docs/agent/options.html).
All variations of the keys command will return 0 if all nodes reply and there All variations of the keys command will return 0 if all nodes reply and there

Loading…
Cancel
Save