Files
aiops/docs
Logan 4cb0e62857 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 变更记录
2026-07-01 12:50:58 +08:00
..

AIOps 开发文档

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

文档索引

文档 说明
快速开始 环境准备、本地开发、常见问题
部署指南 二进制 / Docker / K8s 部署、版本发版、镜像推送
项目结构 前后端目录结构说明
开发规范 代码规范、Git 工作流、PageShell / i18n
API 接口 后端 API 接口文档
数据库设计 数据模型和表结构
开发日志 详细开发日志(按日期记录)
Redis 缓存策略 Redis 缓存使用现状与优化方案

设计文档

文档 说明
Agent CLI 设计集 ReAct 引擎、Evolver、安全系统、会话管理(10 篇)
PDD 计划 产品驱动开发计划
项目摘要 项目整体概述
后端摘要 后端架构概述

根目录文档

文档 说明
README.md 项目主说明
CLAUDE.md AI 助手指引(完整命令与规范)
AGENTS.md AI Agent 工作指南
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 优化 终端审计回放、ssh-key 连接修复、会话管理增强
中间件监控 Redis / MySQL 后端直连采集引擎
日志告警 AlertEngine 支持 type=log 规则,查询 Loki / ES 触发/恢复
远程执行 新增远程执行页(执行/上传),移除 ansible 命名
大模型双协议 OpenAI 兼容 + Anthropic Messages 协议接入

部署速查

场景 命令
本地开发 ./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.embed 单容器方案。