Skip to content

QUICKSTART.md

Latest commit

 

History

History
226 lines (167 loc) · 5.59 KB

QUICKSTART.md

File metadata and controls

226 lines (167 loc) · 5.59 KB
Raw

🚀 快速启动指南

1️⃣ 一句话总结

Flow Worker 是一个 Camunda 外部任务执行器，支持云主机管理和漫游迁移工作流，包含自动重试机制和完整的 Docker 部署。

2️⃣ 环境准备（5 分钟）

系统要求

  • Docker 20.10+
  • Docker Compose 1.29+
  • 4GB+ RAM，5GB+ 磁盘空间

安装检查

docker --version && docker-compose --version

3️⃣ 部署（1 分钟）

cd /home/yuan/flowWorker

# 构建镜像
docker build -t flow-worker:1.0.0 .

# 启动所有服务（Camunda 引擎 + Flow Worker）
docker-compose up -d

# 验证服务状态
docker-compose ps

4️⃣ 验证（1 分钟）

# 检查容器是否运行
docker-compose ps

# 查看 Flow Worker 日志
docker-compose logs -f flow-worker --tail 20

5️⃣ 访问服务（即刻）

打开浏览器访问：

服务 地址 凭证
Camunda Cockpit http://localhost:8080/camunda/app/cockpit demo / demo
任务管理 http://localhost:8080/camunda/app/tasklist demo / demo
用户管理 http://localhost:8080/camunda/app/admin demo / demo

6️⃣ 部署工作流

# 自动部署两个工作流
chmod +x deploy.sh && ./deploy.sh

# 或手动验证
curl -u admin:admin http://localhost:8080/engine-rest/process-definition | jq .

7️⃣ 测试工作流

基础工作流

curl -X POST \
  -H "Content-Type: application/json" \
  http://localhost:8080/engine-rest/process-definition/key/cloud-host-workflow/start

漫游迁移工作流

# 使用脚本启动
./start_roaming_migration.sh my-host-001

# 查看日志
docker-compose logs -f flow-worker

📚 关键文档

文档 内容 何时阅读
README.md 项目概览、快速开始 第一次了解项目
DEPLOYMENT.md 详细部署指南、故障排除 部署或遇到问题时
AGENTS.md AI 代理开发指南 扩展功能时
DEPLOYMENT_SUMMARY.md 部署完成清单 验证部署状态

🛠️ 常用命令速查

# 查看日志
docker-compose logs -f flow-worker

# 停止服务
docker-compose stop

# 重启服务
docker-compose restart

# 完全移除（包括数据）
docker-compose down -v

# 扩展 Flow Worker 实例到 3 个
docker-compose up -d --scale flow-worker=3

# 进入容器交互式终端
docker-compose exec flow-worker /bin/bash

📊 工作流概览

基础工作流（cloud-host-workflow）

开始 → 创建主机 → 启动主机 → 停止主机 → 检查状态 → 结束

漫游迁移工作流（cloud-host-roaming-workflow）- 支持重试

开始 → 准备迁移 → 数据迁移(3次重试) → 网络切换 → 验证 → 
  ├─ 成功 → 结束
  └─ 失败 → 回滚 → 结束

🔍 监控和调试

实时查看执行情况

在 Cockpit 中：

  1. 打开 http://localhost:8080/camunda/app/cockpit
  2. 点击 "Processes" 选择工作流
  3. 查看 "Process Instances" 中的执行状态

查看任务失败和重试

# 查看所有异常
docker-compose logs flow-worker | grep -i "error\|exception\|failed"

# 查看重试信息
docker-compose logs flow-worker | grep -i "retry"

🎯 学习路径

第 1 天：快速体验（30 分钟）

  • 按本指南完成部署
  • 在 Cockpit 中启动工作流实例
  • 观察执行过程和变量传递

第 2 天：深入理解（1-2 小时）

  • 阅读 README.md 了解架构
  • 查看 BPMN 工作流定义文件
  • 研究 CloudHostWorker.java 中的 Topic Handler 实现
  • 理解错误处理和重试机制

第 3 天：自定义扩展（2-4 小时）

  • 阅读 AGENTS.md 开发指南
  • 尝试添加新的 Topic Handler
  • 修改重试策略
  • 自定义业务逻辑

第 4 天：生产部署（2-4 小时）

  • 配置生产级数据库（PostgreSQL）
  • 设置日志和监控
  • 配置 HTTPS
  • 进行压力测试

💡 常见问题速查

Q：如何查看执行日志？

docker-compose logs -f flow-worker

Q：如何重启服务？

docker-compose restart

Q：如何添加新的工作流？

  1. 使用 Camunda Modeler 设计 BPMN
  2. 将文件放在项目根目录
  3. 在 deploy.sh 中添加部署命令
  4. 运行 ./deploy.sh

Q：如何修改认证凭证？

编辑 docker-compose.yml 中的 CAMUNDA_USERNAME 和 CAMUNDA_PASSWORD

Q：如何扩展工作能力？

docker-compose up -d --scale flow-worker=5

📞 获取帮助

如遇问题，请：

  1. 查看 DEPLOYMENT.md 的 "故障排除" 章节
  2. 检查容器日志：docker-compose logs
  3. 验证 Camunda 引擎是否正常运行：curl -u admin:admin http://localhost:8080/engine-rest/engine

✅ 部署完成清单

  • 完成 README.md
  • 创建 DEPLOYMENT.md 详细部署指南
  • 创建 AGENTS.md AI 代理指南
  • 创建 docker-compose.yml 容器编排
  • 新增漫游迁移工作流和 5 个新 Handler
  • 实现 3 次自动重试机制
  • 创建部署验证脚本
  • 所有文件验证通过 ✓

🎉 准备好了吗？

cd /home/yuan/flowWorker
docker build -t flow-worker:1.0.0 . && docker-compose up -d

在浏览器打开：http://localhost:8080/camunda 开始使用！

需要详细说明？ 查看 README.md 和 DEPLOYMENT.md
需要开发指南？ 查看 AGENTS.md
需要故障排除？ 查看 DEPLOYMENT.md#故障排除