Library to backup and restore consul key values
npm install hany-consul-backup-restore
npm install consul-backup-restore
API
$3
javascript
var ConsulBackupRestore = require('consul-backup-restore');
var cbr = new ConsulBackupRestore({host: 'localhost', port:8500});
`$3
javascript
cbr.backup(
{prefix: 'serviceName', filePath:'path/to/myFile'},
function(err, result) {
if (err) throw err;
console.log(result)
}
)
`
Callbacks has an error argument and a result argument. The result argument will either be the name of the file, or the s3 data dump.Options
* prefix : Consul prefix used to back up keys from consul. If left blank all key value pairs will be backed up.
* s3BucketName: If you wish to use AWS's s3 bucket, specify the buckets name.
* filePath: Will override the backup file name with your own.
$3
javascript
cbr.restore(
{prefix: 'serviceName', override: true, filePath:'path/to/myFile'},
function(err, result) {
if (err) throw err;
console.log(result)
}
)
`
Callbacks has an error argument and a result argument. The result will return an array of keys that were backed up. For example a key that already exists in consul will only be returned if the override is set to true.Options
* s3BucketName: If you wish to use AWS's s3 bucket, specify the buckets name.
* filePath: name of the file you wish to restore from.
* override: use true or 'true' to override existing keys & their values in consul.
$3
To run the tests locally you must have a consul instance running. We do this through docker.
docker run -d -p 8500:8500 -p 8600:53 -p 8400:8400 consul agent -dev -client 0.0.0.0 -advertise 127.0.0.1