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

47 lines
1.0 KiB
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
---
docs: update structure (#8506) - moved and renamed files/folders based on new structure - updated docs navigation based on new structure - moved CLI to top nav (created commands.jsx and commands-navigation.js) - updated and added redirects - updating to be consistent with standalone categories - changing "overview" link in top nav to lead to where intro was moved (docs/intro) - adding redirects for intro content - deleting old intro folders - format all data/navigation files - deleting old commands folder - reverting changes to glossary page - adjust intro navigation for removal of 'vs' paths - add helm page redirect - fix more redirects - add a missing redirect - fix broken anchor links and formatting mistakes - deleted duplicate section, added redirect, changed link - removed duplicate glossary page
2020-09-01 15:14:13 +00:00
layout: commands
intro and api navigation converted
2020-04-07 18:55:19 +00:00
page_title: 'Commands: KV 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.
website: content updates for developer (#14419) Co-authored-by: Ashlee Boyer <ashlee.boyer@hashicorp.com> Co-authored-by: Ashlee M Boyer <43934258+ashleemboyer@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@gmail.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com> Co-authored-by: Kevin Wang <kwangsan@gmail.com>
2022-09-14 22:45:42 +00:00
The table below shows this command's [required ACLs](/api-docs#authentication). Configuration of
website: redirect /api to /api-docs (#12660)
2022-03-30 21:16:26 +00:00
[blocking queries](/api-docs/features/blocking) and [agent caching](/api-docs/features/caching)
Added some missing ACL info, updated details around some permissions, added missing HTTP API refs
2022-01-11 14:41:54 +00:00
are not supported from commands, but may be from the corresponding HTTP endpoint.
| ACL Required |
| ------------ |
| `key:read` |
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
## 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
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
#### Enterprise Options
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
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
@include 'http_api_partition_options.mdx'
docs rendering
2020-04-07 23:56:08 +00:00
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
@include 'http_api_namespace_options.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
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
#### API Options
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
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
@include 'http_api_options_client.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
docs: show CLI cmd-specific opts before general opts Applied to all remaining CLI commands.
2022-07-27 06:17:11 +00:00
@include 'http_api_options_server.mdx'
Website fixups for admin partitions (#11842) * Website fixups for admin partitions Signed-off-by: Mark Anderson <manderson@hashicorp.com>
2021-12-15 01:55:21 +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
```