第 25 章 通知程序
通知类型 (如 Email、Slack 或 Webhook)是通知模板的实例,具有通知模板中定义的名称、描述和配置。
以下是添加通知模板所需的详情示例:
- 电子邮件通知模板需要用户名、密码、服务器和收件人
- Slack 通知模板需要令牌和频道列表
- Webhook 通知模板需要 URL 和标头
当作业失败时,将使用您在通知模板中定义的配置发送通知。
以下显示了通知系统的典型流程:
-
您可以通过 API 或 UI 创建指向
/api/v2/notification_templates 端点
的REST API
的通知模板。 -
您可以将通知模板分配给支持它的各种对象(所有作业模板变体以及机构和项目)以及您想要通知的适当触发器级别(启动、成功或错误)。例如,您可能希望分配特定的通知模板,以便在作业模板 1 失败时触发。在这种情况下,您可以将通知模板与
/api/v2/job_templates/n/notification_templates_error
API 端点的作业模板关联。 - 您可以在作业启动和作业结束时设置通知。用户和团队也可以定义他们自己的通知,这些通知可以附加到任意作业。
25.1. 通知层次结构
通知模板继承父对象上定义的模板,如下所示:
- 作业模板使用为它们定义的通知模板。此外,他们可以从作业模板使用的项目中继承通知模板,以及它列在下面列出的机构中。
- 项目更新使用项目上定义的通知模板,并从与其关联的机构中继承通知模板。
- 清单更新使用在下面列出的机构上定义的通知模板。
- 临时命令使用与清单关联的组织上定义的通知模板。