vault/command/operator_raft.go
Brian Kassouf ccb0dd7c05
Rename raft configuration command to list-peers and make output easier to read (#8484)
* Make the output of raft configuration easier to read

* Rename raft configuration sub command to list-peers

* Update command/operator_raft_listpeers.go

Co-Authored-By: Calvin Leung Huang <cleung2010@gmail.com>

Co-authored-by: Calvin Leung Huang <cleung2010@gmail.com>
2020-03-06 14:40:50 -08:00

52 lines
1.1 KiB
Go

package command
import (
"strings"
"github.com/mitchellh/cli"
)
var _ cli.Command = (*OperatorRaftCommand)(nil)
type OperatorRaftCommand struct {
*BaseCommand
}
func (c *OperatorRaftCommand) Synopsis() string {
return "Interact with Vault's raft storage backend"
}
func (c *OperatorRaftCommand) Help() string {
helpText := `
Usage: vault operator raft <subcommand> [options] [args]
This command groups subcommands for operators interacting with the Vault raft storage backend. Most
users will not need to interact with these commands. Here are a few examples
of the raft operator commands:
Joins a node to the raft cluster:
$ vault operator raft join https://127.0.0.1:8200
Returns the set of raft peers:
$ vault operator raft list-peers
Removes a node from the raft cluster:
$ vault operator raft remove-peer
Restores and saves snapshots from the raft cluster:
$ vault operator raft snapshot take out.snap
Please see the individual subcommand help for detailed usage information.
`
return strings.TrimSpace(helpText)
}
func (c *OperatorRaftCommand) Run(args []string) int {
return cli.RunResultHelp
}