diff --git a/.gitignore b/.gitignore index a1338d6..9ae177d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +consul-s3-snapshot + # Binaries for programs and plugins *.exe *.dll diff --git a/README.md b/README.md new file mode 100644 index 0000000..8323eee --- /dev/null +++ b/README.md @@ -0,0 +1,131 @@ +# consul-s3-snapshot + +Create and restore consul snapshot with s3 and kms. + +``` +usage: consul-s3-snapshot --s3-bucket=S3-BUCKET --s3-region=S3-REGION [] [ ...] + +Save and restore consul snapshots to s3. + +Flags: + --help Show context-sensitive help (also try --help-long and --help-man). + --s3-bucket=S3-BUCKET S3 bucket name + --s3-region=S3-REGION S3 bucket region + --kms-region=KMS-REGION KMS region + +Commands: + help [...] + Show help. + + + save --s3-prefix=S3-PREFIX [] + Snapshot and upload to s3 + + --s3-prefix=S3-PREFIX S3 bucket prefix + --kms-key-arn=KMS-KEY-ARN KMS key arn + + restore --s3-path=S3-PATH + Restore a snapshot from s3 + + --s3-path=S3-PATH S3 bucket path +``` + +## Usage + +If you want to specify a specific AWS profile to use instead of your default one, prefix each of the command with `AWS_PROFILE=` + +### Save + +You need to specify the s3 bucket and its region as well as a prefix. The final filename will have the format +``` +-