mirror of
https://github.com/garraflavatra/docker-volume-s3-backup.git
synced 2025-07-20 02:18:04 +00:00
initial commit
This commit is contained in:
23
restore/10.Dockerfile
Normal file
23
restore/10.Dockerfile
Normal file
@ -0,0 +1,23 @@
|
||||
# This file is generated from template.Dockerfile. Do not edit it directly.
|
||||
###########################################################################
|
||||
|
||||
FROM alpine:3.8
|
||||
|
||||
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 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 DROP_PUBLIC 'no'
|
||||
|
||||
ADD restore.sh restore.sh
|
||||
|
||||
CMD ["sh", "restore.sh"]
|
23
restore/11.Dockerfile
Normal file
23
restore/11.Dockerfile
Normal file
@ -0,0 +1,23 @@
|
||||
# This file is generated from template.Dockerfile. Do not edit it directly.
|
||||
###########################################################################
|
||||
|
||||
FROM alpine:3.10
|
||||
|
||||
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 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 DROP_PUBLIC 'no'
|
||||
|
||||
ADD restore.sh restore.sh
|
||||
|
||||
CMD ["sh", "restore.sh"]
|
23
restore/12.Dockerfile
Normal file
23
restore/12.Dockerfile
Normal file
@ -0,0 +1,23 @@
|
||||
# This file is generated from template.Dockerfile. Do not edit it directly.
|
||||
###########################################################################
|
||||
|
||||
FROM alpine:edge
|
||||
|
||||
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 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 DROP_PUBLIC 'no'
|
||||
|
||||
ADD restore.sh restore.sh
|
||||
|
||||
CMD ["sh", "restore.sh"]
|
23
restore/9.Dockerfile
Normal file
23
restore/9.Dockerfile
Normal file
@ -0,0 +1,23 @@
|
||||
# This file is generated from template.Dockerfile. Do not edit it directly.
|
||||
###########################################################################
|
||||
|
||||
FROM alpine:3.6
|
||||
|
||||
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 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 DROP_PUBLIC 'no'
|
||||
|
||||
ADD restore.sh restore.sh
|
||||
|
||||
CMD ["sh", "restore.sh"]
|
27
restore/README.md
Normal file
27
restore/README.md
Normal file
@ -0,0 +1,27 @@
|
||||
# postgres-restore-s3
|
||||
|
||||
Restore a SQL backup from S3 to PostgresSQL
|
||||
|
||||
## Warning
|
||||
|
||||
This will potentially put your database in a very bad state or complete destroy your data, be very careful.
|
||||
|
||||
## Limitations
|
||||
|
||||
This is made to restore a backup made from postgres-backup-s3, if you backup came from somewhere else please check your format.
|
||||
|
||||
* Your s3 bucket *must* only contain backups which you wish to restore - it will always grabs the 'latest' based on unix sort with no filtering
|
||||
* They must be gzip encoded text sql files
|
||||
* If your bucket has more than a 1000 files the latest may not be restore, only one s3 ls command is made
|
||||
|
||||
## 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-restore-s3
|
||||
```
|
||||
|
||||
## Dropping public
|
||||
|
||||
If you wish to drop the public schema (drop schema public cascade; create schema public) then set the environment variable DROP_PUBLIC=yes. This is useful for situations where you wish to restore a database which currently has data / schemas in it.
|
||||
|
17
restore/install.sh
Normal file
17
restore/install.sh
Normal file
@ -0,0 +1,17 @@
|
||||
#! /bin/sh
|
||||
|
||||
# exit if a command fails
|
||||
set -e
|
||||
|
||||
apk update
|
||||
|
||||
# install pg_dump
|
||||
apk add postgresql
|
||||
|
||||
# install s3 tools
|
||||
apk add python py-pip
|
||||
pip install awscli
|
||||
apk del py-pip
|
||||
|
||||
# cleanup
|
||||
rm -rf /var/cache/apk/*
|
73
restore/restore.sh
Normal file
73
restore/restore.sh
Normal file
@ -0,0 +1,73 @@
|
||||
#! /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
|
||||
|
||||
# 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"
|
||||
|
||||
echo "Finding latest backup"
|
||||
|
||||
LATEST_BACKUP=$(aws s3 ls s3://$S3_BUCKET/$S3_PREFIX/ | sort | tail -n 1 | awk '{ print $4 }')
|
||||
|
||||
echo "Fetching ${LATEST_BACKUP} from S3"
|
||||
|
||||
aws s3 cp s3://$S3_BUCKET/$S3_PREFIX/${LATEST_BACKUP} dump.sql.gz
|
||||
gzip -d dump.sql.gz
|
||||
|
||||
if [ "${DROP_PUBLIC}" == "yes" ]; then
|
||||
echo "Recreating the public schema"
|
||||
psql $POSTGRES_HOST_OPTS -d $POSTGRES_DATABASE -c "drop schema public cascade; create schema public;"
|
||||
fi
|
||||
|
||||
echo "Restoring ${LATEST_BACKUP}"
|
||||
|
||||
psql $POSTGRES_HOST_OPTS -d $POSTGRES_DATABASE < dump.sql
|
||||
|
||||
echo "Restore complete"
|
||||
|
20
restore/template.Dockerfile
Normal file
20
restore/template.Dockerfile
Normal file
@ -0,0 +1,20 @@
|
||||
FROM alpine:{alpine_version}
|
||||
|
||||
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 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 DROP_PUBLIC 'no'
|
||||
|
||||
ADD restore.sh restore.sh
|
||||
|
||||
CMD ["sh", "restore.sh"]
|
Reference in New Issue
Block a user