首页/系统与基础设施/自动化运维速查/自动化任务的命名与目录规范
自动化基础与选型50 条

自动化任务的命名与目录规范

自动化资产的命名与目录规范解决的是「能不能被找到」的问题:包按功能域、角色按组件、剧本按用途、变量按环境分层命名,目录结构与命名规则统一后,新人可以按名字推断用途与作用范围,检索与复用成本大幅下降。规范宜少而硬,靠评审而非文档维持。

​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌​​‌​‌‌‌‌​‌‌​​​​‌​‌‌‌​‌​‌​‌‌‌​‌​​​‌‌​‌‌‌‌​‌‌​‌‌​‌​‌‌​​​​‌​‌‌‌​‌​​​‌‌​‌​​‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​​‌​‌‌‌‌​‌‌​​​​‌​‌‌‌​‌​‌​‌‌‌​‌​​​‌‌​‌‌‌‌​‌‌​‌‌​‌​‌‌​​​​‌​‌‌‌​‌​​​‌‌​‌​​‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​​‌​‌‌​‌​‌‌‌​‌​​​‌‌​​​​‌​‌‌‌​​‌‌​‌‌​‌​‌‌​​‌​‌‌​‌​‌‌​‌‌‌​​‌‌​​​​‌​‌‌​‌‌​‌​‌‌​‌​​‌​‌‌​‌‌‌​​‌‌​​‌‌‌​​‌​‌‌​‌​‌‌​​‌​​​‌‌​‌​​‌​‌‌‌​​‌​​‌‌​​‌​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​‌‌‌​​‌​​‌‌‌‌​​‌​​‌​‌‌​‌​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​‌‌‌​‌‌​​‌‌​​‌​‌​‌‌​‌‌‌​​‌‌‌​‌​​​‌‌​‌​​‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​​‌​‌‌‌​​‌‌​‌​​​​‌‌‌​‌​​​‌‌​‌‌​‌​‌‌​‌‌​​

规范要解决什么

自动化资产数量增长后,最大的成本往往不是编写而是查找与判断:哪条剧本负责发布、哪个变量控制连接数、这份脚本还有没有人用。命名与目录规范的价值在于让这些判断不需要问人。好的规范通常只有几条硬规则:目录按用途而不是按作者划分,剧本名表达目标动作,角色名等于被管理的组件名,变量名带业务或组件前缀。

基本信息

目录划分按用途分层:清单、角色、剧本、变量、模板
剧本命名动词加对象,如 deploy-web、rollback-db
角色命名被管理的组件名,如 nginx、mysql
变量命名组件前缀加含义,避免通用名冲突

常用约定

  • 不使用「临时」「测试」等含义模糊的名字作为长期资产命名。
  • 同名文件在不同环境中不重复出现,环境差异由变量承担。
  • 剧本名与对应变更类型一致,便于从工单反查资产。
  • 目录不按人划分,避免人员变动后资产无人接手。
  • 归档目录单独设置并写明有效期,避免废弃资产混在主线里。
  • 命名长度适中,避免出现靠缩写猜含义的文件名。

命名对照

对象推荐形式应避免
剧本动作加对象,如 patch-linuxtest2、新建剧本
角色组件名,如 nginxnginx-v2-final
变量组件加含义,如 nginx_worker_processescount、value
模板目标文件名加模板后缀a.conf、tmp.conf
清单按环境命名,如 prod-hostshosts-new、hosts2
归档加日期与前缀标记无标记的 old 目录
规范要靠评审执行:提交时检查命名与目录位置,比事后写一篇规范文档有效得多。规范条数越少越容易坚持。
改名要连带更新引用:剧本、流水线配置与文档都引用资产名时,重命名要一次改完,否则会出现执行到旧名字才报错的情况。

易错点

  • 按人划分目录:负责人变动后资产归属不清,新人不敢改也不愿删
  • 用版本号堆名字:同一角色出现多个最终版,无法判断哪个在生效
  • 变量用通用名:不同角色的同名变量互相覆盖,取值随加载顺序变化
  • 归档无标记:废弃资产与在用资产混在一起,误执行废弃剧本会造成意外变更

数据来源与参考

  • Red Hat《Ansible 官方文档:内容组织与最佳实践》
  • Google SRE 工作手册(运维工具与资产组织章节)
  • Git 官方文档(仓库结构与命名约定)

整理校对:其其网ICT文档中心 · 本页地址:docs.qiqicto.com/automation/automation-task-naming-directory-convention.html

​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌​​‌​‌‌‌‌​‌‌​​​​‌​‌‌‌​‌​‌​‌‌‌​‌​​​‌‌​‌‌‌‌​‌‌​‌‌​‌​‌‌​​​​‌​‌‌‌​‌​​​‌‌​‌​​‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​​‌​‌‌‌‌​‌‌​​​​‌​‌‌‌​‌​‌​‌‌‌​‌​​​‌‌​‌‌‌‌​‌‌​‌‌​‌​‌‌​​​​‌​‌‌‌​‌​​​‌‌​‌​​‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​​‌​‌‌​‌​‌‌‌​‌​​​‌‌​​​​‌​‌‌‌​​‌‌​‌‌​‌​‌‌​​‌​‌‌​‌​‌‌​‌‌‌​​‌‌​​​​‌​‌‌​‌‌​‌​‌‌​‌​​‌​‌‌​‌‌‌​​‌‌​​‌‌‌​​‌​‌‌​‌​‌‌​​‌​​​‌‌​‌​​‌​‌‌‌​​‌​​‌‌​​‌​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​‌‌‌​​‌​​‌‌‌‌​​‌​​‌​‌‌​‌​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​‌‌‌​‌‌​​‌‌​​‌​‌​‌‌​‌‌‌​​‌‌‌​‌​​​‌‌​‌​​‌​‌‌​‌‌‌‌​‌‌​‌‌‌​​​‌​‌‌‌​​‌‌​‌​​​​‌‌‌​‌​​​‌‌​‌‌​‌​‌‌​‌‌​​