rusxakep/db-backup repository overview

⁠hub.docker.com/r/rusxakep/db-backup

⁠Introduction

This will build a container for backing up multiple type of DB Servers

Currently backs up CouchDB, InfluxDB, MySQL, MongoDB, Postgres, Redis servers.

• dump to local filesystem or backup to S3 Compatible services

• select database user and password

• backup all databases

• choose to have an MD5 sum after backup for verification

• delete old backups after specific amount of time

• choose compression type (none, gz, bz, xz, zstd)

• connect to any container running on the same system

• select how often to run a dump

• select when to start the first dump, whether time of day or relative to container start time

• Execute script after backup for monitoring/alerting purposes

• This Container uses a customized Alpine Linux base⁠ which includes s6 overlay⁠ enabled for PID 1 Init capabilities, zabbix-agent⁠ 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⁠

⁠Authors

• Dave Conroy⁠
• Mikhail Baykov⁠

⁠Table of Contents

• Introduction⁠
  • Changelog⁠
• Prerequisites⁠
• Installation⁠
• Quick Start⁠
• Configuration⁠
  • Data Volumes⁠
  • Environment Variables⁠
• Maintenance⁠
  • Shell Access⁠
  • Custom Scripts⁠

⁠Prerequisites

You must have a working DB server or container available for this to work properly, it does not provide server functionality!

⁠Installation

Automated builds of the image are available on Docker Hub⁠ and is the recommended method of installation.

docker pull rusxakep/db-backup:latest

⁠Quick Start

• The quickest way to get started is using docker-compose⁠. See the examples folder for a working docker-compose.yml⁠ that can be modified for development or production use.

• Set various environment variables⁠ to understand the capabiltiies of this image.

• Map persistent storage⁠ for access to configuration and data files for backup.

⁠Configuration

⁠Data-Volumes

The following directories are used for configuration and can be mapped for persistent storage.

⁠Environment Variables

If you are trying to backup a database that doesn't have a user or a password (you should!) make sure you set CONTAINER_ENABLE_DOCKER_SECRETS=FALSE

Along with the Environment Variables from the Base image⁠, below is the complete list of available options that can be used to customize your installation.

When using compression with MongoDB, only GZ compression is possible.

Backing Up to S3 Compatible Services

If BACKUP_LOCATION = S3 then the following options are used.

⁠Maintenance

Manual Backups can be performed by entering the container and typing backup-now

⁠Shell Access

For debugging and maintenance purposes you may want access the containers shell.

docker exec -it (whatever your container name is e.g.) db-backup bash

⁠Custom Scripts

If you want to execute a custom script at the end of backup, you can drop bash scripts with the extension of .sh in this directory. See the following example to utilize:

$ cat post-script.sh 
##!/bin/bash

## Example Post Script
## $1=DB_TYPE (Type of Backup)
## $2=DB_HOST (Backup Host)
## #3=DB_NAME (Name of Database backed up
## $4=DATE (Date of Backup)
## $5=TIME (Time of Backup)
## $6=BACKUP_FILENAME (Filename of Backup)
## $7=FILESIZE (Filesize of backup)
## $8=MD5_RESULT (MD5Sum if enabled)

echo "${1} Backup Completed on ${2} for ${3} on ${4} ${5}. Filename: ${6} Size: ${7} bytes MD5: ${8}"

Outputs the following on the console:

mysql Backup Completed on example-db for example on 2020-04-22 05:19:10. Filename: mysql_example_example-db_20200422-051910.sql.bz2 Size: 7795 bytes MD5: 952fbaafa30437494fdf3989a662cd40

If you wish to change the size value from bytes to megabytes set environment variable SIZE_VALUE=megabytes