Files
foundry-core/deploy/examples/README.md
T

39 lines
3.0 KiB
Markdown

# BaaS 打包声明与环境配置示例
这些文件是 DSL 设计草案,不是已经实现的打包接口。现有 Go 入口、CI 和部署脚本均未接入它们;不要直接用这些示例执行生产发布。
## 文件职责
- `backend.yaml`:声明后端名称、需要的能力、构建平台和部署要求,可提交 Git。
- `.env.dev.example`:开发运行配置模板,可提交 Git;真实 `.env.dev` 仅保存在本地。
- `.env.prod.example`:生产运行配置模板,可提交 Git;真实生产值由部署环境保管。
`secretRef` 和 `credentialsRef` 只是未来部署器解析的逻辑名称,不是密码,也不是当前支持的环境变量插值语法。密钥引用如何映射到环境变量或文件,以及 dev/prod 如何覆盖域名等字段,尚待定义。Core 的 Codex IPC/授权路径与 worker 的 CLI 登录是不同配置;`notes-codex` 对应的专用登录不应提供给 Core。
`features` 暂时只表达期望。关闭能力是从编译产物中排除模块,还是只在运行时关闭注册,尚待确定。现有入口仍要求 Google 凭据,email 需要完整 SMTP 配置,YAML 不会自动改变这些行为。
## 编译与运行环境的边界
目标流程为:
```text
源码 + backend.yaml → 远程构建 → 程序与不含密钥的打包声明
↓
部署时注入对应环境配置 → 启动实例
```
生产凭据只在部署/运行时提供。常规 Go 编译无需读取生产数据库密码或 OAuth Secret。同一个构建产物可以在配置兼容的开发和生产环境运行;它们各自使用独立的数据库、账号和凭据。环境文件不会被 Go 自动加载,需要启动器将配置放入进程环境,或由 Docker 的 `--env-file` 读取。
## 生产 env 的保管
可采用每实例一个受保护目录,例如服务器上的 `/etc/foundry/instances/notes-backend/`,真实配置保存为其中的 `prod.env`。这是未来部署布局的示例,当前脚本不会创建或读取该位置。
- 目录设为 `700`、文件设为 `600`,所有者为需要读取它的部署账号。
- 凭据通过受控运维过程或密钥管理系统配置;部署器读取后向目标容器注入,不复制进发布目录、镜像或构建归档。
- CI 如需提供密钥,使用受保护的 Actions Secrets,并仅允许可信生产发布作业访问;普通 PR、构建和测试不应取得生产密钥。
- 不在日志中输出 env 内容或开启包含凭据的命令跟踪。具备 root、Docker 管理或相应进程访问权限的账号仍可能读取运行时环境,文件权限不能隔离这些管理员。
仓库忽略 `.env`、`.env.*` 和 `*.env`,保留 `*.example` 模板。Git 忽略只能防止通常的误添加,不是密钥存储机制,也不会移除已经被跟踪的文件。
现有生产链路仍从服务器的 `/opt/endoleap-infra/foundry/database.env` 读取数据库配置,并从 Actions Secrets 注入 OAuth 凭据;这里只记录未来 DSL 的设计方向,不改变当前生产行为。