FlowKit 镜像文档

镜像概述和主要用途

FlowKit是基于FlowDB构建的Docker镜像，预集成低容量测试数据，旨在为开发、测试和演示场景提供便捷的数据库环境。该镜像免去了手动准备测试数据的步骤，可直接启动并使用包含基础测试数据集的FlowDB实例，适用于快速搭建开发环境、执行功能测试或演示系统功能。

核心功能和特性

• 预配置测试数据：内置低容量、标准化的测试数据集，覆盖常见业务场景，开箱即可用于功能验证。
• 即开即用：无需手动配置数据库或导入测试数据，启动容器后直接连接使用。
• 轻量级设计：测试数据量小，镜像体积可控，适合本地开发环境和资源有限的测试场景。
• FlowDB兼容性：完全兼容FlowDB的原生功能和接口，支持标准数据库操作。
• 隔离性强：容器化部署确保测试环境与生产环境隔离，避免数据干扰。

使用场景和适用范围

适用场景

• 开发阶段功能测试：开发人员无需手动创建测试数据，直接基于预配置数据验证功能逻辑。
• 自动化测试环境：集成到CI/CD流程，为单元测试、集成测试提供一致的数据库环境。
• 演示与培训：快速搭建可操作的演示环境，用于产品展示或新手培训。

不适用场景

• 生产环境（测试数据安全性和性能不满足生产要求）
• 大规模数据压力测试（低容量数据无法模拟高负载场景）

使用方法和配置说明

基本使用

启动容器

通过以下命令启动FlowKit容器，默认暴露FlowDB的标准端口（假设为5432，具体端口需根据FlowDB原生配置调整）：

bash
docker run -d --name flowkit-test -p 5432:5432 flowkit:latest

连接数据库

容器启动后，可通过数据库客户端连接，默认访问参数（具体需根据FlowDB配置调整）：

• 主机：localhost
• 端口：5432
• 数据库名：flowdb_test
• 用户名：flowuser（默认用户，具体以镜像配置为准）
• 密码：flowpass（默认密码，具体以镜像配置为准）

数据持久化

若需保留测试数据修改，可通过挂载本地目录实现数据持久化：

bash
docker run -d --name flowkit-test -p 5432:5432 -v /本地路径:/var/lib/flowdb flowkit:latest

环境变量配置

支持通过环境变量自定义容器行为（具体变量需参考FlowDB***文档，以下为常见配置示例）：

示例：自定义用户和密码启动

bash
docker run -d --name flowkit-test \
  -p 5432:5432 \
  -e FLOWDB_USER=devuser \
  -e FLOWDB_PASSWORD=devpass \
  flowkit:latest

停止与清理

停止并删除容器（非持久化数据将随容器删除）：

bash
docker stop flowkit-test && docker rm flowkit-test

查看日志

通过以下命令查看容器运行日志，排查连接或启动问题：

bash
docker logs flowkit-test

注意事项

• 测试数据仅用于开发测试，请勿包含敏感信息。
• 容器重启后，非持久化数据将重置为初始测试数据。
• 如需自定义测试数据，可通过挂载外部SQL脚本或数据文件覆盖默认数据。