bc29610124
* Updates Raft library to get new snapshot/restore API. * Basic backup and restore working, but need some cleanup. * Breaks out a snapshot module and adds a SHA256 integrity check. * Adds snapshot ACL and fills in some missing comments. * Require a consistent read for snapshots. * Make sure snapshot works if ACLs aren't enabled. * Adds a bit of package documentation. * Returns an empty response from restore to avoid EOF errors. * Adds API client support for snapshots. * Makes internal file names match on-disk file snapshots. * Adds DC and token coverage for snapshot API test. * Adds missing documentation. * Adds a unit test for the snapshot client endpoint. * Moves the connection pool out of the client for easier testing. * Fixes an incidental issue in the prepared query unit test. I realized I had two servers in bootstrap mode so this wasn't a good setup. * Adds a half close to the TCP stream and fixes panic on error. * Adds client and endpoint tests for snapshots. * Moves the pool back into the snapshot RPC client. * Adds a TLS test and fixes half-closes for TLS connections. * Tweaks some comments. * Adds a low-level snapshot test. This is independent of Consul so we can pull this out into a library later if we want to. * Cleans up snapshot and archive and completes archive tests. * Sends a clear error for snapshot operations in dev mode. Snapshots require the Raft snapshots to be readable, which isn't supported in dev mode. Send a clear error instead of a deep-down Raft one. * Adds docs for the snapshot endpoint. * Adds a stale mode and index feedback for snapshot saves. This gives folks a way to extract data even if the cluster has no leader. * Changes the internal format of a snapshot from zip to tgz. * Pulls in Raft fix to cancel inflight before a restore. * Pulls in new Raft restore interface. * Adds metadata to snapshot saves and a verify function. * Adds basic save and restore snapshot CLI commands. * Gets rid of tarball extensions and adds restore message. * Fixes an incidental bad link in the KV docs. * Adds documentation for the snapshot CLI commands. * Scuttle any request body when a snapshot is saved. * Fixes archive unit test error message check. * Allows for nil output writers in snapshot RPC handlers. * Renames hash list Decode to DecodeAndVerify. * Closes the client connection for snapshot ops. * Lowers timeout for restore ops. * Updates Raft vendor to get new Restore signature and integrates with Consul. * Bounces the leader's internal state when we do a restore.
104 lines
2.5 KiB
Go
104 lines
2.5 KiB
Go
package command
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/consul/api"
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
// SnapshotRestoreCommand is a Command implementation that is used to restore
|
|
// the state of the Consul servers for disaster recovery.
|
|
type SnapshotRestoreCommand struct {
|
|
Ui cli.Ui
|
|
}
|
|
|
|
func (c *SnapshotRestoreCommand) Help() string {
|
|
helpText := `
|
|
Usage: consul snapshot restore [options] FILE
|
|
|
|
Restores an atomic, point-in-time snapshot of the state of the Consul servers
|
|
which includes key/value entries, service catalog, prepared queries, sessions,
|
|
and ACLs.
|
|
|
|
Restores involve a potentially dangerous low-level Raft operation that is not
|
|
designed to handle server failures during a restore. This command is primarily
|
|
intended to be used when recovering from a disaster, restoring into a fresh
|
|
cluster of Consul servers.
|
|
|
|
If ACLs are enabled, a management token must be supplied in order to perform
|
|
snapshot operations.
|
|
|
|
To restore a snapshot from the file "backup.snap":
|
|
|
|
$ consul snapshot restore backup.snap
|
|
|
|
For a full list of options and examples, please see the Consul documentation.
|
|
|
|
` + apiOptsText
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *SnapshotRestoreCommand) Run(args []string) int {
|
|
cmdFlags := flag.NewFlagSet("get", flag.ContinueOnError)
|
|
cmdFlags.Usage = func() { c.Ui.Output(c.Help()) }
|
|
datacenter := cmdFlags.String("datacenter", "", "")
|
|
token := cmdFlags.String("token", "", "")
|
|
httpAddr := HTTPAddrFlag(cmdFlags)
|
|
if err := cmdFlags.Parse(args); err != nil {
|
|
return 1
|
|
}
|
|
|
|
var file string
|
|
|
|
args = cmdFlags.Args()
|
|
switch len(args) {
|
|
case 0:
|
|
c.Ui.Error("Missing FILE argument")
|
|
return 1
|
|
case 1:
|
|
file = args[0]
|
|
default:
|
|
c.Ui.Error(fmt.Sprintf("Too many arguments (expected 1, got %d)", len(args)))
|
|
return 1
|
|
}
|
|
|
|
// Create and test the HTTP client
|
|
conf := api.DefaultConfig()
|
|
conf.Address = *httpAddr
|
|
conf.Token = *token
|
|
client, err := api.NewClient(conf)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error connecting to Consul agent: %s", err))
|
|
return 1
|
|
}
|
|
|
|
// Open the file.
|
|
f, err := os.Open(file)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error opening snapshot file: %s", err))
|
|
return 1
|
|
}
|
|
defer f.Close()
|
|
|
|
// Restore the snapshot.
|
|
err = client.Snapshot().Restore(&api.WriteOptions{
|
|
Datacenter: *datacenter,
|
|
}, f)
|
|
if err != nil {
|
|
c.Ui.Error(fmt.Sprintf("Error restoring snapshot: %s", err))
|
|
return 1
|
|
}
|
|
|
|
c.Ui.Info("Restored snapshot")
|
|
return 0
|
|
}
|
|
|
|
func (c *SnapshotRestoreCommand) Synopsis() string {
|
|
return "Restores snapshot of Consul server state"
|
|
}
|