zettaio/restic-compose-backup

restic-compose-backup

!https://readthedocs.org/projects/restic-compose-backup/badge/?version=latest

为Docker Compose环境提供基于restic的备份解决方案。目前已在docker-ce 17、18和19版本中测试通过。

• https://restic-compose-backup.readthedocs.io
• https://github.com/ZettaIO/restic-compose-backup
• https://hub.docker.com/r/zettaio/restic-compose-backup

核心功能与特性

• 支持备份Docker卷或主机挂载目录
• 支持备份PostgreSQL、MariaDB和MySQL数据库
• 提供邮件/SMTP或*** Webhook通知功能

使用场景与适用范围

适用于Docker Compose环境下的应用数据备份需求，尤其适合需要定期备份容器卷数据和数据库的场景，如Web应用、内容管理系统、数据服务等。

安装

bash
docker pull zettaio/restic-compose-backup

配置（环境变量）

最小配置

bash
RESTIC_REPOSITORY  # restic仓库地址
RESTIC_PASSWORD    # 仓库加密密码

更多配置选项

更多配置选项可参考https://restic-compose-backup.readthedocs.io。

restic后端特定环境变量：https://restic.readthedocs.io/en/stable/040_backup.html#environment-variables

使用方法

Compose示例

通过为容器添加标签来控制备份内容。详细说明见https://restic-compose-backup.readthedocs.io。

restic-backup.env

bash
RESTIC_REPOSITORY=<restic支持的任意后端地址>
RESTIC_PASSWORD=安全的密码
# 快照清理规则
RESTIC_KEEP_DAILY=7
RESTIC_KEEP_WEEKLY=4
RESTIC_KEEP_MONTHLY=12
RESTIC_KEEP_YEARLY=3
# 定时任务计划，每天凌晨1点运行
CRON_SCHEDULE="0 1 * * *"

docker-compose.yaml

yaml
version: '3'
services:
  # 备份服务
  backup:
    image: zettaio/restic-compose-backup:<版本号>
    env_file:
      - restic-backup.env
    volumes:
      # 需要与Docker通信
      - /var/run/docker.sock:/tmp/docker.sock:ro
      # restic缓存的持久化存储（大幅提升操作速度）
      - cache:/cache
  web:
    image: some_image
    labels:
      # 启用以下卷的备份
      restic-compose-backup.volumes: true
    volumes:
      - media:/srv/media
      - /srv/files:/srv/files
  mariadb:
    image: mariadb:10
    labels:
      # 启用此数据库的备份
      restic-compose-backup.mariadb: true
    env_file:
      mariadb-credentials.env
    volumes:
      - mysqldata:/var/lib/mysql
  mysql:
    image: mysql:5
    labels:
      # 启用此数据库的备份
      restic-compose-backup.mysql: true
    env_file:
      mysql-credentials.env
    volumes:
      - mysqldata:/var/lib/mysql

  postgres:
    image: postgres
    labels:
      # 启用此数据库的备份
      restic-compose-backup.postgres: true
    env_file:
      postgres-credentials.env
    volumes:
      - pgdata:/var/lib/postgresql/data

volumes:
  media:
  mysqldata:
  mariadbdata:
  pgdata:
  cache:

rcb命令

所有操作通过rcb命令控制。配置标签并重启相关服务后，可使用status子命令查看备份配置状态：

bash
$ docker-compose run --rm backup rcb status
INFO: Status for compose project 'myproject'
INFO: Repository: '<restic repository>'
INFO: Backup currently running?: False
INFO: --------------- Detected Config ---------------
INFO: service: mysql
INFO:  - mysql (is_ready=True)
INFO: service: mariadb
INFO:  - mariadb (is_ready=True)
INFO: service: postgres
INFO:  - postgres (is_ready=True)
INFO: service: web
INFO:  - volume: media
INFO:  - volume: /srv/files

status子命令会列出将要备份的内容，并检查数据库服务的可用性。容器内也可直接使用restic命令。

更多rcb命令见https://restic-compose-backup.readthedocs.io。

运行测试

bash
pip install -e ./src/
pip install -r src/tests/requirements.txt
tox

构建文档

bash
pip install -r docs/requirements.txt
python src/setup.py build_sphinx

本地开发设置

Git仓库包含简单的本地开发环境设置：

bash
# 创建覆盖网络以连接compose项目和stack
docker network create --driver overlay --attachable global
# 启动compose项目
docker-compose up -d
# 部署stack
docker stack deploy -c swarm-stack.yml test

开发时建议手动启动备份容器：

bash
docker-compose run --rm backup sh
# 在容器中以可编辑模式安装包，实现主机源码变更自动同步
pip3 install -e .

开发时需通过docker swarm init/join启用swarm模式，必要时使用docker swarm leave --force禁用（单节点设置）。

贡献

欢迎任何经验水平的贡献者。欢迎提交问题、部分或完整的拉取请求。

本项目由zetta.io赞助

https://raw.githubusercontent.com/ZettaIO/restic-compose-backup/master/.github/logo.png]([***]