open-nomad/command/operator_raft.go
Tim Gross f2615992a4
cli: unhide advanced operator raft debugging commands (#11682)
The `nomad operator raft` and `nomad operator snapshot state`
subcommands for inspecting on-disk raft state were hidden and
undocumented. Expose and document these so that advanced operators
have support for these tools.
2021-12-16 10:32:11 -05:00

58 lines
1.3 KiB
Go

package command
import (
"strings"
"github.com/mitchellh/cli"
)
type OperatorRaftCommand struct {
Meta
}
func (c *OperatorRaftCommand) Help() string {
helpText := `
Usage: nomad operator raft <subcommand> [options]
This command groups subcommands for interacting with Nomad's Raft subsystem.
The command can be used to verify Raft peers or in rare cases to recover
quorum by removing invalid peers.
List Raft peers:
$ nomad operator raft list-peers
Remove a Raft peer:
$ nomad operator raft remove-peer -peer-address "IP:Port"
Display info about the raft logs in the data directory:
$ nomad operator raft info /var/nomad/data
Display the log entries persisted in data dir in JSON format.
$ nomad operator raft logs /var/nomad/data
Display the server state obtained by replaying raft log entries
persisted in data dir in JSON format.
$ nomad operator raft state /var/nomad/data
Please see the individual subcommand help for detailed usage information.
`
return strings.TrimSpace(helpText)
}
func (c *OperatorRaftCommand) Synopsis() string {
return "Provides access to the Raft subsystem"
}
func (c *OperatorRaftCommand) Name() string { return "operator raft" }
func (c *OperatorRaftCommand) Run(args []string) int {
return cli.RunResultHelp
}