CD工具awx之通知NOTIFICATIONS，及时发送消息到企业微信机器人

一、背景

awx的模板执行结果及时通知给相关人员，可以直接在awx界面上配置通知，然后由项目和模板来决定是否开启通知。
通知类型一般选择webhook，消息体的拼接，则需要参考awx官方文档。

除了在awx界面上配置通知外，也可以在playbook脚本中增加发送消息通知，调用python等脚本实现。

本文的消息通知以企业微信的机器人为示例，讲解其配置过程。至于钉钉机器人的对接过程类似，就不重复。

对接企业微信的机器人通知，报文示例见下：

curl 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693axxx6-7aoc-4bc4-97a0-0ec2sifa5aaa' \
   -H 'Content-Type: application/json' \
   -d '
   {
    	"msgtype": "text",
    	"text": {
        	"content": "hello world"
    	}
   }'

机器人地址见下截图：

至此，消息通知的准备工作就做好了，接下来在awx配置通知。

二、配置通知

1、拼接job开始、成功、错误的通知回调的入参

注意，json报文必须遵循企业微信的机器人回调报文格式。

{
    "msgtype": "text",
    "text": {
        "content": "{{ job_friendly_name }}-{{ job.id }} \"{{ job.name }}\" is {{ job.status }}.  \nuser: {{job.summary_fields.created_by.username}}"
    }
}

你可以参考awx官方的webhook-payloads回调文档，定制出符合自己的消息模板。

这里摘要job实体下几个重要的字段，见下json报文：

{"id": 18,
 "name": "Project - Space Procedures",
 "url": "https://towerhost/#/jobs/project/18",
 "created_by": "admin",
 "started": "2019-10-26T00:20:45.139356+00:00",
 "finished": "2019-10-26T00:20:55.769713+00:00",
 "status": "successful",
 "traceback": ""
}

其实，它也可以简写为{{ job_metadata }}

2、开启模板“应用重启”的通知

这样，我们将会收到两个通知消息：任务开始的通知、任务运行成功或失败的通知。

三、运行模板

企业微信收到消息通知：

• 作业运行成功
  

• 作业运行失败
  

四、自定义的webhook回调

如果你发送的消息通知，不是直接对接企业微信，而是自定义接口。

只要在把企业微信的机器人修改你的接口地址即可。

job运行成功或失败的消息体示例：

{
    "created_by": "awx",
    "name": "{{ job.name }}",
    "status": "{{ job.status }}",
    "started": "{{ job.started }}",
    "finished": "{{ job.finished }}",
    "env": "test"
}

关于awx如何实现回调通知，就梳理到这里了。

可以看到，消息体还是比较有限的，只能从awx官方文档里寻找。

如果你要更加灵活的消息通知，建议在playbook脚本里实现，可以读取到更多信息，比如程序的版本号。

版本号，对以应用为中心的程序部署来说，非常关键。