Skip to content

Latest commit

 

History

History
147 lines (113 loc) · 3.75 KB

README.md

File metadata and controls

147 lines (113 loc) · 3.75 KB
Raw

Vault-utils

Yet Another Utility for Vault. Actions supported:

  • Copy from one Vault to another
  • Backup from one Vault to tar.gz
  • Restore from tar.gz to Vault

Documentation

Copy

This can used for copy the kv data from one Vault to another:

Usage:
  vault-utils copy [flags]

Flags:
  -d, --dstaddr string     Destination vault address to write to
  -f, --dstengine string   Destination vault kv engines to write to
  -k, --dsttoken string    Destination vault token to write to
  -z, --engineinpath       Add the name of the engine in the copied Path
  -h, --help               help for copy

Global Flags:
  -s, --addr string     Vault address
  -c, --config string   config file (default is $HOME/.vault-utils.yaml)
  -e, --engine string   Vault kv comma separated engine names
  -t, --token string    Vault token
  -v, --verbose         verbosity

Example:

./vault-utils copy --addr "http://127.0.0.1:8200" --token "someToken" --engine "kv,secret" --dstaddr "http://127.0.0.1:8202" --dsttoken "someToken" --dstengine "secret" -v
2023/05/29 20:07:51 No config file found! Counting on flags!
Using config:
--- Configuration ---
	token = someToken
	dsttoken = someToken
	engine = kv,secret
	dstengine = secret
	verbose = %!s(bool=true)
	addr = http://127.0.0.1:8200
	dstaddr = http://127.0.0.1:8202
---
2023/05/29 20:07:51 writing secret: secret//ss/ss
2023/05/29 20:07:51 secret key was written successfully
2023/05/29 20:07:51 writing secret: secret//tt/tt
2023/05/29 20:07:51 secret key was written successfully
2023/05/29 20:07:51 Job Finished!

Instead of flags, it is possible to use the config file:

./vault-utils copy -c config.yaml

Backup

This can used for copy the kv data from one Vault to another:

Usage:
  vault-utils backup [flags]

Flags:
  -f, --backup string   Backup file path
  -h, --help            help for backup

Global Flags:
  -s, --addr string     Vault address
  -c, --config string   config file (default is $HOME/.vault-utils.yaml)
  -e, --engine string   Vault kv comma separated engine names
  -t, --token string    Vault token
  -v, --verbose         verbosity

Example:

./vault-utils backup --addr "http://127.0.0.1:8200" --token "someToken" -f some.tar.gz -v
2023/05/29 20:07:51 No config file found! Counting on flags!
2023/05/29 20:07:51 Job Finished!

Instead of flags, it is possible to use the config file:

./vault-utils backup -c config.yaml

Restore

This can used for copy the kv data from one Vault to another:

Usage:
  vault-utils restore [flags]

Flags:
  -f, --backup string   Backup file path
  -h, --help            help for restore

Global Flags:
  -s, --addr string     Vault address
  -c, --config string   config file (default is $HOME/.vault-utils.yaml)
  -e, --engine string   Vault kv comma separated engine names
  -t, --token string    Vault token
  -v, --verbose         verbosity

Example:

./vault-utils restore --addr "http://127.0.0.1:8200" --token "someToken" -f some.tar.gz -v
2023/05/29 20:07:51 No config file found! Counting on flags!
2023/05/29 20:07:51 Job Finished!

Instead of flags, it is possible to use the config file:

./vault-utils restore -c config.yaml

Installation

From the release page, find the version suitable for your env, and run it shell.

  ./vault-utils

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Acknowledgements

This couldn't work without