wimkung/mongodb-backup-s3

mongodb-backup-s3

镜像概述

mongodb-backup-s3是一个Docker镜像，通过运行mongodump命令并结合cronjob实现MongoDB数据的定时备份，并将备份文件存储到AWS S3桶中。本镜像基于https://github.com/halvves/mongodb-backup-s3%E5%88%86%E6%94%AF%E5%BC%80%E5%8F%91%EF%BC%8C%E4%B8%BB%E8%A6%81%E5%A2%9E%E5%8A%A0%E4%BA%86%E5%AF%B9AWS S3 v4授权机制的支持，解决了以下错误：

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

该镜像可与https://github.com/deenoize/nginx-mongo-docker Docker配置良好配合使用。

核心功能与特性

• 定时备份：通过cronjob实现MongoDB数据的周期性自动备份
• S3 v4授权支持：解决AWS S3存储桶的授权机制不兼容问题
• 自动配置：链接MongoDB容器时可自动加载主机、端口、用户名和密码等连接信息
• 初始化操作：支持容器启动时立即执行备份（INIT_BACKUP）或恢复（INIT_RESTORE）
• 跨区域支持：通过环境变量指定S3桶区域，解决跨区域访问的永久重定向问题
• 灵活配置：支持指定备份文件夹、数据库名称、额外备份参数及定时任务时间

使用场景

• 生产环境MongoDB数据库的自动化定时备份
• 开发/测试环境通过S3备份文件快速恢复数据
• 需要将MongoDB数据备份到非标准区域S3桶的场景
• 作为Docker Compose架构中的数据备份服务组件

使用方法

基础使用（docker run）

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=awsaccesskeyid \
  --env AWS_SECRET_ACCESS_KEY=awssecretaccesskey \
  --env BUCKET=mybucketname \
  --env MONGODB_HOST=mongodb.host \
  --env MONGODB_PORT=27017 \
  --env MONGODB_USER=admin \
  --env MONGODB_PASS=password \
  deenoize/mongodb-backup-s3

链接MongoDB容器（自动加载配置）

当与MongoDB容器链接且别名为mongodb时，镜像会尝试自动加载MongoDB连接信息：

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=myaccesskeyid \
  --env AWS_SECRET_ACCESS_KEY=mysecretaccesskey \
  --env BUCKET=mybucketname \
  --env BACKUP_FOLDER=a/sub/folder/path/ \
  --env INIT_BACKUP=true \
  --link my_mongo_db:mongodb \
  deenoize/mongodb-backup-s3

非标准区域S3桶

若S3桶位于非标准区域并出现永久重定向错误，需指定桶区域：

bash
docker run -d \
  --env AWS_ACCESS_KEY_ID=myaccesskeyid \
  --env AWS_SECRET_ACCESS_KEY=mysecretaccesskey \
  --env BUCKET=mybucketname \
  --env BUCKET_REGION=mybucketregion \
  --env BACKUP_FOLDER=a/sub/folder/path/ \
  --env INIT_BACKUP=true \
  --link my_mongo_db:mongodb \
  deenoize/mongodb-backup-s3

Docker Compose配置

自动化备份配置

yaml
mongodbbackup:
  image: 'deenoize/mongodb-backup-s3:latest'
  links:
    - mongodb
  environment:
    - AWS_ACCESS_KEY_ID=myaccesskeyid
    - AWS_SECRET_ACCESS_KEY=mysecretaccesskey
    - BUCKET=my-s3-bucket
    - BACKUP_FOLDER=prod/db/
  restart: always

初始化恢复配置（适用于新实例或开发环境）

yaml
mongodbbackup:
  image: 'deenoize/mongodb-backup-s3:latest'
  links:
    - mongodb
  environment:
    - AWS_ACCESS_KEY_ID=myaccesskeyid
    - AWS_SECRET_ACCESS_KEY=mysecretaccesskey
    - BUCKET=my-s3-bucket
    - 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%E7%9A%84%E5%88%86%E6%94%AF
• https://github.com/tutumcloud/mongodb-backup