dbtool Docker镜像文档

镜像概述

dbtool是一个专为CI/CD流程设计的数据库工具镜像，旨在简化开发、测试和部署过程中的数据库管理任务。该镜像集成了常用的数据库操作工具，支持自动化执行数据库迁移、备份、版本控制及测试验证等操作，适用于各类数据库环境（如MySQL、PostgreSQL等），帮助开发团队提升数据库管理效率。

核心功能与特性

• 数据库迁移自动化：支持主流数据库迁移工具（如Flyway、Liquibase），可配置执行版本化迁移脚本
• 数据备份与恢复：提供定时/触发式数据库备份功能，支持备份文件压缩与存储路径自定义
• 数据库测试验证：集成测试框架，可执行SQL单元测试、数据一致性校验等验证任务
• 多数据库支持：兼容MySQL、PostgreSQL、Oracle等主流关系型数据库
• 轻量级设计：基于Alpine或精简基础镜像构建，体积小，启动速度快，适合CI/CD管道集成

使用场景与适用范围

• CI/CD流水线集成：在GitLab CI、Jenkins等CI/CD平台中，作为数据库环节的自动化工具，执行迁移、测试等任务
• 开发环境数据库管理：供开发团队本地或开发服务器快速部署，统一数据库工具版本与配置
• 生产环境数据库运维：用于自动化执行数据库备份、迁移验证等运维操作，降低人工干预风险
• 数据库版本控制：配合代码版本管理，实现数据库 schema 与代码的同步版本控制

使用方法与配置说明

基本使用（Docker Run）

bash
docker run --rm \
  -e DB_TYPE=mysql \
  -e DB_HOST=db.example.com \
  -e DB_PORT=3306 \
  -e DB_USER=admin \
  -e DB_PASSWORD=secret \
  -e DB_NAME=app_db \
  gitlab.com/progressoft/cicd5/dbtool:latest \
  migrate up

Docker Compose 配置示例

yaml
version: '3'
services:
  dbtool:
    image: gitlab.com/progressoft/cicd5/dbtool:latest
    environment:
      - DB_TYPE=postgresql
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_USER=postgres
      - DB_PASSWORD=postgres
      - DB_NAME=test_db
      - MIGRATION_DIR=/migrations
    volumes:
      - ./migrations:/migrations  # 挂载本地迁移脚本目录
    depends_on:
      - postgres

  postgres:
    image: postgres:14
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=test_db

环境变量配置

常用命令

• 执行数据库迁移：docker run ... gitlab.com/progressoft/cicd5/dbtool:latest migrate up
• 生成数据库备份：docker run ... gitlab.com/progressoft/cicd5/dbtool:latest backup create
• 运行数据库测试：docker run ... gitlab.com/progressoft/cicd5/dbtool:latest test run
• 查看帮助：docker run --rm gitlab.com/progressoft/cicd5/dbtool:latest --help

注意事项

• 运行时需确保容器与目标数据库网络连通，可通过--network参数指定网络
• 敏感信息（如数据库密码）建议通过CI/CD平台的环境变量加密功能传递，避免明文配置
• 迁移脚本建议通过卷挂载方式传入，确保脚本版本与代码版本同步
• 不同数据库类型可能需要额外依赖，使用时请确认DB_TYPE配置与目标数据库匹配