Release 1.18.1 - See CHANGELOG.md

Fix couchdb backup endpoint; Set ENABLE_ZABBIX to FALSE by default

CHANGELOG.md

@@ -1,3 +1,58 @@
+## 1.18.1 2020-03-14 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Allow for passwords with spaces in them for MariaDB / MySQL
+
+
+## 1.18.0 2019-12-29 <dave at tiredofit dot ca>
+
+   ### Added
+      - Update image to support new tiredofit/alpine base images
+
+
+## 1.17.3 2019-12-12 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Quiet down Zabbix Agent
+
+
+## 1.17.2 2019-12-12 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Re Enable ZABBIX
+
+
+## 1.17.1 2019-12-10 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Fix spelling mistake in container initialization
+
+
+## 1.17.0 2019-12-09 <dave at tiredofit dot ca>
+
+   ### Changed
+      - Stop compiling mongodb-tools as it is back in Alpine:edge repositories
+      - Cleanup Code
+
+
+## 1.16 - 2019-06-16 - <dave at tiredofit dot ca>
+
+* Check to see if Database Exists before performing backup
+* Fix for MysQL/MariaDB custom ports - Credit to <spumer@github>
+
+## 1.15 - 2019-05-24 - <claudioaltamura @ github>
+
+* Added abaility to backup password protected Redis Hosts
+
+## 1.14 - 2019-04-20 - <dave at tiredofit dot ca>
+
+* Switch to using locally built mongodb-tools from tiredofit/mongo-builder due to Alpine removing precompiled packages from repositories
+
+## 1.13 - 2019-03-09 - <dave at tiredofit dot ca>
+
+* Fixed Postgres backup without SPLIT_DB enabled (credit MelwinKfr@github)
+* Added DB_PORT reference to properly backup Postgres with non default ports (thanks Maxximus007@github)
+
 ## 1.12 - 2019-03-01 - <stevetodorov at github>
 
 * Fix for XZ Compression failing
@@ -55,3 +110,4 @@
 
 * Initial Release
 * Alpine:Edge
+

Dockerfile

@@ -2,48 +2,50 @@ FROM tiredofit/alpine:edge
 LABEL maintainer="Dave Conroy (dave at tiredofit dot ca)"
 
 ### Set Environment Variables
-   ENV ENABLE_CRON=FALSE \
-       ENABLE_SMTP=FALSE
+ENV ENABLE_CRON=FALSE \
+    ENABLE_SMTP=FALSE \
+    ENABLE_ZABBIX=FALSE \
+    ZABBIX_HOSTNAME=db-backup
 
 ### Dependencies
-   RUN set -ex && \
-       echo "@testing http://nl.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories && \
-       apk update && \
-       apk upgrade && \
-       apk add --virtual .db-backup-build-deps \
-           build-base \
-           bzip2-dev \
-           git \
-           xz-dev \
-           && \
-           \
-       apk add --virtual .db-backup-run-deps  \
-       	   bzip2 \
-           mongodb-tools \
-           mariadb-client \
-           libressl \
-           pigz \
-           postgresql \
-           postgresql-client \
-           redis \
-           xz \
-           && \
-        apk add \
-            influxdb@testing \
+RUN set -ex && \
+    echo "@testing http://nl.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories && \
+    apk update && \
+    apk upgrade && \
+    apk add -t .db-backup-build-deps \
+               build-base \
+               bzip2-dev \
+               git \
+               xz-dev \
+               && \
+    \
+    apk add -t .db-backup-run-deps \
+      	       bzip2 \
+               influxdb \
+               mariadb-client \
+               mongodb-tools \
+               libressl \
+               pigz \
+               postgresql \
+               postgresql-client \
+               redis \
+               xz \
+               && \
+    \
+    apk add \
             pixz@testing \
