monachus/rancher-mysqldump

MySQL备份容器（Kubernetes CronJob版）

镜像概述和主要用途

该容器设计用于通过Kubernetes CronJob将MySQL数据库安全备份到持久卷（PersistentVolume），使用Secret存储数据库凭证，实现自动化、安全的数据库备份流程。

前提条件

1. 已部署可用的Kubernetes集群（Rancher可简化K8s管理，但非必需）。
2. 在MySQL中创建具备备份权限的用户，该用户仅需全局SELECT和LOCK TABLES权限。

核心功能和特性

• 支持通过环境变量灵活配置备份参数
• 可生成单文件备份或按数据库拆分多个备份文件（FILE_PER_DB）
• 支持通过创建.skip文件临时跳过备份任务
• 允许传递额外参数给mysqldump命令（通过--分隔符）
• 提供详细日志输出，可通过LOG_LEVEL调整日志级别（0-7）

使用场景和适用范围

适用于Kubernetes环境中需要定期自动备份MySQL数据库的场景，特别适合生产环境数据库的定时备份，确保数据可恢复性和业务连续性。

使用方法和配置说明

命令参数

执行容器时支持以下参数：

 Help using ./mysqldump

  -v               启用详细模式，打印执行过程
  -d --debug       启用调试模式
  -h --help        显示帮助页面
  -n --no-color    禁用彩色输出
  -z --dry-run     打印执行计划但不实际执行操作

环境变量配置

备份行为通过以下环境变量控制（默认值已标注）：

• DB_PASS：数据库密码（必填）
• DB_USER：数据库用户名（必填）
• DB_HOST：数据库主机地址（必填）
• OUTPUT_DIR：备份文件输出目录 [默认：/dump]
• OUTPUT_FILENAME：备份文件名 [默认：dump.$(date '+%Y%M%d.%H%m').sql]
• FILE_PER_DB：是否按数据库生成单独文件 [默认：0，1表示启用]
• DATABASES：需备份的数据库列表（空格分隔，启用FILE_PER_DB时必填）
• LOG_LEVEL：日志输出级别（0-7）[默认：6]

注意：若命令行参数与环境变量同时设置--user或--host，环境变量将覆盖命令行参数。启用FILE_PER_DB=1时，需指定DATABASES，且不应在命令行中指定数据库，备份文件将以{数据库名}.sql形式保存。

传递参数给mysqldump

可通过--分隔脚本参数和mysqldump参数，例如：

bash
-z -- --no-data  # 仅备份表结构，不包含数据

Kubernetes部署步骤

以下示例演示如何创建CronJob，将MySQL数据库备份到NFS持久卷（挂载路径/dump，使用静态PV prod-db-dump）。

1. 创建命名空间

bash
# 使用Rancher CLI
rancher namespace create backup

# 或使用kubectl（非Rancher环境）
kubectl create ns backup
namespace/backup created

2. 创建存储数据库密码的Secret

bash
# 将密码安全保存到文件（例如使用pbpaste在macOS）
pbpaste > ./DB_PASS

# 创建Secret
kubectl -n backup create secret generic prod-db-backup-password --from-file=./DB_PASS
secret/prod-db-backup-password created

# 安全删除密码文件（若没有srm，使用rm）
srm DB_PASS

3. 创建持久卷（PV）和持久卷声明（PVC）

bash
# 应用PV配置
kubectl apply -f k8s/pv.yaml
persistentvolume/prod-db-dump created

# 应用PVC配置
kubectl apply -f k8s/pvc.yaml
persistentvolumeclaim/prod-db-dump created

4. 创建CronJob

编辑k8s/cronjob.yaml，设置DB_USER、DB_HOST等环境变量及备份调度周期，然后应用：

bash
kubectl apply -f k8s/cronjob.yaml

CronJob将按指定调度周期运行备份任务，默认保留最近10个任务容器，可通过容器日志查看备份执行情况。