# AIOps 开发文档

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

## 文档索引

| 文档 | 说明 |
|------|------|
| [快速开始](./quick-start.md) | 环境准备、本地开发、常见问题 |
| [部署指南](./deployment.md) | 二进制 / Docker / K8s 部署、版本发版、镜像推送 |
| [项目结构](./project-structure.md) | 前后端目录结构说明 |
| [开发规范](./development-guide.md) | 代码规范、Git 工作流 |
| [API 接口](./api-reference.md) | 后端 API 接口文档 |
| [数据库设计](./database-schema.md) | 数据模型和表结构 |
| [开发日志](./dev-log.md) | 详细开发日志（按日期记录） |
| [Redis 缓存策略](./redis-caching-strategy.md) | Redis 缓存使用现状与优化方案 |

## 设计文档

| 文档 | 说明 |
|------|------|
| [PDD 计划](./PDD_PLAN.md) | 产品驱动开发计划 |
| [项目摘要](./PROJECT_SUMMARY.md) | 项目整体概述 |
| [后端摘要](./BACKEND_SUMMARY.md) | 后端架构概述 |

## 根目录文档

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

## 部署速查

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