主题
环境变量与 Secret
配置形式
详情接口的 envs 为对象数组:
json
{ "key": "APP_PORT", "value": "10062", "isSecret": false }isSecret: true 的条目加密存储:读取接口不回显明文、运行日志中自动遮蔽。 CLI 创建时可用 --env K=V 简写(映射为普通变量);update 接口拒绝 env 简写,必须给 envs 数组,避免误把 Secret 降级或清空。
优先级链
由低到高:
text
系统环境(服务端进程) < 项目普通变量 < 项目 Secret < 内置变量 < 触发参数(-e / env)触发参数覆盖需项目开启 allowEnvOverride(「允许参数覆盖」),否则触发时传的变量被忽略。 临时覆盖只作用于目标项目,不传递给依赖项目。
内置变量表
| 变量 | 含义 |
|---|---|
WORKDIR | 实际工作目录(展开后) |
PROJECT_KEY / PROJECT_NAME | 项目标识与名称(任务注入 TASK_KEY / TASK_NAME) |
RUN_ID / BUILD_NUMBER | 全局运行 ID / 目标内构建号 |
TRIGGER_BY / TRIGGER_TYPE | 触发者 / 触发方式(web/api/hook/cli) |
START_TIME | RFC3339 开始时间 |
DEPLOY_SERVER_URL | 系统设置中的服务端外部地址 |
GIT_BRANCH / GIT_COMMIT / GIT_COMMIT_SHORT / GIT_TAG / GIT_AUTHOR / GIT_MESSAGE / GIT_DIRTY | 启用 Git 准备时注入 |
内置变量高于项目变量:项目里定义同名 WORKDIR 不会生效,避免脚本 cwd 与变量不一致。
Secret 使用建议
- 数据库口令、第三方 API key 一律
isSecret: true;脚本以${DB_PASSWORD}引用。 - 遮蔽是值匹配替换:Secret 值若极短(如
1)可能误遮蔽日志正常内容,取值应有足够熵。 - 中间件安装时生成的随机密码可能在安装日志中出现一次(非项目 Secret),请限制日志访问权限。
- 应用配置文件(含密码)留在服务端受限路径或 Secret 注入,不进 Git;发布脚本负责写外部配置。
触发时传参
bash
deploy run my-app -e TAG=v1.2.3 -e MODE=prod --branch release -fHook body 的 env 字段等价。未开 allowEnvOverride 时这些覆盖被忽略(项目变量仍生效)。