sitapati/zbctl
sitapati
Zeebe命令行界面(CLI)的Docker容器化版本，用于与Zeebe broker交互，执行部署工作流、创建作业实例、管理作业生命周期及查看集群状态等维护任务。
2 次收藏下载次数: 0状态：社区镜像维护者：sitapati仓库类型：镜像最近更新：1 年前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
zbctl Docker镜像文档
镜像概述和主要用途
zbctl是Zeebe的命令行界面(CLI)工具，用于与Zeebe broker交互执行各类维护任务。本Docker镜像提供容器化版本，无需通过NPM安装即可使用，适用于CI环境、本地开发或快速访问zbctl的场景。
核心功能和特性
- 工作流部署：通过BPMN或YAML文件部署工作流至Zeebe broker
- 工作流实例管理：创建、取消工作流实例
- 作业生命周期管理：激活、完成、失败作业
- 变量与重试管理：更新作业变量和重试次数
- 集群监控：查看Zeebe集群当前状态
- 消息操作：向Zeebe broker发布消息
- 文档生成：生成zbctl相关文档
使用场景和适用范围
- CI/CD环境：自动化流程中与Zeebe集群交互（如部署工作流）
- 本地开发测试：无需安装NPM环境，快速验证Zeebe功能
- 集群日常维护：执行工作流部署、作业管理、状态监控等常规任务
使用方法和配置说明
基础使用语法
bashdocker run [选项] sitapati/zbctl [zbctl选项] [命令]
Docker运行示例（Camunda Cloud集群）
从https://console.cloud.camunda.io/%E8%8E%B7%E5%8F%96%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E5%90%8E%EF%BC%8C%E6%89%A7%E8%A1%8C%E9%9B%86%E7%BE%A4%E7%8A%B6%E6%80%81%E6%A3%80%E6%9F%A5%EF%BC%9A
bashdocker run --env ZEEBE_ADDRESS=$ZEEBE_ADDRESS \ --env ZEEBE_CLIENT_ID=$ZEEBE_CLIENT_ID \ --env ZEEBE_CLIENT_SECRET=$ZEEBE_CLIENT_SECRET \ --env ZEEBE_AUTHORIZATION_SERVER_URL=$ZEEBE_AUTHORIZATION_SERVER_URL \ docker.xuanyuan.run/sitapati/zbctl status
环境变量配置
| 环境变量 | 描述 | 默认值 |
|---|---|---|
ZEEBE_ADDRESS | Zeebe broker连接地址 | 127.0.0.1:26500 |
ZEEBE_CLIENT_ID | OAuth认证客户端ID | - |
ZEEBE_CLIENT_SECRET | OAuth认证客户端密钥 | - |
ZEEBE_AUTHORIZATION_SERVER_URL | OAuth授权服务器URL | https://login.cloud.camunda.io/oauth/token/ |
ZEEBE_TOKEN_AUDIENCE | 访问令牌目标资源受众 | - |
ZEEBE_CA_CERTIFICATE_PATH | 网关请求验证证书路径 | - |
ZEEBE_CLIENT_CONFIG_PATH | OAuth凭证缓存路径 | /Users/sitapati/.camunda/credentials |
ZEEBE_INSECURE_CONNECTION | 是否使用不安全连接（布尔值） | - |
主要命令列表
| 命令 | 描述 |
|---|---|
activate | 激活资源 |
cancel | 取消资源 |
complete | 完成资源 |
create | 创建资源 |
deploy | 部署BPMN/YAML定义的工作流 |
fail | 使资源失败 |
generate | 生成文档 |
help | 查看命令帮助 |
publish | 发布消息 |
resolve | 解析资源 |
set | 设置资源 |
status | 检查集群状态 |
update | 更新资源 |
version | 打印zbctl版本 |
高级配置示例
本地Zeebe集群状态检查
bashdocker run --network=host docker.xuanyuan.run/sitapati/zbctl status
--network=host使容器使用主机网络，直接访问本地Zeebe broker（默认地址127.0.0.1:26500）
部署本地工作流文件
bashdocker run -v $(pwd):/workflows \ --env ZEEBE_ADDRESS=$ZEEBE_ADDRESS \ --env ZEEBE_CLIENT_ID=$ZEEBE_CLIENT_ID \ --env ZEEBE_CLIENT_SECRET=$ZEEBE_CLIENT_SECRET \ --env ZEEBE_AUTHORIZATION_SERVER_URL=$ZEEBE_AUTHORIZATION_SERVER_URL \ docker.xuanyuan.run/sitapati/zbctl deploy /workflows/workflow.bpmn
-v $(pwd):/workflows将当前目录挂载至容器，使zbctl可访问本地工作流文件
选项说明
| 选项 | 描述 | 环境变量替代 |
|---|---|---|
--address | Zeebe broker连接地址 | ZEEBE_ADDRESS |
--clientId | OAuth客户端ID | ZEEBE_CLIENT_ID |
--clientSecret | OAuth客户端密钥 | ZEEBE_CLIENT_SECRET |
--authzUrl | OAuth授权服务器URL | ZEEBE_AUTHORIZATION_SERVER_URL |
--certPath | 证书验证路径 | ZEEBE_CA_CERTIFICATE_PATH |
--insecure | 使用不安全连接 | ZEEBE_INSECURE_CONNECTION |
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
DockerHub 原生拉取命令
docker pull sitapati/zbctl:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"