Initial commit

Author: Nicholas Villarreal

Dockerfile

@@ -0,0 +1,24 @@
+FROM alpine:3.9
+
+ADD install.sh install.sh
+RUN sh install.sh && rm install.sh
+
+ENV POSTGRES_DATABASE **None**
+ENV POSTGRES_HOST **None**
+ENV POSTGRES_PORT 5432
+ENV POSTGRES_USER **None**
+ENV POSTGRES_PASSWORD **None**
+ENV POSTGRES_EXTRA_OPTS ''
+ENV S3_ACCESS_KEY_ID **None**
+ENV S3_SECRET_ACCESS_KEY **None**
+ENV S3_BUCKET **None**
+ENV S3_REGION us-west-1
+ENV S3_PATH 'backup'
+ENV S3_ENDPOINT **None**
+ENV S3_S3V4 no
+ENV SCHEDULE **None**
+
+ADD run.sh run.sh
+ADD backup.sh backup.sh
+
+CMD ["sh", "run.sh"]

README.md

@@ -0,0 +1,43 @@
+# postgres-backup-s3
+
+Backup PostgresSQL to S3 (supports periodic backups)
+
+## Usage
+
+Docker:
+```sh
+$ 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 schickling/postgres-backup-s3
+```
+
+Docker Compose:
+```yaml
+postgres:
+  image: postgres
+  environment:
+    POSTGRES_USER: user
+    POSTGRES_PASSWORD: password
+
+pgbackups3:
+  image: schickling/postgres-backup-s3
+  links:
+    - postgres
+  environment:
+    SCHEDULE: '@daily'
+    S3_REGION: region
+    S3_ACCESS_KEY_ID: key
+    S3_SECRET_ACCESS_KEY: secret
+    S3_BUCKET: my-bucket
+    S3_PREFIX: backup
+    POSTGRES_DATABASE: dbname
+    POSTGRES_USER: user
+    POSTGRES_PASSWORD: password
+    POSTGRES_EXTRA_OPTS: '--schema=public --blobs'
+    TZ: America/Denver
+```
+
+### 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](http://godoc.org/github.com/robfig/cron#hdr-Predefined_schedules).
+

backup.sh

@@ -0,0 +1,68 @@
+#! /bin/sh
+
+set -e
+set -o pipefail
+
+if [ "${S3_ACCESS_KEY_ID}" = "**None**" ]; then
+  echo "You need to set the S3_ACCESS_KEY_ID environment variable."
+  exit 1
+fi
+
+if [ "${S3_SECRET_ACCESS_KEY}" = "**None**" ]; then
+  echo "You need to set the S3_SECRET_ACCESS_KEY environment variable."
+  exit 1
+fi
+
+if [ "${S3_BUCKET}" = "**None**" ]; then
+  echo "You need to set the S3_BUCKET environment variable."
+  exit 1
+fi
+
+if [ "${POSTGRES_DATABASE}" = "**None**" ]; then
+  echo "You need to set the POSTGRES_DATABASE environment variable."
+  exit 1
+fi
+
+if [ "${POSTGRES_HOST}" = "**None**" ]; then
+  if [ -n "${POSTGRES_PORT_5432_TCP_ADDR}" ]; then
+    POSTGRES_HOST=$POSTGRES_PORT_5432_TCP_ADDR
+    POSTGRES_PORT=$POSTGRES_PORT_5432_TCP_PORT
+  else
+    echo "You need to set the POSTGRES_HOST environment variable."
+    exit 1
+  fi
+fi
+
+if [ "${POSTGRES_USER}" = "**None**" ]; then
+  echo "You need to set the POSTGRES_USER environment variable."
+  exit 1
+fi
+
+if [ "${POSTGRES_PASSWORD}" = "**None**" ]; then
+  echo "You need to set the POSTGRES_PASSWORD environment variable or link to a container named POSTGRES."
+  exit 1
+fi
+
+if [ "${S3_ENDPOINT}" == "**None**" ]; then
+  AWS_ARGS=""
+else
+  AWS_ARGS="--endpoint-url ${S3_ENDPOINT}"
+fi
+
+# env vars needed for aws tools
+export AWS_ACCESS_KEY_ID=$S3_ACCESS_KEY_ID
+export AWS_SECRET_ACCESS_KEY=$S3_SECRET_ACCESS_KEY
+export AWS_DEFAULT_REGION=$S3_REGION
+
+export PGPASSWORD=$POSTGRES_PASSWORD
+POSTGRES_HOST_OPTS="-h $POSTGRES_HOST -p $POSTGRES_PORT -U $POSTGRES_USER $POSTGRES_EXTRA_OPTS"
+
+echo "Creating dump of ${POSTGRES_DATABASE} database from ${POSTGRES_HOST}..."
+
+pg_dump $POSTGRES_HOST_OPTS $POSTGRES_DATABASE | gzip > dump.sql.gz
+
+echo "Uploading dump to $S3_BUCKET"
+
+cat dump.sql.gz | aws $AWS_ARGS s3 cp - s3://$S3_BUCKET/$S3_PREFIX/${POSTGRES_DATABASE}_$(date +"%Y-%m-%dT%H:%M:%SZ").sql.gz || exit 2
+
+echo "SQL backup uploaded successfully"

install.sh

@@ -0,0 +1,28 @@
+#! /bin/sh
+
+# exit if a command fails
+set -e
+
+
+apk update
+
+# install tzdata to enable TZ env variable
+apk add tzdata
+
+# install pg_dump
+apk add postgresql
+
+# install s3 tools
+apk add python py2-pip
+pip install awscli
+apk del py2-pip
+
+# install go-cron
+apk add curl
+curl -L --insecure https://github.com/odise/go-cron/releases/download/v0.0.6/go-cron-linux.gz | zcat > /usr/local/bin/go-cron
+chmod u+x /usr/local/bin/go-cron
+apk del curl
+
+
+# cleanup
+rm -rf /var/cache/apk/*

run.sh

@@ -0,0 +1,13 @@
+#! /bin/sh
+
+set -e
+
+if [ "${S3_S3V4}" = "yes" ]; then
+    aws configure set default.s3.signature_version s3v4
+fi
+
+if [ "${SCHEDULE}" = "**None**" ]; then
+  sh backup.sh
+else
+  exec go-cron "$SCHEDULE" /bin/sh backup.sh
+fi