docs: 同步 README 与 docs 文档至当前代码状态

- README 补充 PageShell、i18n、Agent CLI、中间件监控等近期功能
- project-structure 重写 api/pages/locales 目录约定
- development-guide 新增 PageShell 与 i18n 开发规范
- PROJECT_SUMMARY 整体重写,移除过时 internal/ 结构
- docs/README 新增 Agent CLI 设计文档索引与近期变更摘要
- dev-log 追加 2026-07-01 变更记录
This commit is contained in:
Logan committed 2026-07-01 12:50:58 +08:00
1 parent e363ded445
commit 4cb0e62857
6 files changed
+300 -278

No files matched your search

+32 -12
View File
@@ -6,8 +6,9 @@
### 前端
- React 19 + TypeScript + Vite
- Tailwind CSS + shadcn/ui
- Tailwind CSS + shadcn/ui + **PageShell 统一页面骨架**(`dg-page*` 设计令牌)
- Zustand (状态管理) / TanStack Query (数据获取)
- i18next 国际化(中/英双语,`zh-CN` / `en-US`)
- Recharts (图表) / Lucide React (图标)
- CodeMirror 6 (YAML 编辑器) / xterm.js (WebSocket 终端)
@@ -18,6 +19,7 @@
- WebSocket (Gorilla) / PTY 终端 (creack/pty)
- 自研轻量 Kubernetes HTTP 客户端(channel.k8s.io WebSocket 协议)
- go:embed 嵌入前端静态资源(单二进制 / 单容器部署)
- Agent CLI 引擎(`pkg/agentcli/`):ReAct + Evolver + 双协议 LLM(OpenAI / Anthropic)
### Agent
- Go 1.24 静态编译 (CGO_ENABLED=0)
@@ -115,20 +117,30 @@ curl http://localhost:8080/version # 查看运行版本
```
aiops/
├── frontend/ # 前端 (React + TypeScript)
│ ├── src/components/ # dashboard/server/k8s/monitor/deploy/aiops...
│ ├── src/
│ │ ├── api/ # API 封装(按菜单域拆分:server/k8s/monitor/deploy/...)
│ │ ├── pages/ # 复杂页面(monitor/approval/audit 等域级页面)
│ │ ├── components/ # 业务组件 + layout(PageShell/PageTabs/...)
│ │ ├── locales/ # i18n 翻译文件 (zh-CN / en-US)
│ │ ├── i18n/ # i18next 初始化
│ │ ├── hooks/ # 自定义 Hooks(useTheme / useConfirm 等)
│ │ ├── store/ # Zustand 状态管理
│ │ └── types/ # TypeScript 类型
│ └── Dockerfile # [legacy] 独立 Nginx 镜像,Compose 已改用 embed
│
├── backend/ # 后端 (Go + Gin)
│ ├── main.go # 应用入口
│ ├── embed.go # go:embed 前端静态资源
│ ├── static/ # 前端构建产物(embed 目标目录)
│ ├── controller/ # HTTP 处理器
│ ├── controller/ # HTTP 处理器(60+ 文件按领域拆分)
│ ├── router/ # 路由注册
│ ├── model/ # GORM 数据模型
│ ├── pkg/ # database/kubernetesclient/remoteexec/...
│ ├── model/ # GORM 数据模型(86+ 表)
│ ├── pkg/ # agentcli/remoteexec/kubernetesclient/...
│ └── Dockerfile # [legacy] 分离式后端镜像
│
├── agent/ # 监控 Agent(独立 Go module)
├── docs/ # 开发文档
│ └── agent/ # Agent CLI 设计文档集
├── deploy/kubernetes/ # K8s 部署清单 (devops 命名空间)
├── docker-compose.yml # MySQL + Redis + AIOps embed(3 容器)
├── docker-compose.k8s.yml # 单应用容器(连接外部 DB)
@@ -143,13 +155,19 @@ aiops/
|------|------|
| 仪表盘 | 成本统计、告警聚合、Top 资源、SSL 提醒、趋势图表 |
| 资产管理 | 服务器 CRUD、批量导入、WebShell、云账号/域名/账单 |
| Kubernetes 管理 | 多集群、Deployment 三模式编辑器、Pod 终端/文件浏览、事件聚合 |
| 应用发布 | CI/CD 流水线、发布配置、SSH + K8s 双路径部署 |
| 监控中心 | 监控大屏、主机指标、告警引擎、飞书/钉钉通知 |
| 自动化运维 | 定时任务、脚本库、远程执行(Go-native SSH) |
| AIOps 智能 | AI 助手、告警分析、容量预测 |
| Kubernetes 管理 | 多集群、Deployment 三模式编辑器、Pod 终端/文件浏览、拓扑图、国际化 |
| 应用发布 | CI/CD 流水线、发布配置、SSH + K8s 双路径部署、凭证管理 |
| 监控中心 | 监控大屏、主机指标、SNMP/站点拨测、**中间件监控**(Redis/MySQL 直连采集)、日志中心(Loki/ES)、**日志告警引擎** |
| 自动化运维 | 定时任务、脚本库、**远程执行**(Go-native SSH,执行/上传) |
| AIOps 智能 | AI 助手、告警分析、容量预测、**Agent CLI**(ReAct + WebSocket 实时回传 + 终端审计回放) |
| 资源申请 | 云服务器/应用部署申请审批 |
| 系统管理 | 用户/角色、操作审计、凭证配置 |
| 系统管理 | 用户/角色、操作审计、终端会话审计、凭证配置(7 种类型)、大模型设置(OpenAI + Anthropic 双协议) |
### UI 与体验
- **PageShell 设计系统**:全站统一页面骨架(标题区 / 指标条 / 工具栏 / Tab / 内容区),CSS 变量驱动
- **7 套主题**:跟随系统、深海蓝、明亮白 + One Dark / Dracula / Tokyo Night / Catppuccin
- **国际化**:i18next 框架,已覆盖 dashboard / server / alert / approval / audit / deploy / k8s 等模块
## 文档
@@ -159,9 +177,11 @@ aiops/
|------|------|
| [快速开始](./docs/quick-start.md) | 环境准备、本地开发 |
| [部署指南](./docs/deployment.md) | 二进制 / Docker / K8s / 版本发版 |
| [开发规范](./docs/development-guide.md) | 代码规范、Git 工作流 |
| [开发规范](./docs/development-guide.md) | 代码规范、Git 工作流、PageShell / i18n |
| [项目结构](./docs/project-structure.md) | 目录结构说明 |
| [Agent CLI 设计](./docs/agent/00-README.md) | ReAct 引擎、Evolver、安全系统 |
| [CLAUDE.md](./CLAUDE.md) | AI 助手指引(完整命令参考) |
| [AGENTS.md](./AGENTS.md) | AI Agent 工作指南 |
## License