postgresql-backup-s3's Introduction

postgres-backup-s3

Backup PostgresSQL to S3 (supports periodic backups)

Basic Usage

$ docker run -e S3_ACCESS_KEY_ID=key -e S3_SECRET_ACCESS_KEY=secret -e S3_BUCKET=my-bucket -e S3_PREFIX=backup -e POSTGRES_DATABASE=dbname -e POSTGRES_USER=user -e POSTGRES_PASSWORD=password -e POSTGRES_HOST=localhost itbm/postgres-backup-s3

Kubernetes Deployment

apiVersion: v1
kind: Namespace
metadata:
  name: backup

---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: postgresql
  namespace: backup
spec:
  selector:
    matchLabels:
      app: postgresql
  strategy:
    type: Recreate
  template:
    metadata:
      labels:
        app: postgresql
    spec:
      containers:
      - name: postgresql
        image: itbm/postgresql-backup-s3
        imagePullPolicy: Always
        env:
        - name: POSTGRES_DATABASE
          value: ""
        - name: POSTGRES_HOST
          value: ""
        - name: POSTGRES_PORT
          value: ""
        - name: POSTGRES_PASSWORD
          value: ""
        - name: POSTGRES_USER
          value: ""
        - name: S3_ACCESS_KEY_ID
          value: ""
        - name: S3_SECRET_ACCESS_KEY
          value: ""
        - name: S3_BUCKET
          value: ""
        - name: S3_ENDPOINT
          value: ""
        - name: S3_PREFIX
          value: ""
        - name: SCHEDULE
          value: ""

Environment variables

Variable	Default	Required	Description
POSTGRES_DATABASE		Y	Database you want to backup or 'all' to backup everything
POSTGRES_HOST		Y	The PostgreSQL host
POSTGRES_PORT	5432		The PostgreSQL port
POSTGRES_USER		Y	The PostgreSQL user
POSTGRES_PASSWORD		Y	The PostgreSQL password
POSTGRES_EXTRA_OPTS			Extra postgresql options
S3_ACCESS_KEY_ID		Y	Your AWS access key
S3_SECRET_ACCESS_KEY		Y	Your AWS secret key
S3_BUCKET		Y	Your AWS S3 bucket path
S3_PREFIX	backup		Path prefix in your bucket
S3_REGION	us-west-1		The AWS S3 bucket region
S3_ENDPOINT			The AWS Endpoint URL, for S3 Compliant APIs such as minio
S3_S3V4	no		Set to `yes` to enable AWS Signature Version 4, required for minio servers
SCHEDULE			Backup schedule time, see explainatons below
ENCRYPTION_PASSWORD			Password to encrypt the backup. Can be decrypted using `openssl aes-256-cbc -d -in backup.sql.gz.enc -out backup.sql.gz`
DELETE_OLDER_THAN			Delete old backups, see explanation and warning below

Automatic Periodic Backups

You can additionally set the SCHEDULE environment variable like -e SCHEDULE="@daily" to run the backup automatically.

More information about the scheduling can be found here.

Delete Old Backups

You can additionally set the DELETE_OLDER_THAN environment variable like -e DELETE_OLDER_THAN="30 days ago" to delete old backups.

WARNING: this will delete all files in the S3_PREFIX path, not just those created by this script.

Encryption

You can additionally set the ENCRYPTION_PASSWORD environment variable like -e ENCRYPTION_PASSWORD="superstrongpassword" to encrypt the backup. It can be decrypted using openssl aes-256-cbc -d -in backup.sql.gz.enc -out backup.sql.gz.

postgresql-backup-s3's People

Contributors

Stargazers

Watchers

postgresql-backup-s3's Issues

Postgres v12 support

Hi there,

I just found your repo through its parent's issue schickling/dockerfiles#115.

Do you think it would be possible to build a new version containing support for Postgresql v12 ? Your dockerfile doesn't seem to specify a specific version, I figure v12 isn't supported because it wasn't available last time you built your image.

Thanks for considering, and thanks a lot for adapting this tool after suppoort from its previous maintainer seemed to have stopped.

Use pg_dump custom format

Hi there,

store dump in gz is nice idea, but PG can do this by -Fc option

pg_dump $POSTGRES_HOST_OPTS $POSTGRES_DATABASE -Fc > $SRC_FILE.gz

Custom format work faster then redirecting to gzip. I think it is important when dump isn't small.

Thank you for making this image, is very cool!

itbm / postgresql-backup-s3 Goto Github PK