mirror of
https://github.com/status-im/consul.git
synced 2025-01-27 14:05:45 +00:00
c01a3871c9
* 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.
57 lines
1.5 KiB
Plaintext
57 lines
1.5 KiB
Plaintext
---
|
|
layout: "docs"
|
|
page_title: "Commands: Snapshot Save"
|
|
sidebar_current: "docs-commands-snapshot-save"
|
|
---
|
|
|
|
# Consul Snapshot Save
|
|
|
|
Command: `consul snapshot save`
|
|
|
|
The `snapshot save` command is used to retrieve 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. The snapshot is saved to
|
|
the given file.
|
|
|
|
If ACLs are enabled, a management token must be supplied in order to perform
|
|
snapshot a snapshot save.
|
|
|
|
## Usage
|
|
|
|
Usage: `consul snapshot save [options] FILE`
|
|
|
|
#### API Options
|
|
|
|
<%= partial "docs/commands/http_api_options" %>
|
|
|
|
## Examples
|
|
|
|
To create a snapshot from the leader server and save it to "backup.snap":
|
|
|
|
```text
|
|
$ consul snapshot save backup.snap
|
|
Saved and verified snapshot to index 8419
|
|
```
|
|
|
|
By default, snapshots are taken using a consistent mode that forwards requests
|
|
to the leader and the leader verifies it is still in power before taking the
|
|
snapshot.
|
|
|
|
After the snapshot is written to the given file it is read back and verified for
|
|
integrity.
|
|
|
|
To create a potentially stale snapshot from any available server, use the stale
|
|
consisentcy mode:
|
|
|
|
```text
|
|
$ consul snapshot save -stale backup.snap
|
|
# ...
|
|
```
|
|
|
|
This is useful for situations where a cluster is in a degraded state and no
|
|
leader is available. To target a specific server for a snapshot, you can run
|
|
the `consul snapshot save` command on that specific server.
|
|
|
|
Please see the [HTTP API](/docs/agent/http/snapshot.html) documentation for
|
|
more details about snapshot internals.
|