Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
98 lines (74 sloc) 2.2 KB
date title author tags logo repo image
2018-01-06 00:00:00 +0000
AWS RDS Snapper
tuannvm
amazon
aws
rds
snapshot
amazon_rds.svg
quay.io/honestbee/rds-snapper

The rds-snapper plugin cleans up specific RDS instance's snapshots, keeps specified number of copies and creates new snapshots. The below pipeline configuration demonstrates simple usage:

Simple form which does it all (Clear old snapshots, keep only specific numbers & create a new one):

pipeline:
  rds-snapper:
    image: quay.io/honestbee/rds-snapper
    pull: true
    secrets: [ aws_access_key_id, aws_secret_access_key ]
    action: "create"
    dbname: "<db-name>"
    suffix: "<snapshot-name-suffix>"
    keep: <numbers-to-keep>

Only clear old snapshots:

pipeline:
  rds-snapper:
    image: quay.io/honestbee/rds-snapper
    pull: true
    secrets: [ aws_access_key_id, aws_secret_access_key, aws_region ]
+    action: "clear"
    dbname: "<db-name>"
-    suffix: "<snapshot-name-suffix>"
    keep: <numbers-to-keep>

Export snapshots list to stdout (print all of dbname is not specified:

pipeline:
  rds-snapper:
    image: quay.io/honestbee/rds-snapper
    pull: true
    secrets: [ aws_access_key_id, aws_secret_access_key, aws_region ]
+    action: "export"
+/-    dbname: "<db-name>"

Parameter Reference

action : choose which features to execute (clear|create|export) (required)

aws_access_key : amazon key (optional)

aws_secret_key : amazon secret key (optional)

aws_region : bucket region (us-east-1, eu-west-1, etc)

keep : number of snapshot to keep (optional, 5 by default)

dbname : rds instance's name (optional)

suffix : snapshot's name suffix (optional, randomly generated if not specified)

Secret Reference

action : choose which features to execute (clear|create|export) (required)

aws_access_key_id : amazon key (optional)

aws_secret_access_key : amazon secret key (optional)

aws_region : bucket region (us-east-1, eu-west-1, etc)

keep : number of snapshot to keep (optional, 5 by default)

dbname : rds instance's name (optional)

suffix : snapshot's name suffix (optional, randomly generated if not specified)