Flexible Consul KV pair backup and restore tool with a few unique features including ACL token backup and restoration. This was written for and tested in a production environment.
There was a potentially breaking change in the operation of this tool on May 09, 2016 when the different operations were broken out into sub commands to simplify the flag listings. The functionality remains the same and previous backup files are not affected. However the command options and structure have changed and any scripts which embedded this tool will need to be updated.
- Written in Golang using the official Consul API
- No limits on the number of keys that can be backed up or restored
- Backup files are written as gzip compressed and AES256 encrypted JSON data
- Data integrity validation via HMAC-SHA256 signature of the raw data
- Optional path transformation (path replacement) on backup and/or restore
- Clean well documented code that's simple to follow
OS X/macOS Homebrew users ...
brew install consul-backinator
Users with a proper Go environment ...
go get -u github.com/myENA/consul-backinator
Developers that wish to take advantage of vendoring and other options ...
git clone https://github.com/myENA/consul-backinator.git
cd consul-backinator
make
To build as a Docker container ...
git clone https://github.com/myENA/consul-backinator.git
cd consul-backinator
make docker
See DOCKER.md for some Docker use cases.
ahurt$ ./consul-backinator --help
usage: consul-backinator [--version] [--help] <command> [<args>]
Available commands are:
backup Perform a backup operation
dump Dump a backup file
restore Perform a backup operation
| Option | Description |
|---|---|
file |
The backup file target. The signature will be the same with a .sig extension appended. The default names are consul.bak and consul.bak.sig |
key |
The passphrase used for data encryption and signature generation. The default string password will be used if none specified. This should be a secure pseudo random string. |
nokv |
Do not attempt to backup kv data. This only makes sense if also passing the acls option below. |
acls |
Optional backup filename for acl tokens. |
transform |
Optional argument that affects the key paths written to the backup file. See the transformation notes below for more information. |
prefix |
Optional argument that specifies the starting point for the backup tree. The default prefix is the root / prefix. To perform a partial tree backup specify a prefix. |
| Option | Description |
|---|---|
file |
The source file. The default is consul.bak |
key |
The passphrase used for data decryption and signature validation. This must match the key used when the backup was created. |
nokv |
Do not attempt to restore kv data. This only makes sense if also passing the acls option below. |
acls |
Optional source filename for acl tokens. |
delete |
Optionally delete all keys under the specified prefix prior to restoring the backup file. The default is false. |
prefix |
The prefix with the delete option. The default is / root. THIS WILL DELETE ALL DATA IN YOUR KEYSTORE if not changed when using -delete. |
| Option | Description |
|---|---|
addr |
Optional consul agent address and port. The default is read from the CONSUL_HTTP_ADDR environment variable if specified or set to 127.0.0.1:8500. |
scheme |
Optional scheme http or https used when connecting to the consul agent. The default is set to https if the CONSUL_HTTP_SSL environment variable is set to true otherwise the default is http. |
dc |
Optional datacenter specification. The default value is the datacenter of the agent to which you are connecting. |
token |
Optional consul access token. The default value is read from the CONSUL_HTTP_TOKEN environment variable if specified. |
| Option | Description |
|---|---|
file |
The source file. The default consul.bak will be used if not specified. |
key |
The passphrase for the backup file to be dumped. The default is password if not passed. |
plain |
Optionally dump and decode a reduced set of information omitting metadata, timestamps and other lesser used information. |
acls |
Specified file is an ACL token backup file. This option is only relevant if using the plain option above. |
Transformations are simple string operations and will affect the path anywhere
there is a match. For example, passing -transform="foo,bar" would rewrite
/apple/foo/key => /apple/bar/key as well as /orange/thing/foo/key => /orange/thing/bar/key.
To avoid potential errors in transformations you should always use the most exact path possible.
Using the previous example if you only wanted to affect keys under apple you should pass
-transform="apple/foo,apple/bar" to prevent other paths from being modified inadvertently.
ahurt$ ./consul-backinator backup -key=superSecretStuff
2016/05/09 17:14:11 [Success] Backed up 289 keys from / to consul.bak
Keep your backup (consul.bak) and signature (consul.bak.sig) files in a safe place.
You will need both to restore your data.
ahurt$ ls -la *.sig *.bak
-rw------- 1 ahurt staff 11167 May 9 17:14 consul.bak
-rw------- 1 ahurt staff 44 May 9 17:14 consul.bak.sig
- The HashiCorp folks for the excellent Consul service discovery daemon and the excellent embedded API and golang package. In addition to some very nice references back to this utility in a few issues.
- Adam Avilla for his time and contributions to the Docker portions of the build.
- All the other contributors, testers and stargazers.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent