cofy-x/axern

文档 ·
快速开始 ·
SDK ·
English

Axern 是一个面向 agent 评测、训练与数据合成的开源环境执行平台。它用 gVisor（runsc）隔离运行 agent 生成的代码，使用统一的资源与生命周期模型。执行运行时统一使用 runsc，不提供运行时回退。CLI 与 Go、Python、TypeScript SDK 暴露相同的公共 API，覆盖 Environment、Run、Sandbox 进程与文件、Tunnel、生命周期状态和 allocation 范围的访问能力。

项目状态： Axern 处于 pre-1.0 阶段，仍在活跃开发中。它适合评估与贡献；在部署多租户工作负载之前，运维人员应先审阅安全与生产边界。

本文档为中文译文，内容以 英文版 为准。

持久领域链路为 Environment → Run → Allocation → runsc sandbox。Sandbox 是这条链路上的 SDK 门面，不建立第二套执行生命周期。

快速开始

受支持的本地路径通过 Docker Compose 运行完整技术栈，只需要 axern CLI 和 Docker Compose v2，不需要源码检出、Make、Helm 或任何语言工具链。

brew install cofy-x/tap/axern

没有 Homebrew 时，使用带校验和的独立安装脚本：

curl -fsSL https://raw.githubusercontent.com/cofy-x/axern/main/install.sh | sh

然后启动 Axern 并运行第一个工作负载：

axern local up
axern local image load python:3.12-slim --pull
axern run python:3.12-slim -- python -c 'print("hello from axern")'

local up 会启动 PostgreSQL 以及 Axern 的控制、隧道、节点和网关组件，等待就绪，并创建 local 上下文。local image load 会把选定的宿主 Docker 镜像直接流式导入本地节点，不生成中间归档文件：

axern context current
axern run list
axern local status
axern local down

本地环境使用生成的开发凭据和回环监听地址，不要在共享或生产部署中复用它们。

源码开发是独立的贡献者路径。它把当前检出构建为本地 :dev 镜像，并验证相同的公共契约：

make quickstart-source

仓库开发通常使用 make verify-changed 获得快速反馈。Linux correctness、完整回归和发布资格验证属于不同层级；每个 main 提交都会启动绑定该提交的完整回归，PR 检查通过不代表后续回归已通过。发布或晋级前检查 Post-Merge Full，详见验证层级。

可以构建什么

- Agent 沙箱： 在 runsc 隔离边界后执行 agent 生成的代码，同时保留进程、文件、终端和输出 API。
- 评测与数据合成批次： 通过 Run 并发执行隔离工作负载，并显式记录输入、输出和生命周期证据。
- SDK 驱动执行： 通过正式发布的 SDK 创建 Run、操作其 Allocation、封存有限的声明输出，并使用公共资源身份恢复查询。

为什么选择 Axern

- 沙箱即原语： 评测、训练、数据合成、编码工作区和 agent 任务都组合自同一套 Run 执行模型。
- 持久化控制平面： 以 PostgreSQL 为后端的意图、放置、租约、Allocation 级状态、健康和清理信息，在进程或节点重启后依然保持权威。
- 单一生产运行时： runsc 工作负载使用相同的公共 API；OCI 与 Nydus 镜像路径在节点运行时汇聚。
- 真实的数据面访问： 进程流、文件、归档、SSH 兼容终端和反向 TCP 隧道都是 allocation 的显式能力。
- 本地到集群的连续性： Docker Compose、kind 和云中立的 Helm chart 验证相同的组件边界。

架构

flowchart LR
Client["CLI 与 SDK 客户端"] --> Gateway["gatewayd\n公共控制与数据边缘"]
Gateway --> Control["controld\n持久化意图与放置"]
Gateway --> Tunnel["tunneld\n反向 TCP 中继"]
Gateway --> Node["axnoded\n沙箱执行"]
Control --> Node
Node --> Egress["egressd\n可信出站策略执行"]
Node --> Image["imagemgr + imagefsd\nOCI 与 Nydus rootfs"]
Node --> Runtime["runsc 沙箱"]

gatewayd 是公共控制流量和 Allocation 范围数据面流量的统一外部网关；controld 和 PostgreSQL 保持产品状态权威，节点服务负责宿主机本地执行、镜像、网络和 Allocation 私有的临时可写存储。Run 可以声明有限的文件或 tar 归档，由节点在 runtime 清理前封存；调用方必须在 15 分钟过期时间内下载并持久发布这些字节。这不是持久 Workspace 或对象存储。详细契约见存储架构、运行时架构和资源模型。

公共客户端提供 Go、Python 和 TypeScript 版本，位于 sdk/。共享的传输契约定义在 sdk/proto。

Kubernetes 安装

按照 Kubernetes 安装指南 初始化签发材料、提供经过验证的节点内存预留值、绑定明确的 Node 身份、安装控制面，并在节点准入后等待运行时就绪。SSH 是可选能力，使用 Principal Credential。不要用裸 Helm install 跳过身份和准入步骤。

每个 Axern Release 都应视为配套的 CLI、SDK、Chart 和运行时版本。升级前请阅读对应的发布说明，并仅在发布完成后使用正式产物；源码版本号不代表产物已经可用。终端录制展示当前源码的 CLI 帮助，不是已部署工作负载或性能测量。

部署

- Docker Compose 和 kind 是仓库自持的本地基准环境。
- Axern Helm chart 是云中立的，接受运维方自持的镜像仓库、证书、存储类和密钥。
- 云厂商账号准备、集群创建、凭据和区域发布自动化有意放在本仓库之外。

Axern 不声称默认的本地或示例部署对不可信多租户环境是安全的。生产使用前请审阅认证、TLS、网络策略、运行时隔离、镜像信任、密钥存储、资源限制和持久存储。报告漏洞请遵循 SECURITY.md。

参与贡献

欢迎贡献。请阅读 CONTRIBUTING.md，遵循行为准则，并在开发者来源证书（DCO）下签署每个 commit。项目决策遵循治理模型。

许可证

Copyright 2026 cofy-x.

基于 Apache License, Version 2.0 授权。