zeenlym/mariadb-backup

docker-mariadb-backup镜像说明

本Docker镜像用于MariaDB数据库的备份与恢复操作，提供定时备份、手动备份及数据恢复功能，支持自定义备份方法扩展。

核心功能

• 定时备份：通过cron调度实现每日/定期自动备份
• 手动备份：支持直接执行备份命令触发即时备份
• 数据恢复：可选择指定备份文件或最新备份进行恢复
• 插件扩展：支持自定义备份方法插件，满足多样化需求

使用场景

• 生产环境MariaDB数据库的定期数据保护
• 开发/测试环境数据库的快速备份与恢复
• 需要自动化数据备份的场景

配置说明

环境变量

调度相关

• SCHEDULE（必填）：cron格式的备份调度时间，例如"0 0 3 * *"表示每日3点执行
• TIMEZONE（可选）：设置时区，例如"Asia/Shanghai"

MySQL相关

• MYSQL_HOST（必填）：MySQL/MariaDB主机地址
• MYSQL_USER（必填）：数据库访问用户
• MYSQL_PASSWORD（可选）：数据库用户密码
• MYSQL_DATABASE（可选）：需要备份的数据库名称（留空则备份所有数据库）

备份相关

• BACKUP_METHOD（必填）：备份方法，默认支持"mysqldump"
• BACKUP_OPTS（可选）：备份方法的额外参数

恢复相关

• RESTORE_OPTS（可选）：恢复操作的额外参数（恢复时使用BACKUP_METHOD指定的方法）

部署示例

定时备份

Docker Engine命令

bash
docker run \
  -v ./backup:/backup \
  -e TIMEZONE="Asia/Shanghai" \
  -e SCHEDULE="0 0 3 * *" \
  -e BACKUP_METHOD="mysqldump" \
  -e MYSQL_HOST=mysql \
  -e MYSQL_DATABASE=database \
  -e MYSQL_USER=user \
  -e MYSQL_PASSWORD=pass \
  -t docker.xuanyuan.run/db-backup \
  --detach zeenlym/mariadb-backup

Docker Compose配置

yaml
test-backup:
    image: docker.xuanyuan.run/zeenlym/mariadb-backup
    environment:
        - TIMEZONE=Asia/Shanghai
        - SCHEDULE=0 0 3 * *
        - BACKUP_METHOD=mysqldump
        - MYSQL_HOST=mysql
        - MYSQL_DATABASE=database
        - MYSQL_USER=user
        - MYSQL_PASSWORD=pass
    volumes:
        - ./backup:/backup

手动备份

直接执行备份命令

bash
docker run ... zeenlym/mariadb-backup backup

从运行中的容器执行

bash
docker exec db-backup backup

数据恢复

直接执行恢复命令（选择备份文件）

bash
docker run ... -i -t zeenlym/mariadb-backup restore

从运行中的容器执行（恢复最新备份）

bash
docker exec -it db-backup restore --latest

注意：恢复操作需添加-it参数以支持交互选择备份文件

高级使用

mdbtool工具

mdbtool是镜像中的核心Python程序，支持插件机制以扩展备份方法。执行mdbtool -h可查看帮助信息。

自定义备份插件

1. 插件存储目录：/usr/local/mdbtool/plugins
2. 插件结构：每个插件需包含__init__.py、Backup.py（备份逻辑），可选Restore.py（恢复逻辑）
3. 插件示例：参考默认的mysqldump插件实现

构建自定义镜像

若需添加自定义插件，可基于本镜像构建新镜像：

Dockerfile
FROM zeenlym/mariadb-backup
MAINTAINER 姓名 <***>

COPY myplugin /usr/local/mdbtool/plugins/myplugin