github.com/iqoqo/nomad@v0.11.3-0.20200911112621-d7021c74d101/website/pages/docs/commands/operator/index.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: operator'
     4  sidebar_title: operator
     5  description: |
     6    The operator command provides cluster-level tools for Nomad operators.
     7  ---
     8  
     9  # Command: operator
    10  
    11  The `operator` command provides cluster-level tools for Nomad operators, such
    12  as interacting with the Raft subsystem. This was added in Nomad 0.5.5.
    13  
    14  ~> Use this command with extreme caution, as improper use could lead to a Nomad
    15  outage and even loss of data.
    16  
    17  See the [Outage Recovery guide] guide for some examples of how this command is
    18  used. For an API to perform these operations programmatically, please see the
    19  documentation for the [Operator] endpoint.
    20  
    21  ## Usage
    22  
    23  Usage: `nomad operator <subcommand> <subcommand> [options]`
    24  
    25  Run `nomad operator <subcommand>` with no arguments for help on that subcommand.
    26  The following subcommands are available:
    27  
    28  - [`operator autopilot get-config`][get-config] - Display the current Autopilot
    29    configuration
    30  
    31  - [`operator autopilot set-config`][set-config] - Modify the current Autopilot
    32    configuration
    33  
    34  - [`operator keygen`][keygen] - Generates a new encryption key
    35  
    36  - [`operator keyring`][keyring] - Manages gossip layer encryption keys
    37  
    38  - [`operator raft list-peers`][list] - Display the current Raft peer
    39    configuration
    40  
    41  - [`operator raft remove-peer`][remove] - Remove a Nomad server from the Raft
    42    configuration
    43  
    44  [get-config]: /docs/commands/operator/autopilot-get-config 'Autopilot Get Config command'
    45  [keygen]: /docs/commands/operator/keygen 'Generates a new encryption key'
    46  [keyring]: /docs/commands/operator/keyring 'Manages gossip layer encryption keys'
    47  [list]: /docs/commands/operator/raft-list-peers 'Raft List Peers command'
    48  [operator]: /api-docs/operator 'Operator API documentation'
    49  [outage recovery guide]: https://learn.hashicorp.com/nomad/operating-nomad/outage
    50  [remove]: /docs/commands/operator/raft-remove-peer 'Raft Remove Peer command'
    51  [set-config]: /docs/commands/operator/autopilot-set-config 'Autopilot Set Config command'