deenoize/mongodb-backup-s3

mongodb-backup-s3

该镜像用于通过cronjob执行mongodump，将MongoDB数据备份到S3存储桶，并支持AWS S3 v4认证机制。

来源说明

分叉自 https://github.com/halvves/mongodb-backup-s3，解决了以下错误：

A client error (InvalidRequest) occurred when calling the PutObject operation: The authorization mechanism you have provided is not supported. Please use AWS4-HMAC-SHA256.

核心功能

• 定时执行MongoDB备份并上传到S3存储桶
• 支持AWS S3 v4认证机制
• 自动加载关联MongoDB容器的主机、端口、用户名和密码（若链接时使用别名mongodb）
• 支持初始化备份（容器启动时立即备份）
• 支持初始化恢复（容器启动时从最新备份恢复）
• 可禁用定时任务（适用于开发环境数据初始化）

使用场景

• 生产环境MongoDB数据的定时自动备份
• 开发环境从S3备份恢复数据，快速初始化数据库
• 需要兼容AWS S3 v4认证的备份场景

配置说明

以下是主要环境变量参数：

• AWS_ACCESS_KEY_ID: AWS访问密钥ID（用于S3存储桶）
• AWS_SECRET_ACCESS_KEY: AWS秘密访问密钥（用于S3存储桶）
• BUCKET: S3存储桶名称
• BUCKET_REGION: S3存储桶区域（如us-east-2，解决PermanentRedirect错误时使用）
• BACKUP_FOLDER: 备份文件存储的S3文件夹路径（默认根目录）
• MONGODB_HOST: MongoDB主机地址
• MONGODB_PORT: MongoDB端口（默认27017）
• MONGODB_USER: MongoDB用户名（若密码存在但用户名为空，默认使用admin）
• MONGODB_PASS: MongoDB密码
• MONGODB_DB: 要备份的数据库名称（默认备份所有数据库）
• EXTRA_OPTS: mongodump命令的额外参数
• CRON_TIME: 定时备份的Cron表达式（默认0 3 * * *，每天3点执行）
• TZ: 时区（默认US/Eastern）
• CRON_TZ: Cron时区（默认US/Eastern）
• INIT_BACKUP: 容器启动时是否立即执行一次备份（设置为true启用）
• INIT_RESTORE: 容器启动时是否从最新备份恢复（设置为true启用）
• DISABLE_CRON: 是否禁用定时备份（设置为true启用，适用于开发环境）

部署示例

Docker Run 命令

基本使用（手动指定MongoDB信息）

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=your_access_key \
  --env AWS_SECRET_ACCESS_KEY=your_secret_key \
  --env BUCKET=your_bucket_name \
  --env MONGODB_HOST=mongodb_host \
  --env MONGODB_PORT=27017 \
  --env MONGODB_USER=admin \
  --env MONGODB_PASS=your_password \
  docker.xuanyuan.run/deenoize/mongodb-backup-s3

关联MongoDB容器（自动加载信息）

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=your_access_key \
  --env AWS_SECRET_ACCESS_KEY=your_secret_key \
  --env BUCKET=your_bucket_name \
  --env BACKUP_FOLDER=prod/db/ \
  --env INIT_BACKUP=true \
  --link your_mongo_container:mongodb \
  docker.xuanyuan.run/deenoize/mongodb-backup-s3

指定存储桶区域（解决重定向错误）

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=your_access_key \
  --env AWS_SECRET_ACCESS_KEY=your_secret_key \
  --env BUCKET=your_bucket_name \
  --env BUCKET_REGION=us-east-2 \
  --env BACKUP_FOLDER=prod/db/ \
  --env INIT_BACKUP=true \
  --link your_mongo_container:mongodb \
  docker.xuanyuan.run/deenoize/mongodb-backup-s3

Docker Compose 配置

自动定时备份

yaml
version: '3'
services:
  mongodbbackup:
    image: 'docker.xuanyuan.run/deenoize/mongodb-backup-s3:latest'
    links:
      - mongodb
    environment:
      - AWS_ACCESS_KEY_ID=your_access_key
      - AWS_SECRET_ACCESS_KEY=your_secret_key
      - BUCKET=your_bucket_name
      - BACKUP_FOLDER=prod/db/
    restart: always

初始化恢复（禁用定时任务）

yaml
version: '3'
services:
  mongodbbackup:
    image: 'docker.xuanyuan.run/deenoize/mongodb-backup-s3:latest'
    links:
      - mongodb
    environment:
      - AWS_ACCESS_KEY_ID=your_access_key
      - AWS_SECRET_ACCESS_KEY=your_secret_key
      - BUCKET=your_bucket_name
      - BACKUP_FOLDER=prod/db/
      - INIT_RESTORE=true
      - DISABLE_CRON=true

恢复备份

查看备份列表

bash
docker exec mongodb-backup-s3 /listbackups.sh

恢复指定备份（传入备份文件的时间戳部分）

bash
docker exec mongodb-backup-s3 /restore.sh 20170406T155812

恢复最新备份

bash
docker exec mongodb-backup-s3 /restore.sh

致谢

本镜像分叉自 https://github.com/halvves/mongodb-backup-s3，而该镜像又分叉自 https://github.com/futurist 的 https://github.com/tutumcloud/mongodb-backup。