文档默认公开
查阅产品与使用文档不需要 Cats 会话。控制台与资源 API 仍然执行各自的身份认证和权限边界。
选择阅读路径
快速入门构建 CLI、配置访问、创建 Cat 并执行第一条命令。
Cat 与生命周期理解 Running、Suspended、Warm、Cold、唤醒与删除。
存储与磁盘使用 RootDisk、PersistentDisk、快照、扩容、挂载和 durable FLUSH。
Endpoint发布 Guest 端口、选择唤醒策略并了解当前网络能力边界。
CLI 参考全部命令、全局选项、输出模式与自动化行为。
HTTP API 参考路由、身份权限、幂等、请求 Body、Operation 与错误。
Guest Runtime API通过 Guest 本地 Unix socket 上的 HTTP 阻止工作驱动休眠。
控制台与身份WorkOS 浏览器/Device 登录、工作区、会话与语言设置。
Operation 与故障排查跟踪异步任务、理解错误并处理常见故障。
产品模型
Cat 是一台长期存在的 Linux microVM,必须拥有 RootDisk。计算可以停止,Cat 名称与持久磁盘继续存在。Workspace 是面向用户的权限和资源边界;V1 HTTP API 底层仍保留兼容的 project 路径分段。
- RootDisk 跟随 Cat,并随 Cat 删除。
- PersistentDisk 独立存在,V1 只允许扩容,且最多挂载给一个读写 Cat。
- Endpoint 将稳定域名映射到一个 Guest 端口,并可唤醒休眠中的 Cat。
- Operation 记录每一次异步变更及其最终结构化错误。
当前 V1 开发形态
Rust workspace 已实现控制面、CLI、嵌入式用户/管理员控制台、Node 与 Guest Agent、Endpoint 网关契约、ChunkStore 引擎、云厂商无关存储 Adapter,以及 Cloud Hypervisor Phase-A 路径。评估或运行当前源码版本时必须了解以下限制:
| 领域 | 当前状态 | 实际含义 |
|---|---|---|
| 块设备前端 | Cloud Hypervisor Phase A 使用内核 NBD | 原生 vhost-user-blk 仍是后续性能里程碑。 |
| Guest 网络 | tap/overlay 尚未实现 | Endpoint 路由已覆盖 FakeVmm 开发路径,不能宣称 CH Guest 网络已经完整。 |
| Suspended 内存回收 | CH Phase A 当前仅 Pause | 设计中的 page-out 路径尚未实现,因此 Suspended 当前节省 vCPU,但不节省 Host 内存。 |
| 控制元数据 | SQLite 开发存储 | 存储元数据 PostgreSQL adapter 已存在,但 Project 资源存储仍是 SQLite 开发形态。 |
| 权限隔离 | 尚未实现 | 只能在适当隔离的环境中运行开发组件。 |
性能数字是实验依据,不是 SLA
仓库内的基准保留了样本数、环境、测量边界和正确性判据。绝不能把原型测量直接升级为生产承诺。
文档约定
示例使用 cats login 选中的 Workspace 与名为 dev 的 Cat。请按部署替换。容量支持 512MiB、8GiB 等二进制后缀。