maestro

环境要求

• JDK 环境（仓库自带 Gradle Wrapper，用 ./gradlew 执行）
• 本地运行 AWS 模块或 extensions 时需安装 Docker 与 Docker Compose
• 使用 Kubernetes 支持时需本机 kubectl 可用且已配置 kubeconfig
• 可选：Python 环境，用于安装 maestro-sdk

安装与启动步骤

1. 1获取项目源码

   克隆 Netflix/maestro 仓库并进入项目根目录，后续所有 gradlew 命令都要在此目录执行。

   git clone https://github.com/Netflix/maestro.git
   cd maestro

   复制

2. 2本地启动 maestro

   在项目根目录用 Gradle Wrapper 启动服务，默认监听 8080 端口；首次运行会下载依赖，耗时较长。

   ./gradlew bootRun

   复制

3. 3触发示例工作流

   服务起来后用 curl 调用 API 手动启动内置示例 DAG，请求头 user 标识操作者。

   curl --header "user: tester" -X POST 'http://127.0.0.1:8080/api/v3/workflows/sample-dag-test-1/versions/latest/actions/start' -H "Content-Type: application/json" -d '{"initiator": {"type": "manual"}}'

   复制

4. 4启动 AWS 本地依赖

   使用仓库自带 compose 文件拉起 AWS 相关依赖（extensions 场景下为 LocalStack，提供本地 SQS/SNS）。

   docker compose -f maestro-aws/docker-compose.yml up

   复制

5. 5以 aws profile 启动

   加上 spring.profiles.active=aws 参数重新启动服务，使其连接上一步拉起的 AWS 组件。

   ./gradlew bootRun --args='--spring.profiles.active=aws'

   复制

6. 6启动 extensions 服务

   先拉起 LocalStack，再分别启动 maestro-server（8080）与 maestro-extensions（8081，消费 SQS 事件做 foreach 扁平化）。

   docker compose -f maestro-aws/docker-compose.yml up -d
   ./gradlew :maestro-server:bootRun --args='--spring.profiles.active=aws'
   ./gradlew :maestro-extensions:bootRun

   复制

7. 7Kubernetes 支持

   先确保 kubectl 可用，再启动服务，并上传 sample-kubernetes-wf.json 工作流定义后手动启动它。

   ./gradlew bootRun
   curl --header "user: tester" -X POST 'http://127.0.0.1:8080/api/v3/workflows' -H "Content-Type: application/json" -d @maestro-server/src/test/resources/samples/sample-kubernetes-wf.json
   curl --header "user: tester" -X POST 'http://127.0.0.1:8080/api/v3/workflows/sample-kubernetes-wf/versions/latest/actions/start' -H "Content-Type: application/json" -d '{"initiator": {"type": "manual"}}'

   复制

8. 8安装 Python SDK

   如需在 Python 中调用 Maestro，可单独安装官方 SDK 包 maestro-sdk。

   pip install maestro-sdk

   复制

关键配置

如何确认成功

服务启动后访问 127.0.0.1:8080 的 API，示例工作流触发成功且无报错即表示运行正常。

常见问题

注意事项

• 必须在项目根目录执行 ./gradlew 命令，子模块命令要用 :maestro-server、:maestro-extensions 前缀。
• AWS 场景需同时指定 --spring.profiles.active=aws，否则不会加载对应模块配置。
• Kubernetes 示例工作流需先 POST 上传定义文件，再调用 actions/start 触发。
• README 未给出 JDK 版本要求，如构建失败请优先检查本地 Java 环境。