文档按“先完成任务,再理解原理,最后查精确契约”的顺序组织。每类事实只有一个维护位置;其他文档只链接,不复制。
- Quickstart:在 Docker 上完成第一次 validate、plan、apply 和 destroy。
- Authoring Topologies:把实验需求表达为 image、network、node 和依赖。
- Lifecycle And Reset:理解 no-op plan、replacement、reset 和安全销毁。
- Heterogeneous Nodes:选择 Docker、Firecracker 或 libvirt。
- Networking And Policy:地址、路由、NAT、alias 和 firewall。
- Troubleshooting:从 diagnostics、plan、state 和 checkpoint 定位失败。
- Control Plane Deployment:部署 API、Postgres、Agent 和 Web。
- Agent Operations:Agent 身份、能力、heartbeat、lease 和升级。
- Artifacts:准备、固定和缓存 kernel、rootfs、qcow2 与 OCI image。
- Upgrades And Recovery:备份、升级、恢复和 residue audit。
- 设计原则:为什么采用声明式图、严格身份和显式 provider 边界。
- Architecture:组件、数据流、state、stored plan、driver 与 recovery 的规范性说明。
- 资源模型与能力:资源类型、组合关系、执行引擎与扩展机制。
- HCL Reference
- Artifact 与 Topology 可移植性规范:多个独立环境可交叉部署所需遵守的对齐基准。
- CLI Reference
- API Reference
根目录 README 是项目入口,不承担完整手册职责。