在 Red Hat Hybrid Cloud 控制台中配置通知和集成
配置混合云控制台设置，以便帐户用户收到事件通知
摘要
第 1 章 Red Hat Hybrid Cloud Console 通知和集成简介
Red Hat Hybrid Cloud Console 上的通知服务会释放用户定期检查其用户界面，从而查找事件触发的通知。相反，当事件发生时，服务会自动采取将事件发送到用户的操作。
组和角色（包括 Notifications administrator 角色）必须由机构管理员配置，以便通过电子邮件和集成报告事件。
要了解更多有关 Red Hat Hybrid Cloud Console 平台上的用户访问权限的信息，请参阅基于角色的访问控制(RBAC)的用户访问权限指南。
1.1. 通知服务的作用
通过通知服务，Red Hat Hybrid Cloud Console 应用程序和服务有标准化的方法来通知用户事件。通过设置行为组，通知管理员指定通知发送方法，以及事件通知是否发送到帐户中的所有用户，还是只向机构管理员发送。
例如，通知管理员可以将服务配置为向（公告服务）新建议点击系统发送电子邮件通知。同样，管理员可能决定使用 webhook 集成类型触发向第三方应用程序发送通知。
机构管理员通过使用 Notifications 管理员角色创建 User Access 组来指定通知管理员，然后将帐户成员添加到组中。然后，通知管理员配置通知行为组，以定义发生特定于服务事件时执行的操作。
通知服务将事件通知传送到用户的电子邮件帐户，或使用 Webhook 传送到第三方应用程序。Hybrid Cloud Console 帐户上的用户为接收电子邮件通知设置了自己的首选项。在 User preference > Notifications > application bundle 中，每个用户都将其个人设置配置为接收事件通知电子邮件作为即时通知或每日摘要。
为任何服务选择 Instant 通知 可能会导致收到大量电子邮件。
1.2. 通知和集成概念
下表定义了了解通知服务的工作方式非常重要的术语：
表 1.1. 通知概念
| 概念 | 描述 |
|---|---|
| Actions | 响应事件时执行的操作。示例包括发送电子邮件或将通知转发到集成端点，如 Webhook。操作是在通知管理员配置的行为组中定义。 |
| 应用程序捆绑包 | 应用程序捆绑包指的是混合云控制台中的应用程序组，如 Red Hat Enterprise Linux (Insights for RHEL)或 OpenShift。 |
| 行为组 | 行为组决定发生事件时要执行的操作，以及是否通知所有帐户用户或仅指定管理员。通知管理员创建行为组后，它们将与事件类型关联，让通知管理员能够对所有特定应用程序的事件应用相同的操作。 注意： 通知管理员为每个应用程序捆绑包单独配置通知行为组。 |
| 电子邮件首选项 | 有权访问混合云控制台上的应用程序的个人用户设置他们的个人电子邮件首选项。用户可以配置个人电子邮件通知，以立即到达事件发生，或整合成每日摘要，该摘要到达所有帐户的每天 00:00 Coordinated Universal Time (UTC)。 重要信息： 为任何服务选择 Instant 通知可能会导致收到大量电子邮件。 |
| 事件类型 | 事件类型是特定于应用程序的系统更改，可触发应用程序或服务来启动通知操作。事件类型由红帽的应用程序开发人员创建，并且每个应用程序捆绑包都是唯一的。RHEL (Red Hat Enterprise Linux)应用程序捆绑包的 Insights 示例包括： evince 策略服务： 策略触发器 Dan drift 服务： 从检测到的基准中拖放 顾问服务： 新建议；解决建议 |
| 集成 | 集成定义了向通知管理员配置的第三方应用程序发送通知方法。配置后，通知服务会将 HTTP POST 消息发送到端点。 |
| 用户访问角色 | 以下用户访问角色与通知交互： Dan 机构管理员 合并通知管理员 合并 通知查看器 |
1.3. Insights 事件和通知选项
将 Insights 集成到组织的工作流中的主要方法有三个主要方法：
- 使用 Insights API
- 直接使用 webhook 和/或直接发送给用户
- 使用与第三方应用程序（如 Splunk 或 ServiceNow）集成
1.3.1. 使用 Insights API
Insights API 可以公开提供，可以从任何经过身份验证的客户端(RBAC 控制)查询。
有关应用程序和服务可用端点的更多信息，请参阅 Red Hat Insights API 文档。有关 CSV 格式的响应示例，请参阅 系统比较 API 文档。
Red Hat Insights API cheat sheet 涵盖了 Insights API 的使用。它提供一些示例，可帮助您快速开始使用身份验证和查询端点。大多数示例使用 curl 命令，但本文档还包括使用 Python 编写的客户端的示例代码，以及执行类似操作的 Ansible playbook。
1.3.2. 使用集成 Webhook
Webhook 的工作方式与 API 类似，但在事件触发时启用单向数据共享。API 在两个方向共享数据。允许入站数据请求的应用程序表示有公开的 Webhook。
您可以配置 Insights，将 POST 信息发送到应用程序内公开的 webhook 中的特定端点。此功能与 Notifications 服务一起工作。例如，您可以将 Insights 配置为在 Insights 标识它们后立即自动向所选管理员帐户发送新的顾问建议。
在通知中配置端点后，您可以订阅 Insights 事件流，并自动将该流转发到您选择的 webhook。每个事件都包含额外的元数据，您可以用来处理事件（例如，执行特定的操作和/或触发器响应），作为操作工作流的一部分。您可以在应用程序中配置实施和数据处理。
有关如何配置和使用 Webhook 的更多信息，请参阅配置 集成。
1.3.3. 使用第三方应用程序
根据用例，Insights 第三方应用程序集成以两种方式之一工作：
- 使用 Insights API 收集数据并执行任务
- 订阅 Insights 事件流
您可以使用 Red Hat Insights 集成将事件通知转发到特定的第三方应用程序，如 Splunk、ServiceNow 和 Slack。该集成允许您使用应用程序仪表板（如 Splunk 仪表板）查看和使用现有工作流中的 Insights 数据。对于 Slack，通知会在您配置的频道中显示为 Slack 信息。
有关如何将 Insights for Red Hat Enterprise Linux 与第三方应用程序集成的更多信息，请参阅 Red Hat Hybrid Cloud Console 中配置集成和事件。
第 2 章 配置用户访问
在帐户用户可以配置通知和集成设置前，必须在机构管理员的用户访问中配置具有 Notification 管理员角色的组。在 Red Hat Hybrid Cloud Console > Settings 菜单(gear icon)> Identity & Access Management > User Access > Groups 中，机构管理员执行以下高级别步骤：
为通知管理员创建一个 User Access 组。
- 将 Notifications administrator 角色 添加到组中。
- 向 组添加成员 （具有帐户访问权限的用户）。
Organization Administrator（机构管理员）
机构管理员为通知管理员配置 User Access 组，然后将 Notifications administrator 角色和用户添加到组中。
通知管理员角色
通知管理员配置应用程序如何与通知交互。通知管理员配置行为组，以定义应用程序如何通知用户有关事件。管理员可以在集成可用时配置额外的集成，以及编辑、禁用和删除现有的集成。
通知查看器角色
Notifications viewer 角色会自动限制到帐户中的每个人，并限制用户如何与通知服务视图和配置交互。viewer 可以查看通知配置，但不能修改或删除它们。查看器也无法配置.r 修改或删除集成。
有关 Red Hat Hybrid Cloud Console 平台上的用户访问权限的更多信息，请参阅基于角色的访问控制(RBAC)的用户访问权限指南。
2.1. 在用户访问中创建和配置通知组
以下流程演示了帐户的 机构管理员 如何使用 Notifications 管理员角色 创建组，并将成员添加到组中。
先决条件
- 您必须以机构管理员身份登录到您的 Red Hat Hybrid Cloud Console 帐户。
流程
单击应用程序窗口 右上角的齿轮图标，然后选择 Settings。
- 在左侧的 Settings 菜单中，点 User Access 并选择 Groups。
- 点 Create group。
- 输入组名称，如 Notifications Administrators 和 description，然后点 Next。
- 选择要添加到此组的角色，本例中为 administrator。点该角色的复选框并点 Next。
- 将成员添加到组中。根据用户名、电子邮件或状态搜索单个用户或过滤。选中每个预期成员名称旁边的复选框，然后单击 Next。
- 查看详情以确保所有内容都正确。如果您需要返回并更改内容，请单击 Back。
- 点 Submit 以完成组的创建。
2.2. 编辑或删除用户访问权限组
如果您需要编辑或删除 User Access 组，请执行以下步骤：
先决条件
- 您必须以机构管理员身份登录到您的 Red Hat Hybrid Cloud Console 帐户。
流程
- 在 Red Hat Hybrid Cloud Console > Settings 菜单(gear 图标) > Identity & Access Management > User Access > Groups 中找到组名称。
-
点击组名称行右边的菜单选项图标(
)，然后点 Edit 或 Delete。
- 进行并保存更改或删除组。
第 3 章 配置集成
红帽混合云控制台通知和集成服务协同工作，以在触发事件时将消息传送到第三方应用程序端点，如即时消息传递平台和外部票据系统。
这可让通知管理员将混合云控制台功能集成到其组织中使用的操作工作流中。集成由通知管理员在 Red Hat https://console.redhat.com[Red Red Hat Hybrid Cloud Console > Settings > Integrations] 中配置。
Webhook 是 Red Hat Hybrid Cloud Console 平台支持的当前集成类型。配置后，服务会向指定的第三方应用端点发送 HTTP POST 消息。
3.1. HTTP POST 信息
以下屏幕截图是发送到第三方应用端点的 HTTP POST 消息的示例。事件类型特定于服务或应用程序。例如，Insights for RHEL 应用程序捆绑包目前会通知配置了策略、公告和偏移服务的事件用户。以下来自 RHEL advisor 服务的 Insights 通知示例由主机系统上的新建议触发。
在示例中，块包含以下信息：
有关发送通知的捆绑包和应用程序的信息
- bundle： 应用程序捆绑包的名称
- Application： 发送事件通知的独立应用程序或服务的名称
- event_type： 触发通知的事件类型
- account_id：从其中发送通知的红帽帐户
- Timestamp： ISO-8601 格式化日期显示通知的发送时间
有关应用程序或服务特定事件的信息
- payload ： 应用程序有效负载，它是一个 JSON 字符串，其中包含应用程序发送的所有数据
有关发生事件的系统的信息。例如：
- inventory_id ： 系统 ID
- 主机名 ： 系统名称
- RHEL_VERSION： 系统上运行的 RHEL 版本
metadata 字段目前没有被使用。
3.2. 设置集成
通知管理员为组织设置集成。除了添加新集成外，通知管理员还可以通过点击位于集成名称右侧的 More options 菜单图标
来编辑、删除或禁用任何列出的集成，然后点击适当的选项。
先决条件
- 要执行以下步骤，用户必须使用在 User Access 中配置通知管理员权限登录到 Red Hat Hybrid Cloud Console 平台。
流程
- 导航到 Red Hat Hybrid Cloud Console > Settings > Integrations。
单击 Add integration。
- 输入集成名称。
- 选择集成 类型，如 Webhook。
- 提供 端点 URL。
默认选中启用 SSL 验证的复选框。
重要SSL 对于保护发送到集成端点的数据至关重要。在将 Red Hat Hybrid Cloud Console 集成到第三方应用程序时，应始终使用 SSL。
如果需要，提供 Secret 令牌。
注意如果定义，Secret 令牌将用作 POST HTTP 请求的 'X-Insight-Token' 标头。
- 点击 Save。
新的集成会被默认启用，当通知管理员在通知服务中配置行为组时作为集成选项使用。要禁用集成，请使用 Integrations 列表 Enabled 列中的切换按钮。
第 4 章 配置通知行为组
通知管理员通过行为组为帐户配置通知。创建行为组后，通知管理员将其与触发事件相关联，每个应用程序捆绑包都是唯一的。
发生事件时，在用户首选项中选择的帐户中的所有用户都会接收通知，以及所有在行为组中指定为集成操作的第三方应用程序。
4.1. 创建行为组
使用 Create behavior group 向导来创建新的行为组。该向导可让您选择通知，为用户或组分配通知，并将 Insights 事件与行为组关联。
事件可以与多个行为组关联。如果行为组没有与任何事件关联，则发生事件时不会发送通知。
您可以在机构中最多创建 64 个行为组。
先决条件
- 机构管理员已在 User Access 中配置了通知组、角色和成员。
- 您必须登录到 Red Hat Hybrid Cloud Console 平台。
- 您已在 User Access 中配置了管理员特权。
流程
- 进入 Insights for Red Hat Enterprise Linux > Settings。
- 在 Settings 菜单中，展开 Notifications 并选择 应用程序捆绑包，如 Red Hat Enterprise Linux。
单击 Create new group。Create behavior group 向导将打开。
- 输入组名称，然后单击 Next。此时会显示 Actions 和 receivers 页面。
从 Actions 下拉列表中，选择 Send a email，或者从列表中选择集成。
- 如果您选择了 发送电子邮件，请从 Recipient 下拉列表中选择一个接收者。您可以指定电子邮件通知应进入机构中 所有用户，或者您可以限制机构中 管理员 的接收者。如果您配置了 User Access groups，您可以选择 User Access 组来接收电子邮件通知。
如果您选择了一个集成（如 Integration: Webhook 或 Integration: Splunk），请从 Recipient 下拉列表中选择集成端点（例如 SPLUNK_AUTOMATION）。
注意您可以在 Settings > Integrations 中为每个集成配置端点。如果禁用某个操作，则该事件类型不存在集成。
- 要添加额外操作来通知其他集成端点，请单击 Add action。
完成添加操作后，点 Next。此时会显示 关联事件类型 页面。
选择您要包含在通知中的事件类型。选择完事件类型后，点 Next。此时会出现 Review 页面。
- 查看您为行为组选择的设置。若要修改设置，请单击 Back。若要保存设置并创建行为组，请单击 Finish。
其他资源
- 有关如何创建用户访问权限(RBAC)组的更多信息，请参阅使用角色和成员管理访问权限。
4.2. 修改行为组
使用 Edit behavior group 向导修改现有行为组的设置。该向导可让您选择通知，为用户或组分配通知，并将 Red Hat Insights 事件与行为组关联。
事件可以与多个行为组关联。如果行为组没有与任何事件关联，则发生事件时不会发生任何行为。
先决条件
- 机构管理员已在 User Access 中配置了通知组、角色和成员。
- 您必须使用通知管理员权限登录到 Red Hat Hybrid Cloud Console 平台。
流程
- 进入 Insights for Red Hat Enterprise Linux > Settings。
- 在 Settings 菜单中，展开 Notifications 并选择 应用程序捆绑包，如 Red Hat Enterprise Linux。
- 点 Behavior Groups 以显示可用的行为组。
点击您要修改的行为组右上角的 More options 菜单(image::img-hcc-icons-options.png[])。这会打开 Edit behavior group 向导。
- 输入组名称，然后单击 Next。此时会显示 Actions 和 receivers 页面。
从 Actions 下拉列表中，选择 Send a email，或者从列表中选择集成。
- 如果您选择 Send a email，请从 Recipient 下拉列表中选择一个接收者。您可以指定电子邮件通知应进入机构中 所有用户，或者您可以限制机构中 管理员 的接收者。如果您配置了 User Access groups，您可以选择 User Access 组来接收电子邮件通知。
如果您选择了一个集成（如 Integration: Webhook 或 Integration: Splunk），请从 Recipient 下拉列表中选择集成端点（例如 SPLUNK_AUTOMATION）。
注意您可以在 Settings > Integrations 中为每个集成配置端点。
- 要添加额外操作来通知其他集成端点，请单击 Add action。
完成添加操作后，点 Next。此时会显示 关联事件类型 页面。
选择您要包含在通知中的事件类型。选择完事件类型后，点 Next。此时会出现 Review 页面。
- 查看您为行为组选择的设置。若要继续修改设置，请单击 Back。若要保存行为组的设置，请单击 Finish。
第 5 章 配置用户首选项
Red Hat Hybrid Cloud Console 帐户上的每个用户都必须选择接收电子邮件通知。如果您没有设置用户首选项，则不会接收有关事件的电子邮件。
选择要接收通知的服务，以及频率：立即（每个触发的事件）或每日摘要。
为任何服务选择 Instant 通知 可能会导致收到大量电子邮件。
5.1. 为电子邮件通知配置用户首选项
每个用户配置自己的首选项，以接收有关事件驱动的系统更改的电子邮件。
先决条件
- 您必须是一个注册的用户，并登录到 Red Hat Hybrid Cloud Console 平台。
流程
- 在应用程序窗口右上角找到您的用户名。
- 单击用户名右侧的箭头，然后选择 用户首选项。
- 在左侧导航面板中，点 Notifications 并选择适当的应用程序捆绑包，如 Red Hat Enterprise Linux 或 OpenShift。
为每个服务选择一个电子邮件首选项。
重要为任何服务选择 Instant 通知 可能会导致收到大量电子邮件。
- 点 Save。
电子邮件通知以您选择的格式和频率发送。
如果您决定停止收到通知，请选择 Unsubscribe from all，然后单击 Save。除非返回到此屏幕并再次订阅一次，否则您将不再收到任何电子邮件通知。
第 6 章 使用事件日志和集成设置排除通知失败的问题
通知服务事件日志可让通知管理员在通知无法正常工作时轻松看到。事件日志提供了 Red Hat Hybrid Cloud Console 帐户上所有触发的事件的列表，以及过去 14 天执行的操作（如相关行为组中配置）。
在 Actions 列中，每个事件都显示在 green 或 red 中突出显示的集成类型。这些视觉颜色代码分别指示消息传输的状态：success 或 failure。
以下用例演示了事件日志的故障排除功能：
检查端点配置，以排除降级连接的问题。
可过滤的事件日志是一个有用的故障排除工具，用于查看失败的通知事件，并确定端点的潜在问题。在事件日志中看到失败的操作后，通知管理员可以检查端点，并在 Integrations 屏幕中检查最后五个连接尝试的状态。
在集成服务中，以下连接状态会用颜色来反映：
- 绿色： 在之前传输成功
- 红帽： 之前传输失败(timeout、404 错误等)
- 黄色： 连接被降级，前五个传输中至少两个失败
- unknown ： 集成还没有被调用，或者未与行为组关联
确定用户的非接收电子邮件是否是配置还是用户错误。
事件日志可以回答与接收电子邮件相关的问题。通过以绿色形式显示事件的电子邮件操作，事件日志可让通知管理员成功发送电子邮件。接收通知电子邮件的问题可能是 个人用户首选项，而不是通知配置。
即使正确配置了通知和集成，Red Hat Hybrid Cloud Console 帐户上的单个用户必须配置其 用户首选项 才能接收电子邮件。
6.1. 检查事件日志中的连接失败
使用以下步骤检查通知操作失败。
先决条件
- 您必须使用在 User Access 中配置的通知管理员权限登录到 Red Hat Hybrid Cloud Console。
- 用户在使用 Webhook 集成类型接收通知前，您机构首选 Webhook 应用程序的端点必须由集成服务中的通知配置。
- 用户收到电子邮件通知前，必须为每个混合云控制台应用程序捆绑包配置其个人电子邮件通知首选项。
流程
- 导航到 Red Hat Hybrid Cloud Console > Settings > Notifications > Event log。
- 根据事件、应用程序或应用程序捆绑包的要求过滤事件列表，并选择显示当天、昨天、最后 7 天、最后 14 天（默认）或在最后 14 天内设置自定义范围的事件。
- 根据需要按升序或降序对日期和时间列进行排序。
- 如果应用程序捆绑包的用户没有如预期收到通知，您可以点 View notification settings 并更改设置和/或用户检查其用户首选项以接收电子邮件通知。
对红帽文档提供反馈
我们感谢您对我们文档的反馈。要提供反馈，请突出显示文档中的文本并添加注释。
先决条件
- 已登陆到红帽客户门户网站。
- 在红帽客户门户网站中，文档采用 Multi-page HTML 查看格式。
流程
要提供反馈，请执行以下步骤：
点击 文档 右上角的反馈按钮查看现有的反馈。
注意反馈功能仅在多页 HTML 格式中启用。
- 高亮标记您要提供反馈的文档中的部分。
点在高亮文本旁弹出的 Add Feedback。
文本框会出现在页面右侧的反馈部分中。
在文本框中输入您的反馈，然后点 Submit。
已创建一个文档问题。
- 要查看问题，请点击反馈视图中的问题链接。