gitops-admin/agent-skills
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: ask for required values inline

Browse Source
This commit is contained in:
xiaobing.wang 2026-03-31 17:58:22 +08:00
parent 0b27b282a5
commit 1e9886e706
2 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -22,7 +22,7 @@
执行时会遵守这些平台规则： 执行时会遵守这些平台规则：
- 需要公网 HTTP 入口的应用使用 nginx + 单一 `NodePort` 作为平台接入层 - 需要公网 HTTP 入口的应用使用 nginx + 单一 `NodePort` 作为平台接入层
- 百智云用户鉴权是平台必填接入项，需要逐项补齐 `env` 与证书材料 - 百智云用户鉴权是平台必填接入项，需要逐项补齐 `app_id` 与证书材料
- 平台 shared 之外的私有依赖必须明确来源，不能只写不存在的连接参数 - 平台 shared 之外的私有依赖必须明确来源，不能只写不存在的连接参数
- 应用自带私有依赖的内部口令优先自动生成；外部集成凭据再向用户逐项索取 - 应用自带私有依赖的内部口令优先自动生成；外部集成凭据再向用户逐项索取
- 只允许应用仓库 CI 向 GitOps 仓库同步当前应用自己的 release 结果 - 只允许应用仓库 CI 向 GitOps 仓库同步当前应用自己的 release 结果

23
gitops-app-onboarding/SKILL.md
View File

