mirror of
https://github.com/kemko/nomad.git
synced 2026-01-04 01:15:43 +03:00
0c359d1a21
* changed list indicator from * -> - * moved in-text links to reference links * made commands `plaintext` * made command examples `console` * rewrapped text
52 lines
2.0 KiB
Markdown
52 lines
2.0 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "Commands: operator"
|
|
sidebar_current: "docs-commands-operator"
|
|
description: >
|
|
The operator command provides cluster-level tools for Nomad operators.
|
|
---
|
|
|
|
# Command: operator
|
|
|
|
The `operator` command provides cluster-level tools for Nomad operators, such
|
|
as interacting with the Raft subsystem. This was added in Nomad 0.5.5.
|
|
|
|
~> Use this command with extreme caution, as improper use could lead to a Nomad
|
|
outage and even loss of data.
|
|
|
|
See the [Outage Recovery guide] guide for some examples of how this command is
|
|
used. For an API to perform these operations programmatically, please see the
|
|
documentation for the [Operator] endpoint.
|
|
|
|
## Usage
|
|
|
|
Usage: `nomad operator <subcommand> <subcommand> [options]`
|
|
|
|
Run `nomad operator <subcommand>` with no arguments for help on that subcommand.
|
|
The following subcommands are available:
|
|
|
|
- [`operator autopilot get-config`][get-config] - Display the current Autopilot
|
|
configuration
|
|
|
|
- [`operator autopilot set-config`][set-config] - Modify the current Autopilot
|
|
configuration
|
|
|
|
- [`operator keygen`][keygen] - Generates a new encryption key
|
|
|
|
- [`operator keyring`][keyring] - Manages gossip layer encryption keys
|
|
|
|
- [`operator raft list-peers`][list] - Display the current Raft peer
|
|
configuration
|
|
|
|
- [`operator raft remove-peer`][remove] - Remove a Nomad server from the Raft
|
|
configuration
|
|
|
|
[get-config]: /docs/commands/operator/autopilot-get-config.html "Autopilot Get Config command"
|
|
[keygen]: /docs/commands/operator/keygen.html "Generates a new encryption key"
|
|
[keyring]: /docs/commands/operator/keyring.html "Manages gossip layer encryption keys"
|
|
[list]: /docs/commands/operator/raft-list-peers.html "Raft List Peers command"
|
|
[Operator]: /api/operator.html "Operator API documentation"
|
|
[Outage Recovery guide]: /guides/operations/outage.html
|
|
[remove]: /docs/commands/operator/raft-remove-peer.html "Raft Remove Peer command"
|
|
[set-config]: /docs/commands/operator/autopilot-set-config.html "Autopilot Set Config command"
|