github.com/smintz/nomad@v0.8.3/website/source/docs/commands/operator/keyring.html.md.erb (about) 1 --- 2 layout: "docs" 3 page_title: "Commands: operator keyring" 4 sidebar_current: "docs-commands-operator-keyring" 5 --- 6 7 # Command: operator keyring 8 9 The `operator keyring` command is used to examine and modify the encryption keys 10 used in Nomad server. It is capable of distributing new encryption keys to the 11 cluster, retiring old encryption keys, and changing the keys used by the cluster 12 to encrypt messages. 13 14 Nomad allows multiple encryption keys to be in use simultaneously. This is 15 intended to provide a transition state while the cluster converges. It is the 16 responsibility of the operator to ensure that only the required encryption keys 17 are installed on the cluster. You can review the installed keys using the 18 `-list` argument, and remove unneeded keys with `-remove`. 19 20 All operations performed by this command can only be run against server nodes 21 and will effect the entire cluster. 22 23 All variations of the `keyring` command return 0 if all nodes reply and there 24 are no errors. If any node fails to reply or reports failure, the exit code 25 will be 1. 26 27 28 ## Usage 29 30 Usage: `nomad operator keyring [options]` 31 32 Only one actionable argument may be specified per run, including `-list`, 33 `-install`, `-remove`, and `-use`. 34 35 The list of available flags are: 36 37 * `-list` - List all keys currently in use within the cluster. 38 39 * `-install` - Install a new encryption key. This will broadcast the new key to 40 all members in the cluster. 41 42 * `-use` - Change the primary encryption key, which is used to encrypt messages. 43 The key must already be installed before this operation can succeed. 44 45 * `-remove` - Remove the given key from the cluster. This operation may only be 46 performed on keys which are not currently the primary key. 47 48 ## Output 49 50 The output of the `nomad operator keyring -list` command consolidates information from 51 all the Nomad servers from all datacenters and regions to provide a simple and 52 easy to understand view of the cluster. 53 54 ``` 55 ==> Gathering installed encryption keys... 56 Key 57 PGm64/neoebUBqYR/lZTbA== 58 ```