From 619dd143b6ed69821a93053c0620261efcb29609 Mon Sep 17 00:00:00 2001 From: Tom Morelly Date: Thu, 26 Oct 2023 13:26:49 +0200 Subject: [PATCH] docs(README): update docs --- docs/05_export/index.md | 6 ++++-- docs/06_import/index.md | 4 +++- docs/07_snapshot/restore.md | 2 ++ docs/07_snapshot/save.md | 4 +++- docs/08_namespaces/index.md | 2 ++ docs/09_engines/index.md | 4 +++- 6 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/05_export/index.md b/docs/05_export/index.md index 6d169d53..e09cce69 100644 --- a/docs/05_export/index.md +++ b/docs/05_export/index.md @@ -1,3 +1,5 @@ +## vkv export + recursively list secrets from Vaults KV2 engine in various formats ``` @@ -8,8 +10,8 @@ vkv export [flags] ``` -p, --path string KVv2 Engine path (env: VKV_EXPORT_PATH) - -e, --engine-path string Specify the engine path using this flag in case your kv-engine contains special characters such as "/". - vkv will then append the values of the path-flag to the engine path, if specified (/)(env: VKV_EXPORT_ENGINE_PATH) + -e, --engine-path string engine path in case your KV-engine contains special characters such as "/", the path value will then be appended if specified ("/") (env: VKV_EXPORT_ENGINE_PATH) + --skip-errors dont exit on errors (permission denied, deleted secrets) --only-keys show only keys (env: VKV_EXPORT_ONLY_KEYS) --only-paths show only paths (env: VKV_EXPORT_ONLY_PATHS) --show-version show the secret version (env: VKV_EXPORT_VERSION) (default true) diff --git a/docs/06_import/index.md b/docs/06_import/index.md index bc0c8465..6a01f786 100644 --- a/docs/06_import/index.md +++ b/docs/06_import/index.md @@ -1,3 +1,6 @@ +# Import + +## vkv import import secrets from vkv's json or yaml output @@ -18,7 +21,6 @@ vkv import [flags] -s, --silent do not output secrets (env: VKV_IMPORT_SILENT) ``` - # read secrets from STDIN The `-` in `vkv import -`, tells `vkv` do read data via STDIN. The idea of `vkv import -` is, in order to copy/mirror KV-v2 secrets or complete engines across diferrent Vault Servers or Namespaces, you can simply pipe diff --git a/docs/07_snapshot/restore.md b/docs/07_snapshot/restore.md index fdab2470..d2c5aa08 100644 --- a/docs/07_snapshot/restore.md +++ b/docs/07_snapshot/restore.md @@ -1,3 +1,5 @@ +## vkv snapshot restore + restore the KV engines defined in the specified snapshot ``` diff --git a/docs/07_snapshot/save.md b/docs/07_snapshot/save.md index c1938feb..ca0d1a64 100644 --- a/docs/07_snapshot/save.md +++ b/docs/07_snapshot/save.md @@ -1,3 +1,5 @@ +## vkv snapshot save + create a snapshot of all visible KV engines recursively for all namespaces ``` @@ -9,5 +11,5 @@ vkv snapshot save [flags] ``` -d, --destination string vkv snapshot destination path (env: VKV_SNAPSHOT_SAVE_DESTINATION) (default "./vkv-snapshot-export") -h, --help help for save - -n, --namespace string namespaces from which to save recursively all visible KV engines (env: VKV_SNAPSHOT_SAVE_NS + -n, --namespace string namespaces from which to save recursively all visible KV engines (env: VKV_SNAPSHOT_SAVE_NS) ``` \ No newline at end of file diff --git a/docs/08_namespaces/index.md b/docs/08_namespaces/index.md index 26faec2a..82c23cb6 100644 --- a/docs/08_namespaces/index.md +++ b/docs/08_namespaces/index.md @@ -1,3 +1,5 @@ +## vkv list namespaces + list all namespaces ``` diff --git a/docs/09_engines/index.md b/docs/09_engines/index.md index 0319933c..db78dfbd 100644 --- a/docs/09_engines/index.md +++ b/docs/09_engines/index.md @@ -1,3 +1,5 @@ +## vkv list engines + list all KVv2 engines ``` @@ -13,4 +15,4 @@ vkv list engines [flags] -a, --all list all KV engines recursively from the specified namespaces (env: VKV_LIST_ENGINES_ALL) -f, --format string available output formats: "base", "json", "yaml" (env: VKV_LIST_ENGINES_FORMAT) (default "base") -h, --help help for engines -``` +``` \ No newline at end of file