cbflow-server 镜像文档

概述

cbflow-server 是一个面向流程自动化的轻量级工作流管理服务器镜像，旨在提供高效、可扩展的工作流编排能力。该镜像基于Alpine Linux构建，体积小巧且资源占用低，支持通过配置文件或API定义工作流，实现任务的自动化调度、依赖管理与执行监控，广泛适用于企业内部流程自动化、数据处理流水线、定时任务管理等场景。

核心功能与特性

• 灵活工作流定义：支持基于YAML/JSON的声明式工作流配置，可定义任务序列、并行执行、条件分支等复杂流程逻辑
• 多任务类型支持：内置对脚本执行（Bash/Python）、HTTP请求、数据库操作（SQL）、消息队列投递等任务类型的支持
• 多样化触发机制：提供定时触发（Cron表达式）、事件触发（WebHook）、手动触发等多种工作流启动方式
• 实时监控与日志：集成工作流执行状态监控面板与详细日志记录，支持日志持久化与导出
• RESTful API接口：提供完整的API接口，支持工作流的创建、启动、暂停、查询等全生命周期管理
• 可扩展架构：支持通过插件机制扩展任务类型与触发方式，满足个性化业务需求

使用场景与适用范围

• 企业流程自动化：如财务审批流程、人事入职流程、工单处理流程等跨部门协作流程
• 数据处理流水线：如ETL数据抽取-转换-加载流程、日志分析与报表生成流程
• 定时任务管理：如系统备份、数据同步、周期性报表发送等定时执行任务
• 微服务协同：作为微服务架构中的流程协调器，实现服务间的任务依赖调度与数据流转

使用方法与配置说明

快速启动

通过以下命令启动基础工作流服务器实例：

bash
docker run -d -p 8080:8080 --name cbflow-server cbflow-server:latest

启动后可通过 http://localhost:8080 访问Web管理界面（默认用户名/密码：admin/admin），或通过 http://localhost:8080/api/v1 访问API端点。

环境变量配置

支持通过环境变量自定义服务参数，常用配置项如下：

示例：启用认证并修改默认端口

bash
docker run -d \
  -p 9000:9000 \
  -e CBFLOW_PORT=9000 \
  -e CBFLOW_AUTH_ENABLED=true \
  -e CBFLOW_ADMIN_PASSWORD=SecurePass123! \
  --name cbflow-server \
  cbflow-server:latest

数据持久化配置

为避免容器重启导致工作流配置与执行日志丢失，需挂载数据存储目录：

bash
docker run -d \
  -p 8080:8080 \
  -v ./cbflow-data:/var/lib/cbflow \  # 持久化数据目录
  --name cbflow-server \
  cbflow-server:latest

挂载后，工作流配置文件（位于容器内 /var/lib/cbflow/workflows）、执行日志（/var/lib/cbflow/logs）将持久化至宿主机 ./cbflow-data 目录。

自定义工作流配置

工作流配置文件需放置于数据目录的 workflows 子目录（如宿主机 ./cbflow-data/workflows），支持热加载（文件更新后自动生效）。以下为典型工作流配置示例（daily_data_process.yaml）：

yaml
name: "每日数据处理流程"
description: "每日凌晨执行数据采集、清洗与入库"
trigger:
  type: "cron"
  schedule: "0 0 * * *"  # Cron表达式：每日0点执行
tasks:
  - id: "data_fetch"
    name: "数据采集"
    type: "http"
    config:
      url: "[***]"
      method: "GET"
      timeout: 30s
      headers:
        Authorization: "Bearer {{API_TOKEN}}"  # 支持环境变量引用
  - id: "data_clean"
    name: "数据清洗"
    type: "script"
    config:
      script_path: "/scripts/clean_data.py"  # 脚本路径（需挂载脚本目录）
      interpreter: "python3"
      args: ["--input", "{{data_fetch.output.file}}"]  # 引用前序任务输出
    depends_on: ["data_fetch"]  # 依赖"数据采集"任务完成
  - id: "data_store"
    name: "数据入库"
    type: "sql"
    config:
      driver: "mysql"
      dsn: "user:password@tcp(db-host:3306)/data_db"
      sql_file: "/sql/insert_data.sql"  # SQL文件路径（需挂载SQL目录）
    depends_on: ["data_clean"]  # 依赖"数据清洗"任务完成

挂载自定义脚本与SQL文件：

bash
docker run -d \
  -p 8080:8080 \
  -v ./cbflow-data:/var/lib/cbflow \
  -v ./scripts:/scripts \  # 挂载本地脚本目录
  -v ./sql:/sql \          # 挂载本地SQL目录
  -e API_TOKEN="your-api-token" \  # 注入工作流所需环境变量
  --name cbflow-server \
  cbflow-server:latest

注意事项

• 生产环境部署时，需通过 CBFLOW_AUTH_ENABLED=true 启用认证，并修改默认管理员密码
• 工作流配置中涉及的敏感信息（如数据库密码、API密钥）建议通过环境变量注入，避免明文存储
• 高并发场景下，可通过调整 CBFLOW_WORKER_COUNT 环境变量（默认4）增加任务执行worker数量
• 如需对外暴露服务，建议结合Nginx反向代理配置HTTPS加密传输