湛兮
44 lines
2.5 KiB
Markdown
44 lines
2.5 KiB
Markdown
# DevOps 运维平台前端 RTK
|
|
|
|
## 项目定位
|
|
|
|
`devops-platform-web` 是 DevOps 运维平台前端，用于统一查看和操作当前项目的部署与发布流程：
|
|
|
|
- `access-manage`
|
|
- `role-admin`
|
|
- `role-user`
|
|
- `my-resume`
|
|
- `devops-platform-api`
|
|
- `devops-platform-web`
|
|
|
|
当前前端只调用 `devops-platform-api`，不再提供本地 mock 数据降级。
|
|
|
|
## 页面结构
|
|
|
|
- `/login`：真实平台账号登录入口，支持 token 恢复和首次改密。
|
|
- `/overview`：总览，展示值班焦点、优先 Run 队列、项目发布健康、服务状态和项目环境快捷入口。
|
|
- `/projects`：项目配置，展示项目可发布性概览、发布态/权限筛选、Gitea 仓库、Jenkins Job、通知通道、环境策略和上下文跳转。
|
|
- `/members`：成员权限，仅超级管理员可见，展示账号/构建权限/安全状态概览，支持成员筛选，并维护普通成员、项目权限和密码重置消息。
|
|
- `/releases`：发布中心，提供发布参数、后端 ref/tag 选择、发布前检查、生产发布确认、触发、取消、重试和发布步骤轨迹。
|
|
- `/runs`：运行记录，展示 run 状态概览、筛选列表、执行详情、步骤轨迹，并支持超级管理员导入 Jenkins 直接构建记录。
|
|
- 顶部 Agent 按钮：打开全局右侧抽屉，只保留 DevOps 场景能力；`/agent` 仅重定向到总览，不作为独立侧边栏入口。
|
|
- `/settings`：系统配置，展示集成配置、Agent、通知 outbox 和审计日志概览，支持通知/审计筛选，并维护后端 Agent 模型配置。
|
|
|
|
## 数据约定
|
|
|
|
- API 封装入口：`src/services/devopsApi.ts`
|
|
- Axios 实例：`src/services/http.ts`
|
|
- 平台状态：`src/stores/platform.ts`
|
|
- 登录状态：`src/stores/session.ts`
|
|
|
|
## 后续接入点
|
|
|
|
- `devopsApi` 所有项目、发布、refs、流程、成员、消息和 Agent 调用均走后端接口。
|
|
- 发布中心触发按钮接入后端发布单创建接口。
|
|
- 运行记录接入后端 run/step 查询接口。
|
|
- Jenkins 直接构建不由前端直连 Jenkins；运行记录页调用后端 `/deploy-runs/import-jenkins` 扫描已纳管 job 并导入 run。
|
|
- 发布步骤轨迹以后端 run steps 为准，前端不再拉取或渲染流程图 XML。
|
|
- Agent 面板调用后端 Agent proxy，前端只传 DevOps 场景参数。
|
|
- Agent 配置页调用后端 `/agent/config`，前端不持久化 key、baseURL 或 model。
|
|
- Agent 能力限定为发布风险摘要、失败诊断、Runbook 问答、发布说明草稿和事故复盘草稿。
|