zoov/mongodb-gcs-backup

mongodb-gcs-backup

镜像概述

本镜像提供简单方式，通过mongo-tools执行MongoDB服务器/数据库备份，并将归档文件上传至Google Cloud Storage（GCS）。项目受https://github.com/takemetour/docker-mongodb-gcs-backup启发，同时支持Kubernetes环境（通过仓库`chart`目录的helm chart实现部署）。

核心功能

1. 支持MongoDB单库或全库备份（基于mongodump）
2. 将备份归档上传至指定GCS桶
3. 可选Slack告警（备份失败时发送通知）
4. 提供Kubernetes helm chart，便于集群内自动化部署

使用场景

1. 本地MongoDB实例的定期备份需求
2. Kubernetes集群中MongoDB服务的自动化备份
3. 需要将MongoDB备份存储到GCS的场景
4. 需要对备份失败进行实时告警的场景

配置说明

可配置环境变量参数如下：

部署示例

Docker本地运行

1. 拉取镜像：

   bash
   docker pull docker.xuanyuan.run/zoov/mongodb-gcs-backup:latest
   

2. 本地执行备份（需提前配置GCS认证）：

   bash
   GCS_BUCKET=gs://your-bucket \
   MONGODB_HOST=mongodb.example.com \
   ./backup.sh
   

3. 启用Slack告警的示例：

   bash
   SLACK_ALERTS=true \
   SLACK_WEBHOOK_URL=https://hooks.slack.com/services/xxx \
   SLACK_CHANNEL=#backup-alerts \
   GCS_BUCKET=gs://your-bucket \
   ./backup.sh
   

Kubernetes部署（helm）

1. 安装chart：

   bash
   helm install --name my-backup chart/mongodb-gcs-backup
   

2. 卸载chart：

   bash
   helm delete my-backup
   

GCS认证方式

本地环境（gcloud CLI）

通过gcloud初始化认证：

bash
gcloud init --console-only

详细步骤参考https://cloud.google.com/storage/docs/gsutil_install。

Kubernetes环境（服务账号）

1. 创建GCS服务账号并获取JSON密钥。
2. 生成Kubernetes secret：

   bash
   kubectl create secret generic mongodb-gcs-backup \
   --from-file=credentials.json=/path/to/key.json
   

3. 安装chart时指定secret：

   bash
   helm install --name my-backup \
   --set secretName=mongodb-gcs-backup \
   chart/mongodb-gcs-backup
   

密钥默认挂载路径为/secrets/gcp/credentials.json，需确保GCS_KEY_FILE_PATH指向该路径。