@ -256,7 +256,7 @@ deploy/helm/<app-name>/
`NodePort` 处理规则： `NodePort` 处理规则：
- 如果用户或项目文档已经提供了分配好的 `NodePort`，直接使用 - 如果用户或项目文档已经提供了分配好的 `NodePort`，直接使用
- 如果没有提供，先完成所有非阻塞工作，最后只问用户一个最小必要问题来索取该端口 - 如果没有提供，在生成到这一项时立即停下来索取该端口
- 不要擅自写入示例端口或看起来顺手的默认值，例如 `30080`、`30081` - 不要擅自写入示例端口或看起来顺手的默认值，例如 `30080`、`30081`
- 如果用户暂时没有提供，就停在这一项等待补值，不要擅自填入 - 如果用户暂时没有提供，就停在这一项等待补值，不要擅自填入
@ -299,11 +299,11 @@ deploy/helm/<app-name>/
- 不要为了“看起来完整”而伪造假的生产值 - 不要为了“看起来完整”而伪造假的生产值
- 先区分“外部集成凭据”和“应用自带私有依赖的内部口令” - 先区分“外部集成凭据”和“应用自带私有依赖的内部口令”
- 如果是外部集成凭据，应在完成所有非阻塞工作后主动向用户索取 - 如果是外部集成凭据，应在生成到对应配置时主动向用户索取
- 如果是应用自带私有依赖的内部口令，优先由生成流程一次性生成并写入 release secret，而不是要求用户手填 - 如果是应用自带私有依赖的内部口令，优先由生成流程一次性生成并写入 release secret，而不是要求用户手填
- 如果用户暂时没有提供，不要造占位内容冒充可部署配置 - 如果用户暂时没有提供，不要造占位内容冒充可部署配置
- 对部署阻塞项，按最小必要粒度逐项提问，优先直接问“这一项应填什么” - 对部署阻塞项，按最小必要粒度逐项提问，优先直接问“这一项应填什么”
- 在交互会话中，完成非阻塞工作后，如果仍有必填项缺失，应先向用户索取当前顺序中的下一项 - 在交互会话中，如果当前步骤需要某个必填项才能继续，就先向用户索取当前顺序中的下一项
- 可以只保留结构，或暂不生成具体 secret 内容，但不要用伪造值把未完成配置包装成已完成 - 可以只保留结构，或暂不生成具体 secret 内容，但不要用伪造值把未完成配置包装成已完成
release bundle 只负责导出当前应用自己的发布结果，不负责维护 GitOps 仓库中的其他对象。 release bundle 只负责导出当前应用自己的发布结果，不负责维护 GitOps 仓库中的其他对象。
@ -353,16 +353,14 @@ shared 边界：
- 不要把这类鉴权材料当成平台共享配置 - 不要把这类鉴权材料当成平台共享配置
- 不要擅自生成生产值 - 不要擅自生成生产值
- 先完成所有非阻塞工作 - 鉴权材料均为必填项
- `env` 与鉴权材料均为必填项
- 鉴权材料按固定顺序向用户索取：`app_id` -> `app.crt` -> `app.key` -> `ca.crt` -> `public.key` - 鉴权材料按固定顺序向用户索取：`app_id` -> `app.crt` -> `app.key` -> `ca.crt` -> `public.key`
- 如果用户还没提供完整值，不要写伪造占位内容 - 如果用户还没提供完整值，不要写伪造占位内容
opensdk 读取与挂载规则： opensdk 读取与挂载规则：
- 当前 opensdk 通过环境变量 `BAIZHIYUN_ENV` 与 `BAIZHIYUN_APP_ID` 决定运行环境与应用标识 - 当前接入只要求提供 `app_id` 与证书文件挂载
- 当 `BAIZHIYUN_ENV=local` 时，opensdk 走 mock 分支，不读取证书文件 - opensdk 会从固定路径读取证书文件，而不是从环境变量读取路径
- 非 `local` 环境下，opensdk 会从固定路径读取证书文件，而不是从环境变量读取路径
- 固定文件路径是：`/app/ssl/app.crt`、`/app/ssl/app.key`、`/app/ssl/ca.crt` - 固定文件路径是：`/app/ssl/app.crt`、`/app/ssl/app.key`、`/app/ssl/ca.crt`
- 因此在 Chart / workload 中，应把百智云 Secret 以文件名不变的方式挂载到目录 `/app/ssl` - 因此在 Chart / workload 中，应把百智云 Secret 以文件名不变的方式挂载到目录 `/app/ssl`
- 不要把证书挂到其他自定义目录后期待 opensdk 自动发现，例如 `/.tls/baizhi` - 不要把证书挂到其他自定义目录后期待 opensdk 自动发现，例如 `/.tls/baizhi`
@ -371,10 +369,9 @@ opensdk 读取与挂载规则：
提问方式要求： 提问方式要求：
- 只在真正阻塞最终可部署结果时才问 - 只在真正阻塞最终可部署结果时才问
- 先做完不依赖这些值的工作
- 按必填项收集百智云配置 - 按必填项收集百智云配置
- 先索取 `env`，再按固定顺序逐项索取 `app_id`、`app.crt`、`app.key`、`ca.crt`、`public.key` - 按固定顺序逐项索取 `app_id`、`app.crt`、`app.key`、`ca.crt`、`public.key`
- 对外部集成字段，应在非阻塞工作完成后逐项索取 - 对外部集成字段，在生成到对应配置时逐项索取
- 如果当前正在等待用户补值，就把回复重点放在“当前要补的这一项” - 如果当前正在等待用户补值，就把回复重点放在“当前要补的这一项”
- 对应用自带私有依赖内部口令，优先自动生成；只有用户明确要求自定义时才向用户索取 - 对应用自带私有依赖内部口令，优先自动生成；只有用户明确要求自定义时才向用户索取
- 不要用“把需要的都给我”这种模糊问法 - 不要用“把需要的都给我”这种模糊问法
@ -388,8 +385,8 @@ opensdk 读取与挂载规则：
2. 判断任务是补齐应用仓库接入，还是修复发版链路 2. 判断任务是补齐应用仓库接入，还是修复发版链路
3. 生成或修复 `.gitlab-ci.yml` 3. 生成或修复 `.gitlab-ci.yml`
4. 生成或修复 Chart 与 values 4. 生成或修复 Chart 与 values
5. 生成或修复 release bundle 5. 在遇到必填值缺失时，停在当前项并向用户补值
6. 完成非阻塞工作后，再逐项补齐百智云必填字段 6. 生成或修复 release bundle
7. 自检并在最终输出中说明风险点 7. 自检并在最终输出中说明风险点
## 自检要求 ## 自检要求