私有与离线部署
私有部署把 Yi Code 整个放进你们的网络:控制面、知识服务和执行主机。它可以完全离线运行。登录、Git、模型、镜像和工具都来自你们内网。
离线包可以在一台不能访问公网的全新主机上安装,不拉取镜像,也没有出站流量。规划私有部署请联系我们。
我们交付什么
一个离线包,附带覆盖全部内容的校验文件(SHA256SUMS):
- 以 Docker Compose 运行的控制面:数据库迁移、API、Worker 和 PostgreSQL。
- 知识服务:RAGFlow v0.27.2(Apache 2.0),带 Elasticsearch、MySQL、MinIO 和 Redis,只用 CPU,关闭 RAGFlow 的代码执行和额外的 GPU 服务。
- 执行主机需要的软件包:Docker、containerd、Docker Compose 和 Buildx、gVisor、OpenSandbox,以及 Yi Code 的 runner 和 broker。
- 全部容器镜像,按 digest 固定,加载后再核对镜像 ID。
- 配置和安装以上内容的脚本。
不包含模型权重,也不包含推理平台。
你们需要准备什么
| 要求 | |
|---|---|
| 身份 | 一个 OpenID Connect 身份服务。默认情况下 Yi Code 会调用它的 userinfo 端点来复核成员和角色 |
| Git | 你们的 Git 服务,控制面要能访问 |
| 模型 | 一个 OpenAI 兼容的 /v1 对话端点,支持工具调用和用量上报,以及给知识库用的 embedding 服务。见模型 |
| 控制面主机 | 一台装了 Docker 的 Linux 主机,以及你们内部 CA 的证书 |
| 执行主机 | 全新、专用的 Ubuntu 24.04 amd64 机器,每台同一时间只跑一轮。ARM、macOS 以及不用 gVisor 的环境都会被拒绝 |
| 控制面地址 | API 前面的 HTTPS 反向代理。API 只监听 127.0.0.1:8000,对外地址就是 YI_PUBLIC_URL,生产模式要求 HTTPS。执行主机要能访问它,包括 YI_GATEWAY_URL。用内部证书即可 |
| 执行主机网络 | 每台执行主机的 broker 前面有一个使用内部证书的可信反向代理,控制面要能访问它 |
API 要跑多个副本时,用你们自己的高可用 PostgreSQL 和 S3 兼容对象存储,替代自带的数据库和本地卷。
关闭了什么
- 在线支付。用量按合同计费,见预算与计费。
- 回退到公网模型端点。
- SDK 遥测。
你们的网络策略也应该挡住访问公网的出站流量。
安装
下面的 BUNDLE 指离线包所在路径。离线包里的脚本在 BUNDLE/deploy/ 目录下,用 python3 运行。
核实交付来源。安装脚本在改动任何东西之前,都会先用校验文件核对每个文件。
在控制面主机上,为这次安装生成独立的随机密码和密钥。已有的不会被覆盖,脚本会直接拒绝。
shpython3 BUNDLE/deploy/configure.py BUNDLE/deploy编辑
BUNDLE/deploy/private.env:内部地址、身份服务和携带角色的 claim、允许的主机。导入内部 CA。见配置。一个身份服务给很多团队用的话,角色要从签名的角色 claim 映射,不要把所有内部用户都映射成管理员。安装控制面和知识服务。它会校验所有文件、加载镜像、核对镜像 ID,在不拉取任何东西的情况下启动服务。
shpython3 BUNDLE/deploy/install.py BUNDLE之后 API 只监听
127.0.0.1:8000。在它前面放你们的 HTTPS 反向代理,地址就是YI_PUBLIC_URL。在每台全新的执行主机上放一份离线包,先生成这台主机自己的凭据,再以 root 安装。
--control-url填控制面的 HTTPS 地址。shpython3 BUNDLE/deploy/render_host.py BUNDLE /FRESH-CONFIG --control-url https://agent.corp.internal sudo python3 BUNDLE/deploy/install_host.py BUNDLE --configuration /FRESH-CONFIG安装器会校验文件,用离线包里的软件包在本地完成安装,加载并核对镜像,建立封闭的沙箱网络,然后跑一次 gVisor 探针。探针通过后才会启用这台主机的 broker。证据写在
/var/lib/yi-agent/offline-native-probe.json。已经有配置或容器的主机,安装器会拒绝。重启后先恢复网络隔离规则。把每台主机接到控制面:
broker 只监听主机的回环地址。在它前面放一个使用内部证书的反向代理,并把它的主机名加进
YI_CONNECTOR_HOSTS。把主机上
/FRESH-CONFIG/broker.env里YI_BROKER_KEY的值,以YI_BROKER_KEY_开头的名字写进BUNDLE/deploy/private.env,例如YI_BROKER_KEY_HOST_1。重建 API 和 Worker,让改过的
private.env生效。在BUNDLE/deploy目录下、按运行 yi-admin 设好镜像变量后执行:shdocker compose up -d --force-recreate api worker把主机登记为
static类型的执行池,见登记执行主机。
让 RAGFlow 使用你们的 embedding 服务,为你们的组织建好账号,把它的 dataset 在 Yi Code 里登记为知识源。
在断网的情况下跑一个验收任务,确认没有任何访问公网的请求。
运行 yi-admin
yi-admin 只在控制面镜像里有,所以要在 API 容器里运行。在 BUNDLE/deploy 目录下用 Docker Compose 执行,并设好安装时用的两个镜像变量,它们的值在 BUNDLE/transport.json 里:
cd BUNDLE/deploy
export YI_CONTROL_IMAGE="$(python3 -c 'import json; print(json.load(open("../transport.json"))["control"])')"
export YI_POSTGRES_IMAGE="$(python3 -c 'import json; print(json.load(open("../transport.json"))["postgres"])')"
docker compose exec api yi-admin --help不设这两个变量,Docker Compose 会拒绝读取这个项目。
交给 yi-admin 的文件必须在容器里能读到。像下面这样从标准输入传进去,不要写主机上的路径。
登记执行主机
为每台主机写一个 pool.json:
{
"name": "host-1",
"cloud": "static",
"region": "on-prem",
"capacity": 1,
"healthy": true,
"budget_micro": 0,
"cost_micro_per_second": 0,
"price_micro_per_second": 0,
"config": {
"broker_url": "https://broker-1.corp.internal",
"broker_key_ref": "YI_BROKER_KEY_HOST_1",
"runtime_image": "填 private.env 里 YI_RUNTIME_IMAGE 的值"
}
}broker_url是这台主机 broker 前面的反向代理地址。broker_key_ref是你加进private.env的那个变量名。runtime_image必须和private.env里的YI_RUNTIME_IMAGE一致。镜像不一致的执行池永远分不到轮次。- 只有探针通过的主机,才把
healthy设成true。 - 金额单位是百万分之一美元。
price_micro_per_second是轮次按执行时长收费的费率。cost_micro_per_second为 0 时,budget_micro填 0 即可。
然后在 BUNDLE/deploy 目录下、设好上面的变量后执行:
docker compose exec -T api yi-admin pool-import /dev/stdin < pool.jsonGit 与 Pull Request
仓库在「设置」里按地址添加,配一个有读权限的凭据引用。仓库的主机要在 YI_GIT_HOSTS 里。项目的「允许的云(逗号分隔)」要填 static,也就是你们执行池的类型。只有 github.com 上的仓库能创建 Draft PR。用内部 Git 服务时,从每个会话的 changes.patch 取改动。
运行镜像
离线包里带着默认的运行镜像,有 Python 和 Node.js。你们可以自己构建带其他工具链的镜像,但用之前必须重新通过隔离和执行验收。见运行镜像。