已关闭
【文档】k8s_security_hardening_user_guide.md 存在路径缺失、内容重复问题 #8
ZYH-ang创建于  21 天前关闭于  17 天前
ZYH-ang
ZYH-ang成员
21 天前 创建

问题背景

对 docs/k8s_security_hardening_user_guide.md(K8s安全加固工具使用指导)进行文档评审,与 compliance-hardening/ 下脚本实现逐条核对后发现 2 个问题,会导致用户按文档操作失败或产生误解。


问题 1:未说明工具在仓库中的位置,命令照文档执行不通(严重)

  • 位置:全文(如 §2.1、§3、§4.1-4.2、§5.1)
  • 现状:文档通篇使用相对路径命令,例如:
    • ./bin/k8s-hardening.sh cluster-harden config/cluster.yaml --dry-run
    • cp config/cluster.example.yaml config/cluster.yaml
  • 实际:工具位于仓库 compliance-hardening/ 子目录(compliance-hardening/bin/k8s-hardening.sh、compliance-hardening/config/cluster.example.yaml),文档全文没有任何一处提示需先进入该目录。
  • 后果:用户按文档从仓库根目录执行,第一步即报「文件不存在」,直接卡住。
  • 建议:在「2. 前提条件」或文档开头明确说明:工具位于仓库 compliance-hardening/ 目录,以下所有命令均在该目录下执行。

问题 2:§5.2「统一备份机制」整段内容重复(中等)

  • 位置:§5.2(L371-L381)
  • 现状:「统一备份时间戳」说明完整叙述了两遍——第一段先叙述机制并附日志示例;紧接着第二段(加粗「统一备份时间戳」开头)把同样内容(统一下发时间戳→阶段0预备份→含已合规节点→changes.json为空→预备份失败补做→--backup-subdir统一回退)重新写了一遍,连日志输出示例都内联重复,疑似编辑合并残留。
  • 后果:读者难以分辨哪段为正文、是否存在两种不同机制,影响文档可信度与阅读体验。
  • 建议:删除其中一段,保留一份完整描述。

复现/核对方式

  • 文档:docs/k8s_security_hardening_user_guide.md
  • 实现核对:compliance-hardening/bin/k8s-hardening.sh、compliance-hardening/lib/cluster.sh、compliance-hardening/config/cluster.example.yaml
likedislike
openFuyao-botopenFuyao-bot成员
21 天前 添加了label:sig/security-committee
openFuyao-bot
openFuyao-bot成员
21 天前 评论:

欢迎来到 openFuyao 社区

Hey @ZYH-ang , 感谢你对社区的贡献.

机器人使用手册

有关指令的使用,可以点击 此处 查看详情。开发人员可以在每个PR或Issue下方评论特定指令来触发机器人任务。您可以自助配置此仓库的 PR 合并规则,更多详情,请参阅此处。

联系指引

有疑问可以联系 SIG: security-committee ,
维护者是: @piamposer-li, @regandy, @ruanhanqing, @zhang_wei5630 ,
审核者是: @foxbit, @guanyu_zhu, @h3nt41, @hardbrick, @javadoors, @zhangxyjlu .

likedislike
ZYH-angZYH-ang成员
21 天前 修改了issue 的描述
ZYH-angZYH-ang成员
21 天前 修改了issue 的描述
ZYH-angZYH-ang成员
21 天前 issue优先级由 无优先级 改变为 次要
ZYH-angZYH-ang成员
21 天前 修改了issue 的描述
ZYH-angZYH-ang成员
21 天前 修改标题为 “【文档】k8s_security_hardening_user_guide.md 存在路径缺失、内容重复问题”,原标题为“【文档】k8s_security_hardening_user_guide.md 存在路径缺失、SSH认证描述失实、内容重复三个问题”
ZYH-angZYH-ang成员
20 天前 关联了看板:openFuyao - v26.09问题单
ZYH-angZYH-ang成员
20 天前 关联了里程碑:v26.09
lihangyulihangyu成员
19 天前 关联了pull request:fix: 修复 K8s 安全加固回退与健康检查问题并完善使用文档
openFuyao-botopenFuyao-bot成员
19 天前 关闭了 issue
lihangyulihangyu成员
19 天前 issue状态由 开启 改变为 待测试
lihangyulihangyu成员
19 天前 重新打开了 issue
ZYH-angZYH-ang成员
17 天前 issue状态由 待测试 改变为 已完成
ZYH-angZYH-ang成员
17 天前 关闭了 issue
ZYH-angZYH-ang成员
17 天前 将 ConstHall1 设为负责人