egeniq/docker-mysqldump-to-s3

docker-mysqldump-to-s3

镜像概述

docker-mysqldump-to-s3是一个基于debian-slim的Docker镜像，用于将MySQL数据库通过mysqldump工具生成备份文件，并自动上传至AWS S3存储桶。该镜像为原仓库https://github.com/uqlibrary/docker-mysqldump-to-s3%E7%9A%84%E5%88%86%E6%94%AF%E7%89%88%E6%9C%AC%EF%BC%8C%E4%B8%BB%E8%A6%81%E4%BC%98%E5%8C%96%E5%8C%85%E6%8B%AC%EF%BC%9A%E5%9C%A8%E5%A4%87%E4%BB%BD%E6%96%87%E4%BB%B6%E5%90%8D%E4%B8%AD%E6%B7%BB%E5%8A%A0%E5%B0%8F%E6%97%B6%E5%92%8C%E5%88%86%E9%92%9F%E4%BF%A1%E6%81%AF%EF%BC%8C%E4%BB%A5%E5%8F%8A%E5%88%87%E6%8D%A2%E8%87%B3%E8%BD%BB%E9%87%8F%E7%BA%A7%E7%9A%84debian-slim%E5%9F%BA%E7%A1%80%E9%95%9C%E5%83%8F%E3%80%82

核心功能与特性

• 精确命名：备份文件名包含小时和分钟，便于按时间精确追踪备份文件
• 轻量级基础：基于debian-slim构建，镜像体积更小，资源占用更低
• 灵活配置：通过环境变量配置数据库连接信息、S3存储路径及可选的Slack通知
• AWS集成：支持多种AWS凭证配置方式，包括挂载AWS配置目录、环境变量注入或ECS任务IAM角色
• 自定义备份参数：支持通过环境变量指定mysqldump的额外参数

使用场景

• 定期自动备份MySQL数据库并存储至S3
• 跨环境（开发、测试、生产）的数据库备份统一管理
• 需要按时间精确区分备份文件的场景
• 需要备份结果通知（Slack）的自动化运维流程

使用方法与配置说明

前提条件

1. AWS凭证：需具备S3存储桶写入权限的AWS凭证（通过挂载配置目录、环境变量或ECS IAM角色提供）
2. 环境变量：需配置数据库连接信息及S3存储参数
3. 存储卷：需挂载本地卷至容器内/dumps目录，用于临时存储备份文件

环境变量配置

AWS凭证配置方式

1. 挂载AWS配置目录

将本地.aws目录（包含credentials和config文件）挂载至容器/root/.aws：

bash
-v /path/to/local/.aws:/root/.aws

2. 环境变量注入

通过环境变量直接注入AWS访问密钥：

bash
-e AWS_ACCESS_KEY_ID=your_access_key -e AWS_SECRET_ACCESS_KEY=your_secret_key

3. ECS任务IAM角色

在ECS任务定义中为容器配置具有S3写入权限的IAM角色，无需额外凭证配置。

Docker部署示例

docker run命令

bash
docker run -d \
  -v /local/dumps:/dumps \
  -v /local/.aws:/root/.aws \
  -e DBHOST=mysql.example.com \
  -e DBUSER=backupuser \
  -e DBPASS=backuppassword \
  -e DBNAME=targetdb \
  -e S3_BUCKET=my-backup-bucket \
  -e S3_PREFIX=mysql/backups \
  -e PARAMS="--single-transaction --quick" \
  -e SLACK_WEBHOOK=https://hooks.slack.com/services/XXX \
  -e SLACK_CHANNEL=#db-backups \
  -e SLACK_BOTNAME=db-backup-bot \
  docker-mysqldump-to-s3

docker-compose配置

yaml
version: '3'
services:
  mysql-backup:
    image: docker-mysqldump-to-s3
    volumes:
      - ./dumps:/dumps
      - ./aws:/root/.aws
    environment:
      - DBHOST=mysql.example.com
      - DBUSER=backupuser
      - DBPASS=backuppassword
      - DBNAME=targetdb
      - S3_BUCKET=my-backup-bucket
      - S3_PREFIX=mysql/backups
      - PARAMS=--single-transaction --quick
      - SLACK_WEBHOOK=https://hooks.slack.com/services/XXX
      - SLACK_CHANNEL=#db-backups
      - SLACK_BOTNAME=db-backup-bot
    restart: always

备份文件命名格式

备份文件名将自动生成为：${DBNAME}_${YYYYMMDD}_${HHMM}.sql.gz，例如：targetdb_20240520_1430.sql.gz，确保按时间精确区分不同备份。