github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/operator/keyring.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: operator keyring'
     4  ---
     5  
     6  # Command: operator keyring
     7  
     8  ~> **Warning:** This command is deprecated and will be removed in
     9     Nomad 1.5.0. Use the `nomad operator gossip keyring` subcommands
    10     instead.
    11  
    12  The `operator keyring` command is used to examine and modify the encryption keys
    13  used in Nomad server. It is capable of distributing new encryption keys to the
    14  cluster, retiring old encryption keys, and changing the keys used by the cluster
    15  to encrypt messages.
    16  
    17  Nomad allows multiple encryption keys to be in use simultaneously. This is
    18  intended to provide a transition state while the cluster converges. It is the
    19  responsibility of the operator to ensure that only the required encryption keys
    20  are installed on the cluster. You can review the installed keys using the
    21  `-list` argument, and remove unneeded keys with `-remove`.
    22  
    23  All operations performed by this command can only be run against server nodes
    24  and will effect the entire cluster.
    25  
    26  All variations of the `keyring` command return 0 if all nodes reply and there
    27  are no errors. If any node fails to reply or reports failure, the exit code
    28  will be 1.
    29  
    30  If ACLs are enabled, this command requires a token with the `agent:write`
    31  capability.
    32  
    33  ## Usage
    34  
    35  ```plaintext
    36  nomad operator keyring [options]
    37  ```
    38  
    39  Only one actionable argument may be specified per run, including `-list`,
    40  `-install`, `-remove`, and `-use`.
    41  
    42  ## General Options
    43  
    44  @include 'general_options_no_namespace.mdx'
    45  
    46  The list of available flags are:
    47  
    48  - `-list` - List all keys currently in use within the cluster.
    49  
    50  - `-install` - Install a new encryption key. This will broadcast the new key to
    51    all members in the cluster.
    52  
    53  - `-use` - Change the primary encryption key, which is used to encrypt messages.
    54    The key must already be installed before this operation can succeed.
    55  
    56  - `-remove` - Remove the given key from the cluster. This operation may only be
    57    performed on keys which are not currently the primary key.
    58  
    59  ## Output
    60  
    61  The output of the `nomad operator keyring -list` command consolidates
    62  information from all the Nomad servers from all datacenters and regions to
    63  provide a simple and easy to understand view of the cluster.
    64  
    65  ```shell-session
    66  $ nomad operator keyring -list
    67  ==> Gathering installed encryption keys...
    68  Key
    69  PGm64/neoebUBqYR/lZTbA==
    70  ```