zadig

🚀 Zadig DevOps 平台 API 客户端

Zadig DevOps 平台 API 客户端,支持项目/工作流/环境/服务/构建/测试全生命周期管理,需配置 API URL 与 Token

收藏
3.7k
安装
1.2k
版本
4.0.1
CLS 安全扫描中
预计需要 3 分钟...

使用说明

Zadig Skill 综合评估

核心用法

Zadig Skill 是基于 Zadig OpenAPI 规范实现的 DevOps 平台客户端,提供对 Zadig 企业级 DevOps 平台的完整 API 访问能力。用户需配置 ZADIG_API_URLZADIG_API_KEY 环境变量后方可使用。核心功能覆盖六大模块:项目管理(查看组织架构与权限)、工作流管理(触发构建/部署/测试流水线)、环境管理(查看/操作运行时环境)、服务管理(查看状态、获取日志)、构建管理(查看构建记录与产物)、测试管理(执行测试用例与查看报告)。

技能提供两类 API:基础 CRUD 操作(如 listProjects)和便捷方法(如 getServiceStatusgetServiceLogsSynctriggerWorkflowgetWorkflowTask),后者针对常见场景做了数据聚合与格式优化,大幅降低调用复杂度。

显著优点

1. 一站式 DevOps 集成:覆盖从代码构建到生产部署的完整链路,避免多工具切换
2. 云原生深度支持:原生支持 Kubernetes 服务状态查询、容器日志实时获取、NodePort 端点暴露等云原生场景

3. 工作流即代码:支持通过 API 触发预定义的 YAML 工作流,实现 GitOps 自动化

4. 企业级安全:基于 JWT Token 认证,支持项目级权限隔离

潜在缺点与局限性

1. 强环境依赖:必须预先部署 Zadig 平台并获取 API Token,无法独立运行
2. Token 管理风险:API Key 需手动配置到 .env 文件,存在泄露风险(如误提交到版本控制)

3. 同步日志阻塞getServiceLogsSync 方法可能在大日志量时导致长时间阻塞

4. 厂商锁定:API 设计紧密耦合 Zadig 内部数据结构,迁移成本高

适合人群

  • 已采用 Zadig 作为 DevOps 平台的研发团队
  • 需要自动化流水线触发(如结合 AI Code Review 后自动部署)的开发者
  • 需要批量查询服务状态/日志的运维工程师

常规风险

| 风险类型 | 描述 | 缓解措施 |
|---------|------|---------|
| 凭据泄露 | API Token 写入 `.env` 后被误提交 | 使用 `.gitignore` + secrets 扫描工具 |
| 权限过大 | Token 拥有项目管理员权限时,API 可删除环境/服务 | 创建只读或运维专用 Token |
| 生产环境误操作 | `triggerWorkflow` 可能触发生产部署 | 增加环境确认二次校验 |
| 网络暴露 | API 请求经过 HTTPS,但 Token 在内存中明文 | 避免在共享环境运行 |

zadig 内容

手动下载zip · 10.9 kB
index.jstext/javascript
请选择文件