Go to file

Einar Forselv b9d5233510 Do not expose db passwords when pinging		2019-12-05 00:38:58 +01:00
extras	Create release.md	2019-12-03 10:19:09 +01:00
restic_compose_backup	Do not expose db passwords when pinging	2019-12-05 00:38:58 +01:00
tests	Do not filter mounts if volume backup is not enabled	2019-12-04 22:25:09 +01:00
.dockerignore	Finetune dockerignore	2019-12-04 23:46:56 +01:00
.gitignore	Tweak ingores	2019-12-04 23:01:01 +01:00
Dockerfile	Use XDG_CACHE_HOME to control cache dir	2019-12-04 23:49:32 +01:00
README.md	Update README.md	2019-12-04 23:01:06 +01:00
crontab	Sane cron default: Every day at 2am	2019-12-04 03:35:45 +01:00
docker-compose.yaml	Use XDG_CACHE_HOME to control cache dir	2019-12-04 23:49:32 +01:00
entrypoint.sh	Cleanup	2019-11-15 14:23:56 +01:00
pytest.ini	Basic testcase setup	2019-04-15 19:07:14 +02:00
restic_compose_backup.env	Add common env vars to env file	2019-12-04 23:24:35 +01:00
setup.py	Rename project	2019-12-03 09:40:02 +01:00

README.md

restic-compose-backup

WORK IN PROGRESS

Backup using https://restic.net/ for a docker-compose setup.

Automatically detects and backs up volumes, mysql, mariadb and postgres databases in a docker-compose setup. This includes both host mapped volumes and actual docker volumes.

Each service in the compose setup is configured with a label to enable backup of volumes or databases
When backup starts a new instance of the container is created mapping in all the needed volumes. It will copy networks etc to ensure databases can be reached
Volumes are mounted to /volumes/<service_name>/<path> in the backup process container. /volumes is pushed into restic
Databases are backed up from stdin / dumps
Cron triggers backup

Install

docker pull zettaio/restic-compose-backup

.. or clone this repo and build it.

Configuration

Required env variables for restic:

RESTIC_REPOSITORY
RESTIC_PASSWORD

Backend specific env vars : https://restic.readthedocs.io/en/stable/040_backup.html#environment-variables

Volumes

version: '3'
services:
  # The backup service
  backup:
    build: restic-compose-backup
    environment:
      - RESTIC_REPOSITORY=<whatever restic supports>
      - RESTIC_PASSWORD=hopefullyasecturepw
      - RESTIC_KEEP_DAILY=7
      - RESTIC_KEEP_WEEKLY=4
      - RESTIC_KEEP_MONTHLY=12
      - RESTIC_KEEP_YEARLY=3
    env_file:
      - some_other_vars.env
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro

  example:
    image: some_image
    # Enable volume backup with label
    labels:
      restic-compose-backup.volumes: true
    # These volumes will be backed up
    volumes:
      # Docker volume
      - media:/srv/media
      # Host map
      - /srv/files:/srv/files

volumes:
  media:

A simple include and exclude filter is also available.

  example:
    image: some_image
    labels:
      restic-compose-backup.volumes: true
      restic-compose-backup.volumes.include: "files,data"
    volumes:
      # Source don't match include filter. No backup.
      - media:/srv/media
      # Matches include filter
      - files:/srv/files
      - /srv/data:/srv/data

volumes:
  media:
  files:

Exclude

  example:
    image: some_image
    labels:
      restic-compose-backup.volumes: true
      restic-compose-backup.volumes.exclude: "media"
    volumes:
      # Excluded by filter
      - media:/srv/media
      # Backed up
      - files:/srv/files
      - /srv/data:/srv/data

volumes:
  media:
  files:

Databases

Will dump databases directly into restic through stdin. They will appear in restic as a separate snapshot with path /databases/<service_name>/dump.sql or similar.

  mariadb:
    image: mariadb:10
    labels:
      restic-compose-backup.mariadb: true

  mysql:
    image: mysql:5
    labels:
      restic-compose-backup.mysql: true

  postgres:
    image: postgres
    labels:
      restic-compose-backup.postgres: true

Running Tests

python setup.py develop
pip install -r tests/requirements.txt
pytest tests