luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity
open-consul/website/pages/docs/commands/kv/export.mdx

38 lines
720 B
Plaintext
Raw Normal View History

cli: Add KV `export` and `import` This commit adds two new commands to the Consul KV CLI, which export and import a JSON formatted representation of the Consul KV tree. It is useful to migrate parts of the KV tree between unrelated Consul clusters, and could also be used for initial data population of the KV store.
2017-01-05 00:24:09 +00:00
---
intro and api navigation converted
2020-04-07 18:55:19 +00:00
layout: docs
page_title: 'Commands: KV Export'
remove 'sidebar_current' from frontmatter
2020-04-13 18:40:26 +00:00
sidebar_title: export
cli: Add KV `export` and `import` This commit adds two new commands to the Consul KV CLI, which export and import a JSON formatted representation of the Consul KV tree. It is useful to migrate parts of the KV tree between unrelated Consul clusters, and could also be used for initial data population of the KV store.
2017-01-05 00:24:09 +00:00
---
# Consul KV Export
Command: `consul kv export`
Update API docs
2017-04-04 16:33:22 +00:00
The `kv export` command is used to retrieve KV pairs for the given
prefix from Consul's KV store, and write a JSON representation to
cli: Add KV `export` and `import` This commit adds two new commands to the Consul KV CLI, which export and import a JSON formatted representation of the Consul KV tree. It is useful to migrate parts of the KV tree between unrelated Consul clusters, and could also be used for initial data population of the KV store.
2017-01-05 00:24:09 +00:00
stdout. This can be used with the command "consul kv import" to move entire
trees between Consul clusters.
## Usage
Update consul CLI docs for kv export and import This will make the kv docs consistent with get/delete/put
2018-11-07 01:14:12 +00:00
Usage: `consul kv export [options] [PREFIX]`
cli: Add KV `export` and `import` This commit adds two new commands to the Consul KV CLI, which export and import a JSON formatted representation of the Consul KV tree. It is useful to migrate parts of the KV tree between unrelated Consul clusters, and could also be used for initial data population of the KV store.
2017-01-05 00:24:09 +00:00
#### API Options
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
docs rendering
2020-04-07 23:56:08 +00:00
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_options_server.mdx'
cli: Add KV `export` and `import` This commit adds two new commands to the Consul KV CLI, which export and import a JSON formatted representation of the Consul KV tree. It is useful to migrate parts of the KV tree between unrelated Consul clusters, and could also be used for initial data population of the KV store.
2017-01-05 00:24:09 +00:00
Add Namespace support to the API module and the CLI commands (#6874) Also update the Docs and fixup the HTTP API to return proper errors when someone attempts to use Namespaces with an OSS agent. Add Namespace HTTP API docs Make all API endpoints disallow unknown fields
2019-12-06 16:14:56 +00:00
#### Enterprise Options
intro and api navigation converted
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
Add Namespace support to the API module and the CLI commands (#6874) Also update the Docs and fixup the HTTP API to return proper errors when someone attempts to use Namespaces with an OSS agent. Add Namespace HTTP API docs Make all API endpoints disallow unknown fields
2019-12-06 16:14:56 +00:00
cli: Add KV `export` and `import` This commit adds two new commands to the Consul KV CLI, which export and import a JSON formatted representation of the Consul KV tree. It is useful to migrate parts of the KV tree between unrelated Consul clusters, and could also be used for initial data population of the KV store.
2017-01-05 00:24:09 +00:00
## Examples
To export the tree at "vault/" in the key value store:
update dependencies
2020-05-19 18:32:38 +00:00
```shell-session
cli: Add KV `export` and `import` This commit adds two new commands to the Consul KV CLI, which export and import a JSON formatted representation of the Consul KV tree. It is useful to migrate parts of the KV tree between unrelated Consul clusters, and could also be used for initial data population of the KV store.
2017-01-05 00:24:09 +00:00
$ consul kv export vault/
# JSON output
```