evermind/restic-backupclient

使用Docker和restic轻松备份

镜像概述和主要用途

该Docker镜像提供了基于restic的备份解决方案，能够简化数据备份流程。它支持文件系统和多种数据库的备份，提供灵活的配置选项和自动化功能，适合个人或企业环境中的数据保护需求。

核心功能和特性

• 自动初始化restic仓库
• 通过环境变量（基本配置）和YAML文件（高级配置）进行灵活配置
• 支持一次性或周期性备份调度
• 自动清理旧备份
• 执行预备份脚本，可选择在出错时终止备份
• 支持多种数据库导出：
  • Elasticsearch（可通过正则表达式包含/排除索引）
  • MySQL（可通过正则表达式包含/排除数据库）
  • PostgreSQL（可通过正则表达式包含/排除数据库）
  • MongoDB
  • InfluxDB
• 排除缓存文件（遵循[***]

卷配置

• /etc/localtime: 从主机挂载，只读，用于获取正确时区
• /backup: ***卷，用于存储备份数据
• 其他需要备份的文件：挂载到/backup/something目录
• 数据库导出目录（自动管理，每次备份前重建）：
  • Elasticsearch: /backup/elasticdump
  • MySQL: /backup/mysqldump
  • PostgreSQL: /backup/pgdump
  • MongoDB: /backup/mongodump
  • InfluxDB: /backup/influxdump

命令和参数

• 默认命令: "/scripts/backup_client.py schedule @daily"（每天00:00执行备份）
• 可用参数:
  • run: 立即执行备份
  • schedule: 执行定期备份，需指定一个或多个cron表达式作为参数

环境变量

• RESTIC_REPOSITORY (必填): 备份目标仓库路径
• RESTIC_PASSWORD (必填): 备份加密密码
• BACKUP_HOSTNAME (必填): 备份使用的主机名标识
• BACKUP_CONFIG (可选): 高级配置YAML文件路径
• Restic特定环境变量 (可选): 如AWS_ACCESS_KEY_ID和AWS_SECRET_ACCESS_KEY等云存储凭证

YAML配置示例

yaml
---

# 旧备份清理规则（至少设置一项）
keep:
  last: 1        # 保留最近1个备份
  daily: 7       # 保留最近7天的日备份
  weekly: 4      # 保留最近4周的周备份
  monthly: 3     # 保留最近3个月的月备份
  yearly: 1      # 保留最近1年的年备份

# 是否排除缓存目录（默认已排除）
exclude-caches: false

# 排除文件模式（详见restic文档）
exclude:
  - *.bak
  - .cache/*

# 预备份脚本
pre-backup-scripts:
  - description: 执行备份前准备工作
    script: |
      echo "执行预备份操作"
      # 可以添加自定义命令
    fail-on-error: true  # 脚本出错时是否终止备份

# 是否忽略inode变化（默认true）
ignore-inode: false

# Elasticsearch导出配置
elasticdump:
  url: https://es.local:9200/
  username: esuser
  password: s3cr3t
  exclude:
    - ^.kibana  # 排除以.kibana开头的索引

# MySQL导出配置
mysqldump:
  host: database.local
  username: root
  password: s3cr3t
  exclude:
    - ^test     # 排除以test开头的数据库
  mysqldump-extra-args:
    - --skip-lock-tables
    - --single-transaction

# PostgreSQL导出配置
pgdump:
  host: database.local
  username: root
  password: s3cr3t
  exclude:
    - ^test     # 排除以test开头的数据库

# MongoDB导出配置
mongodump:
  host: mongodb.local
  username: root
  password: s3cr3t

# InfluxDB导出配置
influxdump:
  host: influxdb.local
  # port默认8088，database不设置则导出所有数据库

使用示例

基本使用（每日备份）

bash
docker run -d \
  --name restic-backup \
  -v /etc/localtime:/etc/localtime:ro \
  -v /data/to/backup:/backup/data \
  -e RESTIC_REPOSITORY=s3:s3.amazonaws.com/my-backup-bucket \
  -e RESTIC_PASSWORD=mysecretpassword \
  -e BACKUP_HOSTNAME=my-server \
  backup-image:latest

立即执行备份

bash
docker run --rm \
  -v /etc/localtime:/etc/localtime:ro \
  -v /data/to/backup:/backup/data \
  -e RESTIC_REPOSITORY=s3:s3.amazonaws.com/my-backup-bucket \
  -e RESTIC_PASSWORD=mysecretpassword \
  -e BACKUP_HOSTNAME=my-server \
  backup-image:latest run

使用高级配置

bash
docker run -d \
  --name restic-backup \
  -v /etc/localtime:/etc/localtime:ro \
  -v /data/to/backup:/backup/data \
  -v /path/to/config.yaml:/config.yaml \
  -e RESTIC_REPOSITORY=s3:s3.amazonaws.com/my-backup-bucket \
  -e RESTIC_PASSWORD=mysecretpassword \
  -e BACKUP_HOSTNAME=my-server \
  -e BACKUP_CONFIG=/config.yaml \
  backup-image:latest schedule "0 3 * * *"

使用场景和适用范围

该镜像适用于：

• 需要定期备份文件系统数据的场景
• 需对多种数据库进行统一备份管理的环境
• 需要自动化备份流程并保留历史版本的需求
• 希望通过加密确保备份数据安全的场景
• 需要灵活配置备份策略（如保留规则、排除项）的用户