mirror of
https://github.com/status-im/consul.git
synced 2025-01-10 05:45:46 +00:00
a49711b8bf
This patch refactors the commands that use the mitchellh/cli library to populate the command line flag set in both the Run() and the Help() method. Earlier versions of the mitchellh/cli library relied on the Run() method to populuate the flagset for generating the usage screen. This has changed in later versions and was previously solved with a small monkey patch to the library to restore the old behavior. However, this makes upgrading the library difficult since the patch has to be restored every time. This patch addresses this by moving the command line flags into an initFlags() method where appropriate and also moving all variables for the flags from the Run() method into the command itself. Fixes #3536
52 lines
1.3 KiB
Go
52 lines
1.3 KiB
Go
package command
|
|
|
|
import (
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
// SnapshotCommand is a Command implementation that just shows help for
|
|
// the subcommands nested below it.
|
|
type SnapshotCommand struct {
|
|
UI cli.Ui
|
|
}
|
|
|
|
func (c *SnapshotCommand) Run(args []string) int {
|
|
return cli.RunResultHelp
|
|
}
|
|
|
|
func (c *SnapshotCommand) Help() string {
|
|
return `Usage: consul snapshot <subcommand> [options] [args]
|
|
|
|
This command has subcommands for saving, restoring, and inspecting the state
|
|
of the Consul servers for disaster recovery. These are atomic, point-in-time
|
|
snapshots which include key/value entries, service catalog, prepared queries,
|
|
sessions, and ACLs.
|
|
|
|
If ACLs are enabled, a management token must be supplied in order to perform
|
|
snapshot operations.
|
|
|
|
Create a snapshot:
|
|
|
|
$ consul snapshot save backup.snap
|
|
|
|
Restore a snapshot:
|
|
|
|
$ consul snapshot restore backup.snap
|
|
|
|
Inspect a snapshot:
|
|
|
|
$ consul snapshot inspect backup.snap
|
|
|
|
Run a daemon process that locally saves a snapshot every hour (available only in
|
|
Consul Enterprise) :
|
|
|
|
$ consul snapshot agent
|
|
|
|
For more examples, ask for subcommand help or view the documentation.
|
|
`
|
|
}
|
|
|
|
func (c *SnapshotCommand) Synopsis() string {
|
|
return "Saves, restores and inspects snapshots of Consul server state"
|
|
}
|