kukuruser/rancher-mysqldump

MySQL安全备份容器

镜像概述

该容器旨在安全转储MySQL数据库，利用Rancher Secrets进行密码管理，并通过Rancher Container Cron实现定时备份。适用于需要在Rancher、Kubernetes或Docker环境中自动化、安全地执行MySQL数据库备份的场景。

核心功能与特性

• 安全认证：集成Rancher Secrets管理数据库密码，避免明文存储
• 定时执行：支持通过Rancher Container Cron设置备份周期
• 灵活配置：通过环境变量自定义备份参数，如数据库用户、主机、端口等
• 分文件备份：支持按数据库生成单独备份文件
• 备份控制：可通过创建.skip文件临时跳过备份任务
• 参数传递：支持直接向mysqldump传递额外参数
• 日志级别控制：可配置输出日志详细程度

使用场景

• Rancher环境下MySQL数据库的定期自动备份
• 需要安全管理数据库凭证的生产环境备份
• 多数据库实例的批量备份与管理
• 需要自定义备份频率和存储路径的场景

前提条件

1. 已部署Rancher，使用Cattle作为编排器
2. 已安装Rancher Secrets插件
3. 已安装Rancher Container Cron插件
4. MySQL中创建具有备份权限的用户（需全局SELECT和LOCK TABLES权限）

使用方法

命令行选项

执行./mysqldump时支持以下选项：

• -v：启用详细模式，执行时打印脚本
• -d, --debug：启用调试模式
• -h, --help：显示帮助信息
• -n, --no-color：禁用彩色输出
• -z, --dry-run：打印执行计划但不实际执行

环境变量配置

基于Secret/ConfigMap

• SECRET_FILE：密码文件路径（位于/run/secrets目录下，默认值：db_pass）

基于工作负载环境变量

注意：备份文件命名格式固定为%Y_%m_%d_%H_%M_%S（如2024_05_20_14_30_00.sql）

特殊配置说明

• 命令行参数优先级：若同时通过命令行和环境变量设置--user或--host，环境变量将覆盖命令行参数
• 分文件备份：当FILE_PER_DB=1时，必须通过DATABASES指定数据库列表，且不能在命令行指定数据库，备份文件将以{数据库名}.sql格式保存
• 跳过备份：在OUTPUT_DIR目录下创建.skip文件可临时跳过本次备份任务
• 传递mysqldump参数：使用--分隔脚本选项和mysqldump参数，例如：-z -- --no-data（仅打印执行计划且不备份数据）

部署示例

Rancher环境部署步骤

1. 创建Secret：存储数据库备份用户密码，例如命名为prod_db_backup_password_v0
2. 创建Stack：命名为backup
3. 创建Service：命名为mysqldump-prod，配置如下：
   • 命令标签页：设置环境变量（至少包含DB_USER、DB_HOST），控制台设置为"None"，自动重启设置为"Never"
   • 卷标签页：挂载持久存储到/dump（建议使用Rancher NFS实现多服务器共享）
   • Secrets标签页：将prod_db_backup_password_v0挂载为db_pass
   • 标签标签页：添加标签cron.schedule: @every 6h（每6小时执行一次）
4. 启动服务：容器将执行备份后自动停止，可在容器日志中查看输出

Docker run示例

bash
docker run -d \
  -e DB_USER=backupuser \
  -e DB_HOST=mysql-prod \
  -e DB_PORT=3306 \
  -e OUTPUT_DIR=/dump \
  -e FILE_PER_DB=1 \
  -e DATABASES="db1 db2" \
  -v /host/dump:/dump \
  -v /run/secrets/db_pass:/run/secrets/db_pass \
  --label cron.schedule="@every 6h" \
  your-image-name

注意事项

• 不同数据库服务器建议使用独立Secret存储密码，即使用户名和密码相同
• 持久化存储需确保有足够空间存放备份文件
• 定期检查备份日志确保任务正常执行
• 备份文件建议定期迁移至离线存储以提高数据安全性

该镜像基于mobeatsglobal/rancher-mysqldump进行重构优化。