This project provides Docker images to periodically back up a PostgreSQL database to AWS S3, and to restore from the backup as needed.
postgres:
image: postgres:13
environment:
POSTGRES_USER: user
POSTGRES_PASSWORD: password
pg_backup_s3:
image: eeshugerman/postgres-backup-s3:13
environment:
SCHEDULE: '@weekly'
PASSPHRASE: passphrase
S3_REGION: region
S3_ACCESS_KEY_ID: key
S3_SECRET_ACCESS_KEY: secret
S3_BUCKET: my-bucket
S3_PREFIX: backup
POSTGRES_HOST: postgres
POSTGRES_DATABASE: dbname
POSTGRES_USER: user
POSTGRES_PASSWORD: password
ENABLE_METRICS: true
9
, 10
, 11
, 12
, or 13
.SCHEDULE
variable determines backup frequency. See go-cron schedules documentation here.PASSPHRASE
is provided, the backup will be encrypted using GPG.docker exec <container name> sh backup.sh
to trigger a backup ad-hocOptionally you can also export backup metrics, e.g. size, start time in Prometheus
file format. To read the metrics, you'll have to mount the metrics folder to your host at /metrics
.
The file is called metrics.txt
.
$ docker run -v $(pwd)/metrics:/metrics -e ENABLE_METRICS=true -e ... siemens/postgres-backup-s3
WARNING: DATA LOSS! All database objects will be dropped and re-created.
... from latest backup
docker exec <container name> sh restore.sh
NOTE: If your bucket has more than a 1000 files, the latest may not be restored -- only one S3
ls
command is used... from specific backup
docker exec <container name> sh restore.sh <timestamp>
This project is a fork and re-structuring of @schickling's postgres-backup-s3 and postgres-restore-s3.
pg_dump
's custom
format (see docs)