已开启
docs(preflight): add unified preflight design #210
docs(preflight): add unified preflight design #210
已开启
thyzfmh创建于 7月29日
thyzfmh成员
7月29日

变更内容

本 PR 将统一前置检查设计收敛为 6 份与 bkeadm PR !336 当前实现一致的文档:

  • openFuyao统一前置检查提案.md:全局用法、边界、架构、规则、报告、退出码、发布 policy/Bundle 和文档要求。
  • init阶段检查项提案.md:init 输入、Plan、27 个模板、依赖、采集、修复建议和开发完成定义。
  • cluster-create阶段检查项提案.md:cluster-create 输入、Plan、46 个模板、management/SSH DAG、修复建议和开发完成定义。
  • 校验框架SDK提案.md:通用 SDK DTO、Adapter/Collector 契约、DAG、类型、安全、报告和扩展门禁。
  • preflight-bundle-gen提案.md:固定 revision release-input、SourceLock、PolicyDigest/BundleDigest 和 generate/verify 门禁。
  • openFuyao统一前置检查代码设计报告.md:真实代码映射、验证证据、CodeCheck 审查结论和外部证据边界。

旧目录 README、旧总体设计、规格详细设计和独立检查项清单不再进入 PR;检查项已按当前 Bundle 完整迁入 init/cluster-create 两份阶段提案。

当前设计边界

  • 只支持 bke preflight initbke preflight cluster-create,不覆盖 build、Web 或安装执行。
  • 不提供 --request 或运行时 policy/Bundle/Provider defaults 覆盖。
  • preflight.yaml 是发布编译输入,不是最终用户动态规则文件;修改后需重新生成/校验 Bundle 并重建二进制。
  • 只做有明确 BKE/Provider/release 来源的检查,不重新纳入历史泛化检查。
  • fake collector 测试不作为真实 CLI/SSH/Kubernetes E2E;正式发布和真实管理集群证据单独记录。

用户文档

  • 中英文 before_you_start.md 增加运行 preflight 的安装前建议。
  • 中英文 command_reference.md 增加命令、参数、报告、退出码、只读和规则发布说明。
  • 中英文环境预检查工具指南明确新的 bke preflight 与历史 envCheck 的能力边界。

校验

  • 设计目录最终仅保留上述 6 份文件。
  • init 27 个、cluster-create 46 个规则 ID 与当前内嵌 Bundle 集合一致。
  • 总体提案中的完整 preflight.yaml 与仓库 policy 字段和值一致。
  • 中英文命令、退出码和限制说明已同步。
  • git diff --check 通过;实现验证和证据边界以代码设计报告及 bkeadm PR !336 为准。
likedislike
合并受阻
openFuyao-botopenFuyao-bot成员
7月29日 添加了label:sig/sig-Installation
openFuyao-bot
openFuyao-bot成员
7月29日 评论:

欢迎来到 openFuyao 社区

Hey @thyzfmh , 感谢你对社区的贡献.

机器人使用手册

有关指令的使用,可以点击 此处 查看详情。开发人员可以在每个PR或Issue下方评论特定指令来触发机器人任务。

联系指引

有疑问可以联系 SIG: sig-Installation ,
维护者是: @foxbit, @javadoors, @regandy, @xuyouhong, @zqw1 ,
审核者是: @piamposer-li .

likedislike
openFuyao-botopenFuyao-bot成员
7月29日 添加了label:openFuyao-cla/no
openFuyao-botopenFuyao-bot成员
7月29日 添加了label:ci-running
openFuyao-botopenFuyao-bot成员
7月29日 删除了label:ci-running
此处折叠了96条消息 查看更多
openFuyao-bot
openFuyao-bot成员
1 天前 评论:

CLA 签署成功

thyzfmh, 感谢您的代码贡献。 所有的代码贡献者都已完成了 CLA 签署。 👍

likedislike
openFuyao-botopenFuyao-bot成员
1 天前 删除了label:ci-successful
openFuyao-botopenFuyao-bot成员
1 天前 添加了label:ci-running
openFuyao-botopenFuyao-bot成员
1 天前 删除了label:ci-running
openFuyao-botopenFuyao-bot成员
1 天前 添加了label:ci-successful