-           && \
-          \
-          cd /usr/src && \
-          mkdir -p pbzip2 && \
-          curl -ssL https://launchpad.net/pbzip2/1.1/1.1.13/+download/pbzip2-1.1.13.tar.gz | tar xvfz - --strip=1 -C /usr/src/pbzip2 && \
-          cd pbzip2 && \
-          make && \
-          make install && \
-          \
-          # Cleanup
-          rm -rf /usr/src/* && \
-          apk del .db-backup-build-deps && \
-          rm -rf /tmp/* /var/cache/apk/*
+            && \
+    \        
+    mkdir -p /usr/src/pbzip2 && \
+    curl -ssL https://launchpad.net/pbzip2/1.1/1.1.13/+download/pbzip2-1.1.13.tar.gz | tar xvfz - --strip=1 -C /usr/src/pbzip2 && \
+    cd /usr/src/pbzip2 && \
+    make && \
+    make install && \
+    \
+### Cleanup
+    apk del .db-backup-build-deps && \
+    rm -rf /usr/src/* && \
+    rm -rf /tmp/* /var/cache/apk/*
 
 ### S6 Setup
     ADD install  /

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Dave Conroy
+Copyright (c) 2019 Dave Conroy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,4 @@
-# tiredofit/db-backup
+# hub.docker.com/r/tiredofit/db-backup
 
 
 [![Build Status](https://img.shields.io/docker/build/tiredofit/db-backup.svg)](https://hub.docker.com/r/tiredofit/db-backup)
@@ -6,7 +6,6 @@
 [![Docker Stars](https://img.shields.io/docker/stars/tiredofit/db-backup.svg)](https://hub.docker.com/r/tiredofit/db-backup)
 [![Docker Layers](https://images.microbadger.com/badges/image/tiredofit/db-backup.svg)](https://microbadger.com/images/tiredofit/db-backup)
 
-
 # Introduction
 
 This will build a container for backing up multiple type of DB Servers
@@ -23,7 +22,7 @@ Currently backs up CouchDB, InfluxDB, MySQL, MongoDB Postgres, Redis, Rethink se
 * select how often to run a dump
 * select when to start the first dump, whether time of day or relative to container start time
 
-This Container uses Alpine:Edge as a base.
+* This Container uses a [customized Alpine Linux base](https://hub.docker.com/r/tiredofit/alpine) which includes [s6 overlay](https://github.com/just-containers/s6-overlay) enabled for PID 1 Init capabilities, [zabbix-agent](https://zabbix.org) for individual container monitoring, Cron also installed along with other tools (bash,curl, less, logrotate, nano, vim) for easier management. It also supports sending to external SMTP servers.
 
 [Changelog](CHANGELOG.md)
 
@@ -56,7 +55,7 @@ method of installation.
 
 
 ```bash
-docker pull tiredofit/db-backup
+docker pull tiredofit/db-backup:latest
 ```
 
 # Quick Start
@@ -86,23 +85,22 @@ Along with the Environment Variables from the [Base image](https://hub.docker.co
 
 | Parameter | Description |
 |-----------|-------------|
+| `COMPRESSION` | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, or none `NONE` - Default `GZ`
 | `DB_TYPE` | Type of DB Server to backup `couch` `influx` `mysql` `pgsql` `mongo` `redis` `rethink`
-| `DB_SERVER` | Server Hostname e.g. `mariadb`
+| `DB_HOST` | Server Hostname e.g. `mariadb`
 | `DB_NAME` | Schema Name e.g. `database`
 | `DB_USER` | username for the database - use `root` to backup all MySQL of them.
 | `DB_PASS` | (optional if DB doesn't require it) password for the database
+| `DB_PORT` | (optional) Set port to connect to DB_HOST. Defaults are provided
 | `DB_DUMP_FREQ` | How often to do a dump, in minutes. Defaults to 1440 minutes, or once per day.
 | `DB_DUMP_BEGIN` | What time to do the first dump. Defaults to immediate. Must be in one of two formats
 | | Absolute HHMM, e.g. `2330` or `0415`
 | | Relative +MM, i.e. how many minutes after starting the container, e.g. `+0` (immediate), `+10` (in 10 minutes), or `+90` in an hour and a half
-| `DB_DUMP_DEBUG` | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed.
-| `DB_DUMP_TARGET` | Where to put the dump file, should be a directory. Supports three formats |
-| |  Local If the value of `DB_DUMP_TARGET` starts with a `/` character, will dump to a local path, which should be volume-mounted.
 | `DB_CLEANUP_TIME` | Value in minutes to delete old backups (only fired when dump freqency fires). 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything.
-| `COMPRESSION` | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, or none `NONE` - Default `GZ`
+| `DEBUG_MODE` | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed.
 | `MD5` | Generate MD5 Sum in Directory, `TRUE` or `FALSE` - Default `TRUE`
-| `SPLIT_DB` | If using root as username and multiple DBs on system, set to TRUE to create Seperate DB Backups instead of all in one. - Default `FALSE` |
 | `PARALLEL_COMPRESSION` | Use multiple cores when compressing backups `TRUE` or `FALSE` - Default `TRUE` |
+| `SPLIT_DB` | If using root as username and multiple DBs on system, set to TRUE to create Seperate DB Backups instead of all in one. - Default `FALSE` |
 
 
 ## Maintenance

examples/docker-compose.yml

@@ -19,7 +19,7 @@ services:
     links:
      - example-db
     volumes:
-      - ./backups:/backups
+      - ./backups:/backup
     environment:
       - DB_TYPE=mariadb
       - DB_HOST=example-db
@@ -32,7 +32,6 @@ services:
       - MD5=TRUE
       - COMPRESSION=XZ
       - SPLIT_DB=FALSE
-
     restart: always
 
 

install/etc/s6/services/10-db-backup/run

@@ -1,26 +1,17 @@
 #!/usr/bin/with-contenv bash
 
+source /assets/functions/*
+PROCESS_NAME="db-backup"
+
 date >/dev/null
 
 if [ "$1" != "NOW" ]; then
     sleep 10
 fi
 
-### Set Debug Mode
-if [ "$DEBUG_MODE" = "TRUE" ] || [ "$DEBUG_MODE" = "true" ]; then
-    set -x
-fi
-
 ### Sanity Test
-if [ ! -n "$DB_TYPE" ]; then
-    echo '** [db-backup] ERROR: No Database Type Selected! '
-    exit 1
-fi
-
-if [ ! -n "$DB_HOST" ]; then
-    echo '** [db-backup] ERROR: No Database Host Entered! '
-    exit 1
-fi
+sanity_var DB_TYPE "Database Type"
+sanity_var DB_HOST "Database Host"
 
 ### Set Defaults
 COMPRESSION=${COMPRESSION:-GZ}
@@ -74,7 +65,7 @@ fi
             "mysql" | "MYSQL" | "mariadb" | "MARIADB")
             DBTYPE=mysql
             DBPORT=${DB_PORT:-3306}
-            [[ ( -n "${DB_PASS}" ) ]] && MYSQL_PASS_STR=" -p${DBPASS}"
+            [[ ( -n "${DB_PASS}" ) ]] && MYSQL_PASS_STR=" -p'${DBPASS}'"
             ;;
             "postgres" | "postgresql" | "pgsql" | "POSTGRES" | "POSTGRESQL" | "PGSQL" )
             DBTYPE=pgsql
@@ -84,6 +75,7 @@ fi
             "redis" | "REDIS"   )
             DBTYPE=redis
             DBPORT=${DB_PORT:-6379}
+            [[ ( -n "${DB_PASS}" ) ]] && REDIS_PASS_STR=" -a ${DBPASS}"
             ;;
             "rethink" | "RETHINK"   )
             DBTYPE=rethink
@@ -96,7 +88,7 @@ fi
 ### Functions
 function backup_couch() {
     TARGET=couch_${DBNAME}_${DBHOST}_${now}.txt
-    curl -X GET http://${DBHOST}:${DBPORT}/${DBNAME}/ all docs? include docs=true >${TMPDIR}/${TARGET}
+    curl -X GET http://${DBHOST}:${DBPORT}/${DBNAME}/_all_docs?include_docs=true >${TMPDIR}/${TARGET}
     generate_md5
     compression
     move_backup
@@ -104,20 +96,20 @@ function backup_couch() {
 
 function backup_mysql() {
     if [ "$SPLIT_DB" = "TRUE" ] || [ "$SPLIT_DB" = "true" ];  then
-        DATABASES=`mysql -h $DBHOST -u$DBUSER -p$DBPASS --batch -e "SHOW DATABASES;" | grep -v Database|grep -v schema`
+        DATABASES=`mysql -h ${DBHOST} -P $DBPORT -u$DBUSER -p"${DBPASS}" --batch -e "SHOW DATABASES;" | grep -v Database|grep -v schema`
 
         for db in $DATABASES; do
                 if [[ "$db" != "information_schema" ]] && [[ "$db" != _* ]] ; then
                     echo "** [db-backup] Dumping database: $db"
                     TARGET=mysql_${db}_${DBHOST}_${now}.sql
-                    mysqldump --max-allowed-packet=512M -h $DBHOST -u$DBUSER ${MYSQL_PASS_STR} --databases $db > ${TMPDIR}/${TARGET}
+                    mysqldump --max-allowed-packet=512M -h $DBHOST -P $DBPORT -u$DBUSER ${MYSQL_PASS_STR} --databases $db > ${TMPDIR}/${TARGET}
                     generate_md5
                     compression
                     move_backup
                 fi
         done
     else
-        mysqldump --max-allowed-packet=512M -A -h $DBHOST -u$DBUSER ${MYSQL_PASS_STR} > ${TMPDIR}/${TARGET}
+        mysqldump --max-allowed-packet=512M -A -h $DBHOST -P $DBPORT -u$DBUSER ${MYSQL_PASS_STR} > ${TMPDIR}/${TARGET}
         generate_md5
         compression
         move_backup
@@ -146,9 +138,9 @@ function backup_mongo() {
 function backup_pgsql() {
   if [ "$SPLIT_DB" = "TRUE" ] || [ "$SPLIT_DB" = "true" ];  then
       export PGPASSWORD=${DBPASS}
-      DATABASES=`psql -h $DBHOST -U $DBUSER -c 'COPY (SELECT datname FROM pg_database WHERE datistemplate = false) TO STDOUT;' `
+      DATABASES=`psql -h $DBHOST -U $DBUSER -p ${DBPORT} -c 'COPY (SELECT datname FROM pg_database WHERE datistemplate = false) TO STDOUT;' `
             for db in $DATABASES; do
-                echo "** [db-backup] Dumping database: $db"
+                print_info "Dumping database: $db"
                 TARGET=pgsql_${db}_${DBHOST}_${now}.sql
                 pg_dump -h ${DBHOST} -p ${DBPORT} -U ${DBUSER} $db > ${TMPDIR}/${TARGET}
                 generate_md5
@@ -157,7 +149,7 @@ function backup_pgsql() {
             done
         else
             export PGPASSWORD=${DBPASS}
-            pg_dump -h ${DBHOST} -U ${DBUSER} $db > ${TMPDIR}/${TARGET}
+            pg_dump -h ${DBHOST} -U ${DBUSER} -p ${DBPORT} ${DBNAME} > ${TMPDIR}/${TARGET}
             generate_md5
             compression
             move_backup
@@ -166,18 +158,18 @@ function backup_pgsql() {
 
 function backup_redis() {
     TARGET=redis_${db}_${DBHOST}_${now}.rdb
-    echo bgsave | redis-cli -h ${DBHOST} -p ${DBPORT} --rdb ${TMPDIR}/${TARGET}
-    echo "** [db-backup] Dumping Redis - Flushing Redis Cache First"
+    echo bgsave | redis-cli -h ${DBHOST} -p ${DBPORT} ${REDIS_PASS_STR} --rdb ${TMPDIR}/${TARGET}
+    print_info "Dumping Redis - Flushing Redis Cache First"
     sleep 10
     try=5
     while [ $try -gt 0 ] ; do
-        saved=$(echo 'info Persistence' | redis-cli -h ${DBHOST} -p ${DBPORT} | awk '/rdb_bgsave_in_progress:0/{print "saved"}')
-        ok=$(echo 'info Persistence' | redis-cli -h ${DBHOST} -p ${DBPORT} | awk '/rdb_last_bgsave_status:ok/{print "ok"}')
+        saved=$(echo 'info Persistence' | redis-cli -h ${DBHOST} -p ${DBPORT} ${REDIS_PASS_STR} | awk '/rdb_bgsave_in_progress:0/{print "saved"}')
+        ok=$(echo 'info Persistence' | redis-cli -h ${DBHOST} -p ${DBPORT} ${REDIS_PASS_STR} | awk '/rdb_last_bgsave_status:ok/{print "ok"}')
         if [[ "$saved" = "saved" ]] && [[ "$ok" = "ok" ]]; then
-            echo "** [db-backup] Redis Backup Complete"
+            print_info "Redis Backup Complete"
         fi
         try=$((try - 1))
-        echo "** [db-backup] Redis Busy - Waiting and retrying in 5 seconds"
+        print_info "Redis Busy - Waiting and retrying in 5 seconds"
         sleep 5
     done
     generate_md5
@@ -187,11 +179,83 @@ function backup_redis() {
 
 function backup_rethink() {
     TARGET=rethink_${db}_${DBHOST}_${now}.tar.gz
-    echo "** [db-backup] Dumping rethink Database: $db"
+    print_info "Dumping rethink Database: $db"
     rethinkdb dump -f ${TMPDIR}/${TARGET} -c ${DBHOST}:${DBPORT} ${RETHINK_PASS_STR} ${RETHINK_DB_STR}
     move_backup
 }
 
+function check_availability() {
+### Set the Database Type
+   case "$DBTYPE" in
+        "couch" )
+            COUNTER=0
+            while ! (nc -z ${DBHOST} ${DBPORT}) ; do
+                sleep 5
+                let COUNTER+=5
+                print_warn "CouchDB Host '"$DBHOST"' is not accessible, retrying.. ($COUNTER seconds so far)"
+            done
+        ;;
+        "influx" )
+            COUNTER=0
+            while ! (nc -z ${DBHOST} ${DBPORT}) ; do
+                sleep 5
+                let COUNTER+=5
+                print_warn "InfluxDB Host '"$DBHOST"' is not accessible, retrying.. ($COUNTER seconds so far)"
+            done
+        ;;
+        "mongo" )
+            COUNTER=0
+            while ! (nc -z ${DBHOST} ${DBPORT}) ; do
+                sleep 5
+                let COUNTER+=5
+                print_warn "Mongo Host '"$DBHOST"' is not accessible, retrying.. ($COUNTER seconds so far)"
+            done
+        ;;
+        "mysql" )
+            COUNTER=0
+            while true; do
+                mysqlcmd='mysql -u'${DBUSER}' -P '${DBPORT}' -h '${DBHOST}' -p'${DBPASS}
+                out="`$mysqlcmd -e "SELECT COUNT(*) FROM information_schema.FILES;" 2>&1`"
+                echo "$out" | grep -E "COUNT|Enter" 2>&1 > /dev/null
+                if [ $? -eq 0 ]; then
+                    :
+                    break
+                fi
+                print_warn "MySQL/MariaDB Server "$DBHOST" is not accessible, retrying.. ($COUNTER seconds so far)"
+                sleep 5
+                let COUNTER+=5
+            done
+        ;;
+        "pgsql" )
+            # Wait until mongo logs that it's ready (or timeout after 60s)
+            COUNTER=0
+            export PGPASSWORD=${DBPASS} 
+            until pg_isready --dbname=${DBNAME} --host=${DBHOST} --port=${DBPORT} --username=${DBUSER} -q
+            do
+                sleep 5
+                let COUNTER+=5
+                print_warn "Postgres Host '"$DBHOST"' is not accessible, retrying.. ($COUNTER seconds so far)"
+            done
+        ;;
+        "redis" )
+            COUNTER=0
+            while ! (nc -z ${DBHOST} ${DBPORT}) ; do
+                sleep 5
+                let COUNTER+=5
+                print_warn "Redis Host '"$DBHOST"' is not accessible, retrying.. ($COUNTER seconds so far)"
+            done
+        ;;
+        "rethink" )
+            COUNTER=0
+            while ! (nc -z ${DBHOST} ${DBPORT}) ; do
+                sleep 5
+                let COUNTER+=5
+                print_warn "RethinkDB Host '"$DBHOST"' is not accessible, retrying.. ($COUNTER seconds so far)"
+            done
+        ;;
+    esac    
+}
+
 function compression() {
    case "$COMPRESSION" in
         "GZ" | "gz" | "gzip" | "GZIP")
@@ -226,7 +290,7 @@ function move_backup() {
 
 
 ### Container Startup
-echo '** [db-backup] Initialized at at '$(date)
+print_info "Initialized on `date`"
 
 ### Wait for Next time to start backup
   current_time=$(date +"%s")
@@ -257,32 +321,39 @@ echo '** [db-backup] Initialized at at '$(date)
 ### Take a Dump
        case "$DBTYPE" in
         "couch" )
+        check_availability
         backup_couch
         ;;
         "influx" )
+        check_availability
         backup_influx
         ;;
         "mysql" )
+        check_availability
         backup_mysql
         ;;
         "mongo" )
+        check_availability
         backup_mongo
         ;;
         "pgsql" )
+        check_availability
         backup_pgsql
         ;;
         "redis" )
+        check_availability
         backup_redis
         ;;
         "rethink" )
+        check_availability
         backup_rethink
         ;;
         esac
 
 ### Zabbix
     if [ "$ENABLE_ZABBIX" = "TRUE" ] || [ "$ENABLE_ZABBIX" = "true" ];  then
-        zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -k dbbackup.size -o `stat -c%s ${DB_DUMP_TARGET}/${TARGET}`
-        zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -k dbbackup.datetime -o `date -r  ${DB_DUMP_TARGET}/${TARGET} +'%s'`
+        silent zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -k dbbackup.size -o `stat -c%s ${DB_DUMP_TARGET}/${TARGET}`
+        silent zabbix_sender -c /etc/zabbix/zabbix_agentd.conf -k dbbackup.datetime -o `date -r  ${DB_DUMP_TARGET}/${TARGET} +'%s'`
     fi
 
 ### Automatic Cleanup