weseek/mongodb-awesome-backup

mongodb-awesome-backup Docker镜像文档

镜像概述和主要用途

mongodb-awesome-backup是一个脚本集合，用于将MongoDB数据库备份到Amazon S3或Google Cloud Storage。它支持设置自定义S3端点，可用于DigitalOcean Spaces等S3兼容服务，提供灵活的云存储备份解决方案。

核心功能和特性

• 支持备份MongoDB数据到Amazon S3或Google Cloud Storage
• 允许配置自定义S3端点，兼容S3协议的存储服务（如DigitalOcean Spaces）
• 提供定时备份功能（cron模式），可按指定时间表达式自动执行备份
• 支持从备份文件恢复数据库
• 多种认证方式：AWS IAM密钥、GCP服务账号密钥、GCP HMAC密钥及OAuth认证

使用场景和适用范围

• 生产环境MongoDB数据库的定期备份
• 需要将MongoDB数据存储到云存储服务的场景
• 对备份有定时需求的自动化运维场景
• 需要从云存储备份文件恢复数据的应急场景

使用方法和配置说明

前提条件

AWS认证

• 需提供具有目标S3存储桶访问权限的Amazon IAM Access Key ID和Secret Access Key

GCP认证

• 服务账号认证：需提供GCP_SERVICE_ACCOUNT_KEY_JSON_PATH和GCP_PROJECT_ID
• HMAC认证：需提供GCP_ACCESS_KEY_ID、GCP_SECRET_ACCESS_KEY和GCP_PROJECT_ID
• OAuth认证：需挂载本地目录（如-v ~:/mab）以保存认证凭据（.boto文件）

基本备份操作

使用以下命令执行一次性备份：

bash
docker run --rm \
  -e AWS_ACCESS_KEY_ID=<您的IAM访问密钥ID> \
  -e AWS_SECRET_ACCESS_KEY=<您的IAM密钥> \
  [ -e GCP_SERVICE_ACCOUNT_KEY_JSON_PATH=<GCP服务账号密钥JSON文件路径> \ ]
  [ -e GCP_ACCESS_KEY_ID=<您的GCP访问密钥> \ ]
  [ -e GCP_SECRET_ACCESS_KEY=<您的GCP密钥> \ ]
  [ -e GCP_PROJECT_ID=<您的GCP项目ID> \ ]
  -e TARGET_BUCKET_URL=<目标存储桶URL ([s3://...|gs://...])> \
  [ -e BACKUPFILE_PREFIX=<备份文件名前缀 (默认: "backup") \ ]
  [ -e MONGODB_URI=<目标MongoDB URI> \ ]
  [ -e MONGODB_HOST=<目标MongoDB主机 (默认: "mongo")> \ ]
  [ -e MONGODB_DBNAME=<目标数据库名称> \ ]
  [ -e MONGODB_USERNAME=<数据库登录用户名> \ ]
  [ -e MONGODB_PASSWORD=<数据库登录密码> \ ]
  [ -e MONGODB_AUTHDB=<认证数据库名称> \ ]
  [ -e AWSCLI_ENDPOINT_OPT=<S3端点URL (例如 https://fra1.digitaloceanspaces.com)> \ ]
  [ -v ~:/mab \ ]
  weseek/mongodb-awesome-backup

执行后，备份文件（格式：backup-YYYYMMdd.tar.bz2）将保存到目标存储桶。

定时备份（cron模式）

设置CRONMODE=true并指定CRON_EXPRESSION以启用定时备份：

bash
docker run --rm \
  -e AWS_ACCESS_KEY_ID=<您的IAM访问密钥ID> \
  -e AWS_SECRET_ACCESS_KEY=<您的IAM密钥> \
  [ -e GCP_SERVICE_ACCOUNT_KEY_JSON_PATH=<GCP服务账号密钥JSON文件路径> \ ]
  [ -e GCP_ACCESS_KEY_ID=<您的GCP访问密钥> \ ]
  [ -e GCP_SECRET_ACCESS_KEY=<您的GCP密钥> \ ]
  [ -e GCP_PROJECT_ID=<您的GCP项目ID> \ ]
  -e TARGET_BUCKET_URL=<目标存储桶URL ([s3://...|gs://...])> \
  -e CRONMODE=true \
  -e CRON_EXPRESSION=<Cron表达式 (例如 "0 4 * * *" 表示每天4:00执行)> \
  [ -e BACKUPFILE_PREFIX=<备份文件名前缀 (默认: "backup") \ ]
  [ -e MONGODB_URI=<目标MongoDB URI> \ ]
  [ -e MONGODB_HOST=<目标MongoDB主机 (默认: "mongo")> \ ]
  [ -e MONGODB_DBNAME=<目标数据库名称> \ ]
  [ -e MONGODB_USERNAME=<数据库登录用户名> \ ]
  [ -e MONGODB_PASSWORD=<数据库登录密码> \ ]
  [ -e MONGODB_AUTHDB=<认证数据库名称> \ ]
  [ -e AWSCLI_ENDPOINT_OPT=<S3端点URL (例如 https://fra1.digitaloceanspaces.com)> \ ]
  [ -v ~:/mab \ ]
  weseek/mongodb-awesome-backup

恢复操作

使用restore命令从备份文件恢复数据库：

bash
docker run --rm \
  -e AWS_ACCESS_KEY_ID=<您的IAM访问密钥ID> \
  -e AWS_SECRET_ACCESS_KEY=<您的IAM密钥> \
  [ -e GCP_SERVICE_ACCOUNT_KEY_JSON_PATH=<GCP服务账号密钥JSON文件路径> \ ]
  [ -e GCP_ACCESS_KEY_ID=<您的GCP访问密钥> \ ]
  [ -e GCP_SECRET_ACCESS_KEY=<您的GCP密钥> \ ]
  [ -e GCP_PROJECT_ID=<您的GCP项目ID> \ ]
  -e TARGET_BUCKET_URL=<目标存储桶URL ([s3://...|gs://...])> \
  -e TARGET_FILE=<要恢复的S3或GS文件名> \
  [ -e MONGODB_URI=<目标MongoDB URI> \ ]
  [ -e MONGODB_HOST=<目标MongoDB主机 (默认: "mongo")> \ ]
  [ -e MONGODB_DBNAME=<目标数据库名称> \ ]
  [ -e MONGODB_USERNAME=<数据库登录用户名> \ ]
  [ -e MONGODB_PASSWORD=<数据库登录密码> \ ]
  [ -e MONGODB_AUTHDB=<认证数据库名称> \ ]
  [ -e MONGORESTORE_OPTS=<mongorestore选项列表> \ ]
  [ -e AWSCLI_ENDPOINT_OPT=<S3端点URL (例如 https://fra1.digitaloceanspaces.com)> \ ]
  [ -v ~:/mab \ ]
  weseek/mongodb-awesome-backup restore

环境变量配置

适用于backup、prune、list命令

必填变量

可选变量

适用于restore命令

必填变量

可选变量