cycloid/mysql-dump

mysql-dump 镜像文档

1. 镜像概述与主要用途

mysql-dump 是一个基于 https://github.com/talset/docker-mysql-backup-s3 项目构建的Docker镜像，主要用于MySQL数据库的定时备份与恢复。该镜像通过awscli或Scaleway CLI工具，将MySQL数据库备份文件（经gzip压缩）存储至AWS S3或Scaleway对象存储，并支持在Docker或Kubernetes环境中运行。

2. 核心功能与特性

• 定时备份：通过cron任务按指定时间规则自动执行MySQL备份
• 数据处理：对MySQL数据库执行mysqldump并使用gzip压缩备份文件
• 对象存储集成：支持将备份文件上传至AWS S3或Scaleway对象存储
• 手动操作：提供手动触发备份和恢复数据库的脚本
• 环境适配：兼容Docker容器化部署和Kubernetes集群环境

3. 使用场景与适用范围

• 定时备份需求：需定期（如每日凌晨）备份MySQL数据库的业务场景
• 容器化环境：Docker单机部署或Kubernetes集群中的MySQL数据库备份
• 云存储用户：使用AWS S3或Scaleway对象存储作为备份介质的场景
• 应急恢复：需要快速从对象存储恢复历史备份数据的场景

4. 使用方法与配置说明

4.1 容器启动流程

容器启动后，按以下流程执行备份操作：

1. 定时触发：基于BACKUP_TIME环境变量配置的cron表达式定时触发备份
2. 数据备份：执行mysqldump命令导出指定MySQL数据库数据
3. 压缩处理：使用gzip压缩备份文件，文件名基于FILENAME配置生成
4. 上传存储：通过AWS CLI或Scaleway CLI将压缩文件上传至指定对象存储

4.2 手动备份与恢复

4.2.1 手动执行备份

进入运行中的容器，执行以下命令手动触发备份：

bash
./backup

4.2.2 恢复数据库

进入运行中的容器，执行以下命令从对象存储恢复指定备份文件（需指定备份文件在存储桶中的路径）：

bash
./restore path/inside-bucket/example.sql.gz

4.3 配置参数（环境变量）

5. 部署示例

5.1 Docker run 命令示例（AWS S3存储）

bash
docker run -d \
  --name mysql-dump \
  -e MYSQL_HOST=mysql-service \
  -e MYSQL_TCP_PORT=3306 \
  -e MYSQL_USER=backupuser \
  -e MYSQL_PWD=backuppassword \
  -e MYSQL_DATABASE=targetdb \
  -e BACKUP_TIME="0 3 * * *" \  # 每日凌晨3点执行备份
  -e FILENAME="mysql_backup_%Y-%m-%d" \
  -e AWS_ACCESS_KEY_ID=AKIAEXAMPLE \
  -e AWS_SECRET_ACCESS_KEY=secretkeyexample \
  -e AWS_S3_BUCKET=my-backup-bucket \
  -e AWS_DEFAULT_REGION=us-west-2 \
  cycloid/mysql-dump

5.2 Docker Compose 配置示例（Scaleway存储）

yaml
version: '3'
services:
  mysql-dump:
    image: cycloid/mysql-dump
    container_name: mysql-dump
    environment:
      - MYSQL_HOST=mysql  # 假设与MySQL服务在同一网络，服务名为mysql
      - MYSQL_TCP_PORT=3306
      - MYSQL_USER=root
      - MYSQL_PWD=rootpassword
      - MYSQL_DATABASE=appdb
      - BACKUP_TIME="*/30 * * * *"  # 每30分钟执行一次备份
      - BACKUP_DIR=/backup  # 可挂载卷持久化临时备份文件
      - FILENAME="appdb_backup_%Y%m%d_%H%M%S"
      - SCW_ACCESS_KEY=SCWEXAMPLEKEY
      - SCW_SECRET_KEY=scwsecretkeyexample
      - SCW_DEFAULT_ORGANIZATION_ID=org-xxxxxx
      - SCW_DEFAULT_REGION=fr-par
    volumes:
      - ./backup:/backup  # 挂载本地目录作为临时备份目录
    restart: unless-stopped

6. 镜像构建方法

如需自定义构建镜像，执行以下命令：

bash
# 构建镜像
sudo docker build -t cycloid/mysql-dump .

# 推送镜像至仓库（需先登录镜像仓库）
sudo docker push cycloid/mysql-dump