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.
1.9 KiB
| layout | page_title | sidebar_current |
|---|---|---|
| docs | Commands: KV | docs-commands-kv |
Consul KV
Command: consul kv
The kv command is used to interact with Consul's key-value store via the
command line. It exposes top-level commands for inserting, updating, reading,
and deleting from the store. This command is available in Consul 0.7.1 and
later.
The key-value store is also accessible via the HTTP API.
Usage
Usage: consul kv <subcommand>
For the exact documentation for your Consul version, run consul kv -h to view
the complete list of subcommands.
Usage: consul kv <subcommand> [options] [args]
# ...
Subcommands:
delete Removes data from the KV store
get Retrieves or lists data from the KV store
put Sets or updates data in the KV store
For more information, examples, and usage about a subcommand, click on the name of the subcommand in the sidebar or one of the links below:
Basic Examples
To create or update the key named "redis/config/connections" to the value "5" in Consul's key-value store:
$ consul kv put redis/config/connections 5
Success! Data written to: redis/config/connections
To read a value back from Consul:
$ consul kv get redis/config/connections
5
Or you can query for detailed information:
$ consul kv get -detailed redis/config/connections
CreateIndex 336
Flags 0
Key redis/config/connections
LockIndex 0
ModifyIndex 336
Session -
Value 5
Finally, deleting a key is just as easy:
$ consul kv delete redis/config/connections
Success! Data deleted at key: redis/config/connections
For more examples, ask for subcommand help or view the subcommand documentation by clicking on one of the links in the sidebar.