halvves/mongodb-backup-s3

mongodb-backup-s3

镜像概述

本镜像通过mongodump工具结合cron任务，实现MongoDB数据到S3存储桶的定期备份，同时支持初始化备份、恢复操作及灵活的参数配置，适用于MongoDB数据的自动化备份与恢复场景。

核心功能

• 定期自动备份：通过CRON_TIME设置备份频率，默认每日3点执行
• 初始化操作：容器启动时可立即执行备份（INIT_BACKUP）或恢复最新数据（INIT_RESTORE）
• 手动恢复：支持恢复指定时间戳的备份或最新备份
• 自动参数获取：链接MongoDB容器时自动加载主机、端口、用户名和密码
• 灵活配置：通过环境变量设置S3凭证、MongoDB参数、备份路径等

使用场景

• 生产环境MongoDB数据的每日自动备份，保障数据安全
• 开发/测试环境通过恢复S3备份快速初始化数据库
• 需要定期将MongoDB数据备份到云端存储的场景

配置说明

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

• AWS_ACCESS_KEY_ID：S3存储桶的AWS访问密钥ID
• AWS_SECRET_ACCESS_KEY：S3存储桶的AWS秘密访问密钥
• BUCKET：目标S3存储桶名称
• BACKUP_FOLDER：备份文件存储的路径（默认存储在桶根目录）
• MONGODB_HOST：MongoDB数据库的主机/IP地址
• 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 方式

直接配置参数

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

链接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 \
  halvves/mongodb-backup-s3

Docker Compose 方式

自动化备份配置

yaml
mongodbbackup:
  image: 'halvves/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: 'halvves/mongodb-backup-s3:latest'
  links:
    - mongodb
  environment:
    - AWS_ACCESS_KEY_ID=myaccesskeyid
    - AWS_SECRET_ACCESS_KEY=mysecretaccesskey
    - BUCKET=my-s3-bucket\n    - 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/futurist%5Cu5bf9 https://github.com/tutumcloud/mongodb-backup 的 fork 进行开发。