IBM Cloud Docs
配置 Slack

配置 Slack

Slack 是基于云的实时消息传递和通知系统。

You can now distribute event notifications by using the Event Notifications tool integration. IBM Cloud® Event Notifications is the preferred method for distributing notifications to Slack and other communication channels such as PagerDuty, email, SMS, push notifications, webhook, Microsoft® Teams, ServiceNow, and IBM Cloud Functions. 有关使用 Event Notifications的更多信息,请参阅 为工具链启用事件通知

不会将 POST /toolchains/{toolchain_id}/events API 生成的客户机定制工具链事件发送到 Slack 工具集成。 Bespoke 工具链事件仅发送到 IBM Cloud® Event Notifications。

Slack 提供持久交谈,可替代电子邮件用于团队协作,其互动性更高。 您可以通过专用通道或与您工作直接相关的一组通道,与团队进行通信。 您还可以通过通道或直接消息,在两人或多人之间共享文件和图像。 直接消息和通道的通信会保留,以便您可以对它们进行搜索。

团队中的每一个人都可以看到发布到公共 Slack 通道的通知。 您要对发布的内容负责。

配置 Slack,以从工具集成接收有关工具链的通知,如测试和部署活动:

  1. 如果您在创建工具链时配置此工具集成,请在“可配置的集成”部分中,单击 Slack

  2. 如果您有一个工具链并要将此工具集成添加到其中,请从IBM Cloud控制台单击菜单图标汉堡包图标>平台自动化>工具链。 在“工具链”页面,单击工具链打开其“概述”页面。 或者,在应用程序“概述”页面的“持续交付”卡上,单击查看工具链。 然后,单击概述

    a. 单击添加工具

    b. 在“工具集成”部分中,单击 Slack

  3. 输入 Slack Webhook URL,其由 Slack 作为入局 Webhook 生成。 您需要 Slack Webhook URL,Slack 通道才能从工具集成接收有关工具链的通知。 有关创建或查找网络钩子的说明,请参阅 传入网络钩子

如果您使用 API 密钥让 Slack 通道从工具集成接收有关工具链的通知,那么您必须更新配置以改用 Webhook。

  1. 输入您想要发送通知的目标 Slack 通道的名称。 在 Slack 团队中,该通道必须已经存在且处于活动状态。

  2. 为 Slack 团队输入 URL 主机名,其为团队 URL 中 .slack.com 前的单词或短语。 例如,如果团队 URL 为 https://team.slack.com,那么主机名为 team

  3. 单击创建集成

    如果无法访问您指定的 Slack 通道和团队,那么在 Slack 卡上会显示Setup Failed错误。 将鼠标悬停在Setup Failed消息上并单击重新配置。 请确保为 Slack 团队的 Slack Webhook URL、Slack 通道和 URL 主机名,使用有效的配置参数。 按需要更新设置并单击保存集成

  4. 在工具链的“概述”页面上的 第三方工具 卡上,单击 Slack。 您可以在已配置的 Slack 通道中查看工具链的所有活动。

使用 API 配置 Slack

当您 创建读取更新 工具集成时,Slack 工具集成支持可用于 工具链 HTTP API 和 SDK 的以下配置参数。

必须在请求主体中使用 slack 值指定 tool_type_id 属性。

Slack 工具集成参数
参数 用途 Type Terraform 自变量 描述
api_token 必需,可更新 密码 webhook Slack 用于接收事件的入局 Webhook。 您可以将工具链私钥引用用于此参数。 有关私钥引用的更多信息,请参阅 保护 IBM Cloud中的敏感数据
channel_name 必需,可更新 字符串 channel_name 要发布通知的 Slack 频道。
管道失败 可选,可更新,Default: true 布尔值 管道失败 生成 pipeline failed 通知。
管道启动 可选,可更新,Default: true 布尔值 管道启动 生成 pipeline start 通知。
管道成功 可选,可更新,Default: true 布尔值 管道成功 生成 pipeline succeeded 通知。
team_url 可选,可更新 字符串 团队名称 Slack 团队名称,这是团队 URL 中 .slack.com 之前的单词或短语。
toolchain_bind 可选,可更新,Default: true 布尔值 toolchain_bind 生成 tool added to toolchain 通知。
toolchain_unbind 可选,可更新,Default: true 布尔值 toolchain_unbind 生成 tool removed from toolchain 通知。

为 Tekton Pipeline 启用 Slack 通知

您可以配置 Tekton Pipeline 以将事件发送到 Slack 集成。

  1. 从工具链的“概述”页面中的 交付管道 卡上,单击 Delivery Pipeline 以打开 Tekton Delivery Pipeline 仪表板。
  2. 在“设置 > 高级设置”页面上,启用 Event Notifications
  3. 保存更改。