如何为Ansible playbook中的每个任务添加自定义详细描述字段

Ansible本身允许在任务层级添加任意自定义字段，不会对任务执行造成影响，你示例中的写法可以直接使用，以下是3种成熟的实现方案：

方案1：直接使用顶层自定义description字段（最简便） #

你示例中的写法完全可用，Ansible不会校验任务的非内置顶层字段，只要不和内置关键字（如name、action、when等）冲突即可，description不属于Ansible任务保留关键字，可以安全使用。

- name: Perform X
  description: Perform X by doing A,B,C which is generally done for Y,Z
  module_name:
    module_parameter: xxx

回调插件读取方式：在v2_playbook_on_task_start、v2_runner_on_ok等回调方法中，通过task._attributes.get('description', '无描述')即可获取对应值。

方案2：通过vars字段封装自定义元数据（兼容性最优） #

如果担心后续Ansible版本更新新增内置关键字和你的自定义字段冲突，可以把所有自定义任务元数据放到任务级vars下，符合Ansible变量规范，跨版本兼容性更强。

- name: Perform X
  vars:
    task_description: Perform X by doing A,B,C which is generally done for Y,Z
    task_owner: ops_team
  module_name:
    module_parameter: xxx

回调插件读取方式：通过task.vars.get('task_description', '无描述')即可获取对应值。

方案3：通过tags存储短描述（仅适合极简场景） #

如果描述内容长度很短，也可以用标签前缀的方式存储，仅适合不需要长文本的场景：

- name: Perform X
  tags:
    - desc:Perform X for Y,Z use case
  module_name:
    module_parameter: xxx

回调插件读取方式：遍历task.tags列表，提取前缀为desc:的内容即可。

注意事项 #

以上所有方案都不会影响任务的正常执行逻辑，如果你使用Ansible Tower/AWX，自定义字段也可以在作业事件日志中被正常捕获，无需额外调整平台配置。

内容的提问来源于stack exchange，提问作者Ehack2