Merge remote-tracking branch 'origin/dockerfile_version1.0' into 1.0.1

Author: timvaillancourt

Dockerfile

@@ -1,8 +1,8 @@
 FROM centos:centos7
 MAINTAINER Tim Vaillancourt <tim.vaillancourt@percona.com>
-RUN yum install -y https://www.percona.com/redir/downloads/percona-release/redhat/latest/percona-release-0.1-4.noarch.rpm && \
-	yum install -y Percona-Server-MongoDB-32-tools && yum clean all && \
-	curl -Lo /usr/bin/mongodb-consistent-backup https://github.com/Percona-Lab/mongodb_consistent_backup/releases/download/0.4.0/mongodb-consistent-backup.el7.x86_64 && \
+RUN yum install -y https://www.percona.com/redir/downloads/percona-release/redhat/latest/percona-release-0.1-4.noarch.rpm epel-release && \
+	yum install -y Percona-Server-MongoDB-32-tools zbackup && yum clean all && \
+	curl -Lo /usr/bin/mongodb-consistent-backup https://github.com/Percona-Lab/mongodb_consistent_backup/releases/download/1.0.0/mongodb-consistent-backup.el7.centos.x86_64 && \
 	chmod +x /usr/bin/mongodb-consistent-backup
 ENTRYPOINT ["mongodb-consistent-backup"]
 CMD ["--help"]

README.rst

@@ -141,7 +141,7 @@ The backups are mongorestore compatible and stored in a directory per backup. Th
 Run as Docker Container (Experimental)
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-*Note: you need to use persistent volumes to store backups and/or config files long-term when using Docker. Data in Docker containers is destroyed when the container is deleted.*
+Note: you need to use persistent volumes to store backups and/or config files long-term when using Docker. Data in Docker containers is destroyed when the container is deleted. See `scripts/docker-persistent.sh <scripts/docker-persistent.sh>`__ and `scripts/docker-persistent.example.conf <scripts/docker-persistent.example.conf>`__ as an example/demo of how to implement persistence.
 
 **Via Docker Hub**
 

scripts/docker-persistent.example.conf

@@ -0,0 +1,15 @@
+# 'log_dir' and 'backup.location' flags are auto-overriden
+# when using with scripts/docker-persistent.sh. No need to
+# add them here.
+production:
+  host: mongodb01.example.com
+  port: 27017
+  backup:
+    method: mongodump
+    name: default
+  archive:
+    method: tar
+  notify:
+    method: none
+  upload:
+    method: none

scripts/docker-persistent.sh

@@ -0,0 +1,66 @@
+#!/bin/sh
+#
+# Script for running mongodb_consistent_backup under Docker
+# with persistent data container for data, config and logs.
+#
+# See: scripts/docker-persistent.example.conf for an example
+# config to pass to this script during backup. 'log_dir' and
+# 'backup.location' variables are auto-set by this script.
+#
+# Run backup:
+#     $ scripts/docker-persistent.sh backup scripts/docker-persistent.example.conf
+#     # Loading config file scripts/docker-persistent.example.conf into container
+#     # Running Docker image: timvaillancourt/mongodb_consistent_backup:latest
+#     [2017-04-27 11:22:04,255] [INFO] [MainProcess] [Main:init:127] Starting mongodb-consistent-backup version 1.0.0 (git commit: d780ad545b603d3a2f807e1813f1de407e81f1ba)
+#     ...
+#     ...
+#
+# List backups (in persistent Docker volume):
+#     $ scripts/docker-persistent.sh list
+#     /mongodb_consistent_backup/data/default/20170427_1122
+#     /mongodb_consistent_backup/data/default/20170427_1123
+#
+# Get a backup:
+#     $ scripts/docker-persistent.sh get /mongodb_consistent_backup/data/default/20170427_1122
+#     $ ls -ald ./20170427_112
+#     drwxr-xr-x. 3 root root 59 Apr 27 13:22 ./20170427_1122
+#
+
+ACTION=$1
+[ -z $1 ] && echo "Usage: $0 [backup|list|get] [action flags]" && exit 1
+
+BACKUP_DIR=/mongodb_consistent_backup
+BACKUP_CNF=$BACKUP_DIR/mongodb-consistent-backup.conf
+BACKUP_IMAGE=mongodb_consistent_backup
+BACKUP_DATA_IMAGE=mongodb_consistent_backup-data
+MCB_FLAGS="-c $BACKUP_CNF -L $BACKUP_DIR/logs -l $BACKUP_DIR/data"
+DOCKER_IMAGE=timvaillancourt/mongodb_consistent_backup:latest
+
+if [ "$ACTION" = "backup" ]; then
+  CNF=$2
+  [ -z $2 ]  && echo "Usage: $0 backup [mongodb-consistent-backup config file]" && exit 1
+
+  docker ps -a | grep -q "$BACKUP_DATA_IMAGE"
+  if [ $? -gt 0 ]; then
+    echo "# Creating persistent volume for Docker image: $DOCKER_IMAGE"
+    docker create -v $BACKUP_DIR --name $BACKUP_DATA_IMAGE $DOCKER_IMAGE
+  fi
+  
+  if [ -f $CNF ]; then
+      echo "# Loading config file $CNF into container"
+      docker cp $CNF ${BACKUP_DATA_IMAGE}:${BACKUP_CNF}
+  
+      echo "# Running Docker image: $DOCKER_IMAGE"
+      docker run -i --name $BACKUP_IMAGE --rm --volumes-from $BACKUP_DATA_IMAGE $DOCKER_IMAGE $MCB_FLAGS
+  else
+      echo "# Config file $CNF does not exist!"
+      exit 1
+  fi
+elif [ "$ACTION" = "list" ]; then
+  echo "# Listing backups in $BACKUP_DATA_IMAGE"
+  docker run -it --name $BACKUP_IMAGE --rm --volumes-from $BACKUP_DATA_IMAGE --entrypoint /bin/find $DOCKER_IMAGE $BACKUP_DIR/data -maxdepth 2 -type d -name "[0-9]*_*"
+elif [ "$ACTION" = "get" ]; then
+  DIR=$2
+  [ -z $DIR ] && echo "Usage: $0 get [backup path]" && exit 1
+  docker cp $BACKUP_DATA_IMAGE:$DIR .
+fi