# AIOps 开发文档

本目录包含 AIOps 智能运维平台的开发文档。

根目录只保留通用入口文档：快速开始、部署、项目结构、开发规范和总索引。业务模块、实现规格和历史说明均放入对应子目录，避免根目录继续堆积长文档。// Logan.Li

## 文档索引

| 文档 | 说明 |
|------|------|
| [快速开始](./quick-start.md) | 环境准备、本地开发、常见问题 |
| [部署指南](./deployment.md) | 二进制 / Docker / K8s 部署、版本发版、镜像推送 |
| [项目结构](./project-structure.md) | 前后端目录结构说明 |
| [开发规范](./development-guide.md) | 代码规范、Git 工作流、PageShell / i18n |
| [API 接口](./reference/api-reference.md) | 后端 API 接口文档 |
| [数据库设计](./reference/database-schema.md) | 数据模型和表结构 |
| [模块文档规划](./modules/README.md) | 日志中心、监控中心、安全审计/堡垒机、资产凭证等大模块文档路线 |
| [安全审计与堡垒机](./security-bastion/README.md) | SSH/RDP/Pod/kubectl 会话、录像、命令、策略、审批统一设计 |
| [监控中心](./monitoring/README.md) | Agent 指标、Prometheus/Zabbix、SNMP、站点拨测、告警引擎 |
| [日志中心](./log-center/README.md) | Loki/ES 查询、日志数据源、日志告警、日志 RBAC |
| [资产与凭证](./asset-credential/README.md) | 资产模型、统一凭证、云同步、堡垒机权限底座 |
| [Kubernetes 管理](./kubernetes/README.md) | 自研 K8s 客户端、Pod exec/files、YAML、AI 排障 |
| [自动化运维与发布](./automation-deploy/README.md) | 脚本库、定时任务、远程执行、流水线、Workspace |
| [客户端 Agent](./client-agent/README.md) | 主机采集 Agent 的指标采集、上报、任务轮询和安装升级设计 |
| [客户端 Agent 实现规格](./client-agent/implementation-spec.md) | 可复刻的 Linux 主机采集 Agent 和后端接收链路规格 |
| [终端体系设计](./terminal/README.md) | WebSSH、Pod exec、kubectl、Workspace、审计回放等 xterm 终端统一设计 |
| [终端实现规格](./terminal/implementation-spec.md) | 可复刻的 xterm/WebSocket/PTY/K8s 终端实现细节和验收清单 |
| [Web RDP 远程桌面](./rdp/README.md) | 自研 RDP 协议栈、剪贴板、RDPDR 虚拟盘、文件传输、会话录像与审计 |
| [RDP 实现规格](./rdp/implementation-spec.md) | 可复刻的 Web RDP 图形协议、虚拟通道、文件传输、审计回放实现细节 |
| [AI Agent / Agent CLI 设计集](./ai-agent/00-README.md) | AIOps 原生 Web Agent：ReAct、工具 ACI、安全治理、会话记忆、路线评测 |
| [Redis 缓存策略](./platform/redis-caching-strategy.md) | Redis/redka 缓存使用现状与优化方案 |
| [前端视觉规范](./frontend/design-system.md) | PageShell、主题变量、业务页面视觉规范 |

## 设计文档

| 文档 | 说明 |
|------|------|
| [AI Agent / Agent CLI 设计集](./ai-agent/00-README.md) | 当前压缩为 7 篇：定位、架构、执行循环、工具 ACI、安全治理、会话记忆、路线评测 |

## 根目录文档

| 文档 | 说明 |
|------|------|
| [README.md](../README.md) | 项目主说明 |
| [CLAUDE.md](../CLAUDE.md) | AI 助手指引（完整命令与规范） |
| [AGENTS.md](../AGENTS.md) | AI Agent 工作指南 |
| [ROADMAP.md](../ROADMAP.md) | K8s 管理功能演进路线图 |

## 近期重要变更（2026-06 ~ 2026-07）

| 变更 | 说明 |
|------|------|
| PageShell 设计系统 | 全站统一页面骨架，`dg-page*` CSS 变量 + 7 套主题 |
| 前端架构对齐 | `api/` + `pages/` 按菜单域拆分，复杂页面迁入 `pages/` |
| 国际化 (i18n) | i18next 中/英双语，已覆盖 dashboard / server / alert / approval / audit / deploy / k8s |
| Agent CLI 优化 | Web Agent 执行流、工具 ACI、安全治理、会话记忆和评测路线文档统一 |
| 中间件监控 | Redis / MySQL 后端直连采集引擎 |
| 日志告警 | AlertEngine 支持 `type=log` 规则，查询 Loki / ES 触发/恢复 |
| 远程执行 | 新增远程执行页（执行/上传），移除 ansible 命名 |
| 大模型双协议 | OpenAI 兼容 + Anthropic Messages 协议接入 |
| Web RDP 自研引擎 | 移除 grdp，SessionEngine 完整图形会话，见 [docs/rdp](./rdp/README.md) |
| 文档模块化 | 根目录瘦身，新增 security-bastion / monitoring / log-center / asset-credential / kubernetes / automation-deploy |

## 部署速查

| 场景 | 命令 |
|------|------|
| 本地开发 | `./run.sh dev` |
| 编译二进制 | `./run.sh build tag v1.5.0` → `./aiops` |
| Docker Compose | `./run.sh docker up` → http://localhost:8080 |
| K8s 部署 | `./run.sh kubernetes deploy` |
| 发版推送 | `./run.sh release v1.5.0` → `lghost/aiops:v1.5.0` |
| 查看版本 | `./aiops version` / `curl /version` |

## 部署架构（当前）

```
开发:     ./run.sh dev          → 5173 + 8080 热重载
二进制:   ./run.sh build        → ./aiops (embed, 项目根目录)
Compose:  ./run.sh docker up    → mysql + redis + aiops (embed, :8080)
K8s:      ./run.sh kubernetes   → lghost/aiops:<tag> embed 单 Pod
```

> 前后端分离的 Nginx 容器已废弃，统一使用 `Dockerfile` 单容器方案。