wetransform/dockup

Dockup

Docker镜像，用于备份和恢复Docker容器卷，支持AWS S3和本地存储，可配置定时任务、加密及通知功能。名称由来：Docker + Backup = Dockup。

相关扩展项目示例：

• https://github.com/wetransform-os/dockup-mongo - 使用mongodump和mongorestore备份和恢复MongoDB实例

核心功能与特性

• 多备份目标：支持AWS S3（默认）和本地存储
• 自动卷检测：可自动识别挂载到容器的卷并备份
• 定时任务：通过Cron表达式配置定期备份
• 备份重试：TAR归档失败时支持自动重试
• 数据加密：使用GnuPG加密备份文件，确保数据安全
• 通知机制：支持Slack通知备份成功/失败状态
• 灵活命令：支持备份前后执行自定义命令，适应复杂场景

使用场景

• 定期备份Docker容器数据卷（如数据库、配置文件）
• 跨环境迁移容器数据
• 实现数据容灾与恢复
• 需要加密保护的敏感数据备份

使用方法

前提条件

确保目标容器已运行并挂载卷，例如：

bash
docker run -d --name mysql tutum/mysql

通过docker inspect mysql查看卷信息，示例输出：

json
"Volumes": {
  "/etc/mysql": {},
  "/var/lib/mysql": {}
}

备份

基本备份命令

bash
docker run --rm \
--env-file env.txt \
--volumes-from mysql \
--name dockup wetransform/dockup:latest

环境变量配置（env.txt）

ini
# AWS S3配置（使用AWS模式时必填）
AWS_ACCESS_KEY_ID=<您的AWS访问密钥>
AWS_SECRET_ACCESS_KEY=<您的AWS密钥>
AWS_DEFAULT_REGION=us-east-1  # 参考下方AWS区域表
S3_BUCKET_NAME=docker-backups.example.com  # S3桶名称
S3_FOLDER=mybackups/  # S3文件夹路径，需以斜杠结尾或留空

# 备份基本配置
BACKUP_NAME=mysql  # 备份名称前缀
PATHS_TO_BACKUP=/etc/mysql /var/lib/mysql  # 需备份的路径，设为"auto"可自动检测卷
RESTORE=false  # 是否恢复（备份时设为false）
DOCKUP_COMPRESS=true  # 是否压缩备份文件

# 备份模式（可选，默认aws）
DOCKUP_MODE=aws  # 或"local"（本地存储）

# 自定义命令（可选）
BEFORE_BACKUP_CMD="echo '开始备份'"  # 备份前执行的命令
AFTER_BACKUP_CMD="echo '备份完成'"   # 备份后执行的命令

# 重试配置（可选）
BACKUP_TAR_TRIES=5  # 最大重试次数（默认5）
BACKUP_TAR_RETRY_SLEEP=30  # 重试间隔秒数（默认30）

# 定时任务（可选）
CRON_TIME=0 0 * * *  # 每天午夜执行备份

本地模式配置

当DOCKUP_MODE=local时，备份文件存储在容器内/dockup/target目录（可通过卷挂载到宿主机）。

本地清理配置：

ini
LOCAL_CLEANUP_OLDER_HOURS=24  # 删除超过24小时的备份（保留最新备份）

恢复

基本恢复命令

bash
docker run --rm \
--env-file restore-env.txt \
--volumes-from mysql \
--name dockup wetransform/dockup:latest

恢复环境变量配置（restore-env.txt）

ini
# 基础配置
RESTORE=true  # 启用恢复模式
BACKUP_NAME=mysql  # 需恢复的备份名称前缀
LAST_BACKUP=mysql_20240101_000000.tar.gz  # （可选）指定备份文件名，默认最新备份

# AWS/S3配置（同备份）
AWS_ACCESS_KEY_ID=<您的AWS访问密钥>
AWS_SECRET_ACCESS_KEY=<您的AWS密钥>
AWS_DEFAULT_REGION=us-east-1
S3_BUCKET_NAME=docker-backups.example.com
S3_FOLDER=mybackups/

# 恢复后命令（可选）
AFTER_RESTORE_CMD="chown -R mysql:mysql /var/lib/mysql"  # 恢复后执行的命令

加密配置

备份加密

需提供GPG公钥：

ini
GPG_KEYRING=/path/to/public-keyring  # 公钥环路径
GPG_KEYNAME=backup-key  # 公钥用户ID

恢复解密

需提供GPG私钥及密码：

ini
GPG_KEYRING=/path/to/public-keyring  # 公钥环路径
GPG_SECRING=/path/to/secret-keyring  # 私钥环路径
GPG_PASSPHRASE=<私钥密码>  # 解密密码

通知配置

Slack通知

ini
NOTIFY_BACKUP_SUCCESS=true  # 启用成功通知
NOTIFY_BACKUP_FAILURE=true  # 启用失败通知
NOTIFY_SLACK_WEBHOOK_URL=https://hooks.slack.com/services/XXX  # Slack Webhook URL

AWS S3区域参考

注意事项

• S3桶命名：需唯一且符合DNS规范，仅含小写字母、数字、连字符和句点，首尾必须为字母或数字，句点不能相邻。
• 本地模式文件安全：确保本地存储目录权限正确，避免未授权访问。
• GPG密钥管理：私钥需安全存储，丢失将导致无法恢复加密备份。
• 卷挂载：恢复时需确保目标容器已创建且卷已挂载，避免数据覆盖。