运维技术文档库 · 执行总纲(AI 助手操作手册)¶
定位:本文件是 F:\EricLiu\Docs\ 的执行总纲与总入口。 AI 助手每次会话涉及运维实验/文档操作时,第一份必读文件;各技术 README 是分册,本总纲是规则源头。 版本:v1.2 创建:2026-11-11 最近核对:2026-11-11(全部分册已对照官网更新版本基线)
1. 文档体系总览¶
F:\EricLiu\ ← 一切实验与文档产物的唯一根目录(落盘硬约束)
├── Docs\ ← 本总纲所在:运维基础设施文档库(学习主线)
│ ├── README.md ← 本文件:执行总纲(规则源头 + 总索引)
│ ├── Roadmap\README.md ← 运维技术实践路线图(阶段 0-5、实验清单、五段式报告)
│ ├── DocOps\README.md ← 文档库管理策略(docs-as-code;管辖 Docs 与 AppDocs 两库)
│ ├── Reusable\ ← 复用资产库(INDEX.md 索引 + 四类资产)
│ │ └── scripts\ configs\ playbooks\ checklists\
│ └── <技术>\labs\ ← 各技术实验文件与报告(在各技术目录内)
├── AppDocs\ ← AI 应用服务文档库(姊妹库,结构同 Docs)
│ ├── README.md ← AppDocs 执行总纲(13 个应用领域分册索引)
│ ├── Roadmap\README.md ← 应用服务实践路线图(阶段 A-H)
│ ├── Reusable\ ← 应用侧复用资产库(同 Docs\Reusable 机制)
│ └── <技术>\labs\ ← 各应用技术实验文件
├── Envs\ ← Vagrant 工作环境(vagrant up 在这里跑)
└── tmp\ ← 临时文件(实验收尾清理)
两个库共用同一套机制:五段式实验报告、七步循环、时间盒、资源预算、复用闭环、落盘约束、版本基线与许可证合规。 做运维基础设施实验先读本总纲;做 AI 应用服务实验先读
AppDocs\README.md;文档库本身怎么管(git/浏览站/部署)见DocOps\README.md。
2. 文档索引(分册)¶
| 目录 | 主题 | 优先级 | 说明 |
|---|---|---|---|
Roadmap/ |
技术实践路线图 | 必读 | 分阶段实验清单(带勾选框+时间盒)、五段式实验报告(目的/记录/结果/总结/复用)、资源预算表、失败处理与回炉机制、里程碑自测、AI 协作守则;每次实验前先看这里 |
Reusable/ |
复用资产库 | 必读 | 验证过的脚本/配置/排障 SOP/检查清单 + INDEX.md 标签索引(含状态/适用版本/命中统计/受控标签词表);AI 排障前先查这里,实验后必须往这里沉淀,阶段出关复核有效性 |
DocOps/ |
文档库管理策略 | ★★☆ | docs-as-code 决策记录:Markdown+Git 事实源 + MkDocs 浏览层 + Gitea 私有 git;落地路线与 git 管控细则 |
Vagrant/ |
Vagrant + Hyper-V | ★★★ | 当前主力实验环境;含 Hyper-V 特有的坑与自动化守则 |
Docker/ |
Docker & Compose | ★★★ | 容器基础;TTS 服务的载体 |
K8s/ |
Kubernetes | ★★★ | kind/k3s 实验路线、学习路径、YAML 模板、排障流程 |
Linux/ |
Linux 基础 | ★★★ | 一切的地基;Ubuntu 为主 |
Shell/ |
Bash 脚本 | ★★☆ | 自动化脚本编写规范与常用片段 |
Git/ |
Git | ★★☆ | 配置/代码版本管理,含事故自救命令 |
Nginx/ |
Nginx | ★★☆ | 反向代理 K8s/TTS 服务、HTTPS |
Ansible/ |
Ansible | ★★☆ | 多台 VM 批量配置(配合 Vagrant 多机) |
Monitoring/ |
Prometheus + Grafana | ★☆☆ | 集群/服务监控与告警 |
Terraform/ |
Terraform | ★☆☆ | 基础设施即代码;本机先练 Docker/云 provider |
3. 核心规则速览(全文见各处引用,这里是一页速查)¶
- 落盘硬约束:一切实验/安装/生成产物只能保存在
F:\EricLiu\之下(临时文件放F:\EricLiu\tmp\);禁止写入桌面、下载、用户主目录及 C 盘其他位置。运行时存储例外:Hyper-V 磁盘默认路径、Vagrant box 缓存、VM 内/var/lib/docker。 - 先读分册守则:操作某技术前,先读该技术
README.md的"AI 助手操作守则"一节。 - 实验七步循环 + 时间盒:备场(含资源检查)→ 目的与可量化判据 → 动手讲解 → 实时记录 → 验证结论 → 环境重置 → 提炼复用。每实验默认限时 60 分钟,到时就地收尾,禁止无限调试(详见 Roadmap §1/§2.5)。
- 复用闭环:排障/实验前先查本库
Reusable\INDEX.md(核对状态与适用版本),必要时再查姊妹库 INDEX;结束后必须提炼 ≥1 项资产入库并登记索引;阶段出关复核资产有效性;同一问题命中 2+ 实验 → 反哺技术 README(详见 Reusable\README.md)。 - 高危命令确认:destroy、rm 类、reset --hard、ufw enable、terraform apply/destroy、docker system prune -a --volumes 等,执行前必须列出影响并向用户确认。
- 进度追踪:每阶段结束勾选 Roadmap 的 checkbox,并更新其"下次继续点"栏位。
- 版本时效与许可证合规:① 每阶段出关时核对在用分册的版本基线行,发现大版本变化先更新分册再做实验;② 引入任何新开源项目前,先查其分册"限制与回避"清单——许可证(GPL/AGPL/NC/BSL 等)、维护状态、CPU 可行性,商用场景按分册标注执行。
- 步骤留痕与阶段完结发布:① 实验每个步骤执行后,即时更新实验报告"实验记录"段及相关文档,禁止事后凭记忆补写;② 每阶段出关必须四步走完——出关自测 → git commit+push 到 Gitee 仓库(ops-lab)→ 重建并发布浏览站到
docs.nopcloud.com→ 更新路线图继续点(详见 Roadmap §1"阶段完结发布流程"、DocOps §5 发布 SOP)。未推送未发布视为阶段未完结。
4. AI 阅读顺序(不同场景读什么)¶
| 场景 | 阅读顺序 |
|---|---|
| 会话开始做实验 | 本总纲 → Roadmap(找到当前阶段与"下次继续点")→ 对应技术 README |
| 排障 | 本总纲第 3 节 → 本库 Reusable\INDEX.md → 姊妹库 INDEX.md(跨库查现成 SOP) → 对应技术 README 排障节 |
| 新建/更新文档 | 本总纲第 5 节入库规则 → 对应技术 README(保持结构;Docs 分册按第 6 节六段、AppDocs 分册按第 6 节附注的九段) |
| 复盘/查经验 | 对应 labs*\README.md(实验报告)→ EXPERIENCE.md(经验库)→ Reusable\(资产) |
| 跨库实验(AppDocs 用到基础设施) | AppDocs 总纲 → 本总纲第 3 节规则 → 所需基础设施分册(Docker/K8s/HA 等) |
5. 入库规则(新东西往哪放)¶
| 产出类型 | 存放位置 | 附加动作 |
|---|---|---|
| 新技术分册 | Docs\<技术>\README.md(AppDocs 侧:AppDocs\<技术>\README.md,在其总纲登记) |
统一结构(见第 6 节)+ 版本基线行;在本总纲第 2 节登记 |
| 实验报告 | Docs\<技术>\labs\E0X-名称\README.md(AppDocs 侧:AppDocs\<技术>\labs\E{A-H}XX-名称\) |
五段式模板(Roadmap §2.2) |
| 经验条目 | Docs\<技术>\labs\EXPERIENCE.md |
表格追加,标明对应资产 |
| 复用资产 | Docs\Reusable\{scripts,configs,playbooks,checklists}\(AppDocs 侧:AppDocs\Reusable\) |
必须验证过 + 登记本库 INDEX.md;排障时两库 INDEX 都查 |
| 路线图变更 | Docs\Roadmap\README.md(AppDocs 侧:AppDocs\Roadmap\) |
勾选 checkbox、更新继续点 |
| 临时文件 | F:\EricLiu\tmp\ |
实验收尾清理 |
AppDocs 侧产出的入库规则与本表相同,仅路径前缀换为
AppDocs\;分册登记在 AppDocs 总纲的索引表中。
6. 技术分册统一结构¶
Docs 分册(六段):
- 版本基线行(核对日期 + 来源官网)
- 安装与配置
- 高频命令速查
- 模板/配置示例(可直接复制改造)
- 排障速查(现象 → 原因)
- AI 助手操作守则(高危操作清单 + 标准流程)
AppDocs 分册(九段):在上述基础上,第 2 段前增加"选型对比表(含适用范围/限制列)",其后增加"限制与回避清单"与"推荐结论(首选/选配/回避 + 事实依据)"两段;涉及聚合类项目再加"整合/聚合型项目"小节。新建分册时不得缺省这三段。
7. 学习路线总览(详细实验清单见各库 Roadmap)¶
运维主线(Docs,阶段 0-5)
阶段 0 环境准备(Hyper-V/Vagrant/box 本地化)
阶段 1 Linux + Shell + Git(基础,随时穿插)
阶段 2 Vagrant + Hyper-V 搭可复现实验环境
阶段 3 Docker:容器化 TTS 服务
阶段 4 K8s:单机 kind 起步 → 存储/Ingress 进阶 → k3s 多节点
阶段 5 Ansible / Nginx / Monitoring / Terraform(可与阶段 4 后期并行)
应用主线(AppDocs,阶段 A-H,依赖运维主线的 Docker/K8s 能力)
阶段 A 集中管理(1Panel/Gitea)→ B 语音链路 TTS/ASR/SOE → C NLP/LLM
→ D 图像生成 → E OCR → F 高可用集群 → G 全链路整合(毕业项目)
→ H 教育与文化(英语学习/古诗词/国风绘画/青少年编程,选修)
8. 更新记录¶
| 日期 | 变更 |
|---|---|
| 2026-11-11 | 建立 10 份技术分册;官网核对全部更新版本基线 |
| 2026-11-11 | 整库迁入 Docs\;新增 Roadmap 路线图与 Reusable 复用资产库 |
| 2026-11-11 | 实验报告升级五段式、七步循环;确立落盘硬约束与目录分工 |
| 2026-11-11 | 本文件升级为执行总纲(定位、阅读顺序、入库规则、规则速览) |
| 2026-11-11 | 优化实验与复用机制:实验时间盒(60min)、可量化判据、资源预算表、失败处理与回炉/错题本机制;复用资产增加状态生命周期、适用版本与条件、命中统计、受控标签词表、阶段出关复核 |
| 2026-11-11 | 资源预算按宿主机实测 60% 上限落地(150GB 内存/48 vCPU/500GB VM 磁盘);Vagrant 模板对齐 8GB/4vCPU |
| 2026-11-11 | 体系树纳入姊妹库 AppDocs(AI 应用服务文档库:服务器集中管理/TTS/ASR/SOE/NLP/图像生成/OCR/高可用) |
| 2026-11-11 | 新增 DocOps 文档管理策略:定案 docs-as-code 路线(Markdown+Git + MkDocs Material + Gitea),弃用重型文档系统 |
| 2026-11-11 | v1.1:体系树补 DocOps、AppDocs 描述更新为 13 领域;规则速览补版本时效与许可证合规;入库规则覆盖 AppDocs 侧;阅读顺序补跨库场景;分册结构区分 Docs 六段/AppDocs 九段;学习路线补应用主线阶段 A-H |
| 2026-11-11 | v1.2:新增规则 8"步骤留痕与阶段完结发布"(每步骤后即时更新记录;阶段出关四步:自测→git push Gitee ops-lab→发布 docs.nopcloud.com→更新继续点);Roadmap 增"阶段完结发布流程";定案远程仓库 Gitee 私有仓 ops-lab、浏览站 docs.nopcloud.com |