在 Red Hat Hybrid Cloud Console 中配置通知
配置混合云控制台设置,以便帐户用户接收事件触发的通知
摘要
前言
使用 Red Hat Hybrid Cloud Console 上的通知服务,以便您不必检查您的用户界面是否有事件触发的通知。相反,当发生事件时,服务会自动向您发送有关事件的通知。
组和角色(包括通知管理员角色)必须由机构管理员配置,以便通过电子邮件和集成报告事件。
第 1 章 Red Hat Hybrid Cloud Console 通知和集成简介
通过通知服务,Red Hat Hybrid Cloud Console 服务具有通知用户事件的标准化方法。通过设置行为组,通知管理员指定通知交付方法,以及事件通知是否发送到帐户、特定用户还是仅向机构管理员发送。
例如,通知管理员可以配置服务,以向系统上的新建议点击发送电子邮件通知。同样,Notifications 管理员可以决定触发使用 webhook 集成类型向第三方应用程序发送消息的通知。
机构管理员通过创建一个具有通知管理员角色的 User Access 组来指定通知管理员,然后将帐户成员添加到组中。然后,通知管理员配置通知行为组,以定义发生特定于服务的事件时执行的操作。
通知服务使用 webhook 将事件触发的通知传输到用户的电子邮件通知或第三方应用程序。Hybrid Cloud Console 帐户上的用户设置自己的首选项,以接收电子邮件通知。在 Settings > Notifications > Notification preferences 中,每个用户都将其个人设置配置为接收事件通知电子邮件作为即时通知或每日摘要。
为 任何服务选择 Instant 通知 可能会导致接收者接收大量电子邮件。
1.1. 混合云控制台通知和集成概念
查看关键概念以了解通知服务如何工作:
概念 | 描述 |
---|---|
Actions | 执行操作以响应事件。示例包括发送电子邮件或将通知转发到集成端点。操作在由通知管理员配置的行为组中定义。 |
应用程序捆绑包 | 应用程序捆绑包指的是混合云控制台(如 Red Hat Enterprise Linux 或 OpenShift)中的应用程序组。 |
行为组 | 行为组决定发生事件时要采取哪些操作,以及是否通知所有帐户用户还是仅指定管理员。在通知管理员创建行为组后,它们将与事件类型关联,以便通知管理员将相同的操作应用到所有特定于应用程序的事件。 注意: 通知管理员为每个应用程序捆绑包单独配置通知行为组。 |
电子邮件首选项 | 有权访问混合云控制台上的应用程序的个人用户设置其个人电子邮件首选项。用户可以配置个人电子邮件通知,以便立即到达事件发生,或合并为所有帐户达到午夜 00:00 Coordinated Universal Time (UTC)的每日摘要。 重要信息: 选择任何服务的即时通知可能会导致接收者收到大量电子邮件。 |
事件类型 | 事件类型是特定于应用程序的系统更改,用于触发应用程序或服务来启动通知操作。事件类型由红帽应用程序开发人员创建,每个应用程序捆绑包都是唯一的。 |
集成 | 集成定义了发送由通知管理员配置的通知的方法。配置了集成后,通知服务会将 HTTP POST 消息发送到端点。 |
用户访问角色 | 以下用户访问角色与通知进行交互: * 机构管理员 * 通知管理员 * 通知查看器 |
1.2. 混合云控制台通知方法
您可以使用以下方法将混合云控制台集成到机构的工作流中:
- 混合云控制台 API
- Webhook 或电子邮件,或直接向用户
- 与第三方应用程序集成,如 Splunk
混合云控制台 API
混合云控制台 API 已公开可用,可以从任何经过身份验证的客户端(控制基于角色的访问控制)查询。
Webhook
Webhook 的工作方式类似于 API,但它们在事件触发时启用单向数据共享。API 在两个方向上共享数据。
第三方应用程序可以配置为通过公开 Webhook 并使用它们侦听传入的事件来允许入站数据请求。混合云控制台集成服务使用此功能从每个服务发送事件和相关数据。
您可以配置 Hybrid Cloud Console 通知服务,将 POST 消息发送到这些第三方应用程序 Webhook 端点。例如,您可以将 Hybrid Cloud Console 配置为在找到新 Advisor 建议时自动转发触发的事件。事件及其数据作为 HTTP POST 消息发送到其传入 Webhook 端点上的第三方应用程序。
在通知服务中配置端点后,您可以订阅到混合云控制台事件的流,并自动将该流转发到您选择的 webhook。每个事件都包含额外的元数据,可用于处理事件,例如,执行特定操作或触发响应,作为操作工作流的一部分。您可以在应用程序中配置实施和数据处理。
第三方应用程序集成
您可以通过两种方式使用混合云控制台第三方应用程序集成,具体取决于您的用例:
- 使用混合云控制台 API 收集数据并执行任务。
- 订阅混合云控制台事件的流。
您可以使用混合云控制台集成将事件转发到特定的第三方应用程序。用于 Splunk 的 Red Hat Insights 应用程序将所选混合云控制台事件转发到 Splunk。这可让您在 Red Hat Insights 应用程序用于 Splunk 仪表板的现有工作流中查看和使用混合云控制台中的数据。
其他资源
- 有关应用程序和服务的可用端点的更多信息,请参阅 混合云控制台 API 文档。
- 有关 CSV 格式的 API 响应示例,请参阅 系统比较 API 文档。
- 有关帮助您快速验证和查询 API 端点的示例,请参阅 Red Hat Insights API cheat 表格。
- 有关如何配置和使用 Webhook 的更多信息,请参阅配置 集成。
- 有关安全性的详情,请查看 Red Hat Insights 数据和应用程序安全性。
- 有关集成第三方应用程序的更多信息 ,请参阅将红帽混合云控制台与第三方应用程序集成。
第 2 章 配置用户访问权限以管理通知
要配置通知和集成设置,您必须是具有 Notifications 管理员角色的组的成员。这个组必须由机构管理员在 User Access 中配置。在 Red Hat Hybrid Cloud Console > Settings > Identity & Access Management > User Access > Groups 中,机构管理员执行以下高级别步骤:
- 为通知管理员创建一个 User Access 组。
- 将 Notifications 管理员角色添加到组中。
- 向组添加成员(具有帐户访问权限的用户)。
Organization Administrator(机构管理员)
机构管理员为通知管理员配置 User Access 组,然后将通知管理员角色和用户添加到组中。
通知管理员
通知管理员配置服务与通知的交互方式。通知管理员配置行为组,以定义服务如何通知用户有关事件。管理员可以配置其他集成使其可用,以及编辑、禁用和删除现有集成。
通知查看器
通知查看器角色会自动授予帐户中的每个人,并限制用户如何与通知服务视图和配置进行交互。查看器可以查看通知配置,但不能修改或删除它们。查看器还无法配置、修改或删除集成。
其他资源
- 要了解更多有关用户在 Red Hat Hybrid Cloud Console 上访问的信息,请参阅 基于角色的访问控制(RBAC)的用户访问指南。
2.1. 在混合云控制台中创建和配置通知组
Hybrid Cloud Console 帐户的机构管理员创建具有 Notifications 管理员角色的组,并将成员添加到组中。
先决条件
- 以机构管理员身份登录到 Red Hat Hybrid Cloud Console。
流程
- 点 Settings > Identity & Access Management。
- 在 Identity & Access Management 下,根据需要展开 User Access,然后选择 Groups。
- 点 Create group。
- 输入组名称,例如 通知管理员 和描述,然后单击 Next。
- 选择要添加到此组的角色,本例中为 通知管理员。点该角色的复选框并点 Next。
- 将成员添加到组中。搜索单个用户或按用户名、电子邮件或状态过滤。选中每个预期成员名称旁边的框,然后单击 Next。
- 查看详细信息以确保一切正确。如果需要返回并更改内容,请单击 Back。
- 点 Submit 以完成组的创建。
2.2. 编辑或删除用户访问组
您可以在 Red Hat Hybrid Cloud Console 中对现有 User Access 组进行更改,您可以删除不再需要的组。
先决条件
- 以具有机构管理员权限的用户身份登录到 Red Hat Hybrid Cloud Console。
- 如果您不是机构管理员,则必须是分配了 User Access 管理员角色 的组的成员。
流程
- 在 Red Hat Hybrid Cloud Console > Settings > Identity & Access Management > User Access > Groups 中找到组名称。
- 点击组名称行最右侧的选项图标(HBAC),然后点 Edit 或 Delete。
- 进行并保存更改或删除组。
第 3 章 配置集成
Red Hat Hybrid Cloud Console 通知和集成服务协同工作,在触发事件时将消息传送到第三方应用程序端点,如即时消息平台和外部票据系统。
通知管理员可以使用这些服务将混合云控制台功能集成到其机构中所使用的操作工作流中。集成由 Notifications 管理员在 Red Hat Hybrid Cloud Console > Settings > Integrations 页面中配置。
有关配置集成的更多信息 ,请参阅将红帽混合云控制台与第三方应用程序集成。
Webhook 是 Red Hat Hybrid Cloud Console 中支持的当前集成类型。配置后,服务会将 HTTP POST 消息发送到指定的第三方应用端点。
3.1. 混合云控制台 HTTP POST 信息
以下屏幕截图是从 Hybrid Cloud Console 发送到第三方应用程序端点的 HTTP POST 消息示例。事件类型特定于服务或应用程序。例如,Insights for RHEL 应用程序捆绑包目前通知配置的用户来自策略、公告和偏移服务的事件。以下来自 Insights for RHEL 公告服务的通知示例是由主机系统上的新建议触发的。
在示例中,块包含以下信息:
有关捆绑包和应用程序发送通知的信息:
-
捆绑包
:应用程序捆绑包的名称 -
Application : 发送事件触发通知的单个应用程序或服务的名称
-
event_type
:触发通知的事件类型 -
ACCOUNT_
ID :发送通知的红帽帐户 -
时间戳
:在发送通知时显示 ISO-8601 格式的日期
-
有关应用程序或特定于服务的事件的信息:
-
有效负载
:应用程序有效负载,一个包含应用程序发送的所有数据的 JSON 字符串
-
有关发生事件的系统的信息。例如:
-
inventory_id
: 系统 ID -
主机名
:系统名称 -
rhel_VERSION
: 在系统中运行的 RHEL 版本
-
目前没有使用 metadata 字段。
3.2. 在混合云控制台中创建和配置集成
通知管理员为机构创建和配置集成,以便第三方应用程序可以向用户发送事件通知。
先决条件
- 以机构管理员或具有通知管理员权限的用户身份登录到 Red Hat Hybrid Cloud Console。
流程
- 在 Hybrid Cloud Console 中,进入到 Settings > Integrations。
- 点 Integrations 选项卡。
- 选择您要创建的集成类型的选项卡。例如,要创建一个 Slack 集成,请选择 Communications 选项卡。
点 Add integration 并选择第三方工具,以与 Hybrid Cloud Console 集成:
- 选择集成类型。
- 输入集成名称。
- 提供端点 URL。
确认选择了启用 SSL 验证的复选框。
重要SSL 对于保护发送到集成端点的数据至关重要。在将红帽混合云控制台与第三方应用程序时,应始终使用 SSL。
可选:根据需要提供 secret 令牌。如果定义,secret 令牌将用作 POST HTTP 请求的 'X-Insight-Token' 标头。
注意secret 令牌对于保护发送到集成端点的数据至关重要,在将 Hybrid Cloud Console 与第三方应用程序集成时应始终使用。
- 点击 Save。
- 要验证新的集成是否在 Integrations 页面中列出,请在 Filter by Name 框中输入集成名称。
当通知管理员在通知管理员在通知服务中配置行为组时,新的集成会被默认启用,并作为集成选项使用。要禁用集成,请在 Enabled 列中切换开关。要配置行为组,请参阅配置混合云控制台通知行为组。
3.3. 编辑、删除、或删除集成
通知管理员可以编辑、删除或禁用 Integrations 页面中列出的任何混合云控制台集成。
先决条件
- 以机构管理员或通知管理员身份登录到 Red Hat Hybrid Cloud Console。
- 您已在 Red Hat Hybrid Cloud Console 中配置了集成。
流程
- 在 Hybrid Cloud Console 中,进入到 Settings > Integrations。
- 点 Integrations 选项卡。
- 点击集成名称行最右侧的选项图标(HBAC),然后点 Edit,Delete, 或 Disable。
- 进行并保存更改、删除或禁用集成。
第 4 章 配置混合云控制台通知行为组
通知管理员通过行为组配置帐户的通知。当通知服务收到特定事件时,行为组定义哪些通知将发送到外部服务,如 Microsoft 团队。通知管理员可以将来自任何红帽混合云控制台服务的事件链接到行为组。
创建行为组后,通知管理员将其与触发事件相关联,这些事件对每个应用程序捆绑包是唯一的。
发生事件时,用户首选项中选择以接收通知的帐户上的所有用户都将接收通知,以及作为行为组中的集成操作指定的所有第三方应用程序。
4.1. 创建行为组
使用 Create behavior group 向导在 Hybrid Cloud Console 中创建新行为组。向导允许您选择通知,将通知分配给用户或组,并将 Hybrid Cloud Console 事件与行为组关联。
您可以将事件与多个行为组关联。如果行为组没有与任何事件关联,则发生事件时不会发送通知。
您可以在机构中创建最多 64 个行为组。
如果您的组织配置了清单组以控制用户对系统的访问,请检查您的通知配置,以确保仅配置适当的用户组来接收通知。如果您没有查看通知配置,用户可能会收到其清单组权限范围之外的系统触发的警报。有关配置 清单组的更多信息,请参阅查看和管理系统 清单。
先决条件
- 机构管理员配置了通知组、角色和成员。
- 以通知管理员身份登录到 Hybrid Cloud Console。
流程
- 在 Hybrid Cloud Console 中,进入到 Settings > Notifications。
- 在 通知 下,选择 Configure Events。
- 选择您要为其配置事件通知行为的应用程序捆绑包选项卡: Red Hat Enterprise Linux、Console 或 OpenShift。
- 点 Behavior Groups 选项卡。
点 Create new group 打开 Create behavior group 向导。
- 输入组名称,然后单击 Next。Actions 和 recipients 页面将打开。
在 Actions 下拉列表中,选择 Send a email,或者从列表中选择一个集成:
- 如果您选择了 Send a email,请从 Recipient 下拉列表中选择一个接收者。您可以指定电子邮件通知进入机构中的所有用户,或者您可以将接收者限制为机构的管理员。如果配置了 User Access 组,您可以选择 User Access 组来接收电子邮件通知。
如果您选择了一个集成,如 Integration: Slack,Integration: Splunk, 或 Integration: Webhook,请从 Recipient 下拉列表中选择集成端点(例如 SPLUNK_AUTOMATION)。
注意在 Settings > Integrations 中为每个集成配置端点。如果某个操作被禁用,则没有该事件类型的集成。
- 可选: 要添加额外的操作来通知其他集成端点,请点 Add action。
完成添加操作后,单击 Next。此时会打开 Associate 事件类型 页面。
选择您要包含在通知中的事件类型,然后点 Next。Review 页面将打开。
- 查看您为行为组选择的设置。要修改设置,请单击 Back。要保存设置并创建行为组,请点 Finish。
其他资源
- 有关如何创建用户访问组的更多信息,请参阅使用角色和成员管理访问权限。
- 有关清单组的更多信息,请参阅 查看和管理系统清单。
4.2. 修改行为组
使用 Edit behavior group 向导修改现有行为组的设置。您可以使用向导来选择通知,将通知分配给用户或组,并将 Hybrid Cloud Console 事件与行为组关联。
事件可以与多个行为组关联。如果行为组没有与事件关联,则发生事件时不会发送通知。
先决条件
- 机构管理员配置了通知组、角色和成员。
- 使用通知管理员权限登录到 Hybrid Cloud Console。
流程
- 在 Hybrid Cloud Console 中,进入到 Settings > Notifications。
- 在 通知 下,选择 Configure Events。
- 选择您要修改事件通知行为的应用程序捆绑包选项卡: Red Hat Enterprise Linux、Console 或 OpenShift。
- 单击 Behavior Groups 选项卡,以显示可用的行为组。
点击您要修改的行为组中的更多选项图标
并点 Edit。这会打开 Edit behavior group 向导。
- 输入组名称,然后单击 Next。Actions 和 recipients 页面将打开。
在 Actions 下拉列表中,选择 Send a email,或者从列表中选择一个集成:
- 如果您选择了 Send a email,请从 Recipient 下拉列表中选择一个接收者。您可以指定电子邮件通知进入机构中的所有用户,或者您可以将接收者限制为机构的管理员。如果配置了 User Access 组,您可以选择 User Access 组来接收电子邮件通知。
如果您选择了集成,如 Integration: Webhook 或 Integration: Splunk,请从 Recipient 下拉列表中选择集成端点(如 SPLUNK_AUTOMATION)。
注意在 Settings > Integrations 中为每个集成配置端点。如果某个操作被禁用,则没有该事件类型的集成。
- 可选: 要添加额外的操作来通知其他集成端点,请点 Add action。
完成添加操作后,单击 Next。此时会打开 Associate 事件类型 页面。
选择您要包含在通知中的事件类型,然后点 Next。Review 页面将打开。
- 查看您为行为组选择的设置。要继续修改设置,请单击 Back。要保存行为组的设置,请点 Finish。
第 5 章 为电子邮件通知配置用户首选项
Red Hat Hybrid Cloud Console 中的每个用户都必须选择接收有关事件的电子邮件通知电子邮件。您可以选择要接收通知的服务以及频率。
如果您为 任何服务选择 Instant 通知,您可能会收到大量电子邮件。
先决条件
- 登录到 Red Hat Hybrid Cloud 控制台。
- 您已在控制台中配置了相关事件。
- 通知管理员或机构管理员已配置了行为组来接收事件通知。
流程
- 在 Hybrid Cloud Console 中,进入到 Settings > Notifications > Notification Preferences。在 My Notifications 页面中,可用的服务按类别分组,如 OpenShift 或 Red Hat Enterprise Linux。
- 选择您要为通知配置服务,如 Advisor 或 User Access。此时会打开所选服务的可用事件通知列表。
在列表的顶部,点 Select all 启用该服务的所有通知,或者为每个列出的每个事件选择以下选项之一:
注意所有选项都不可用于所有服务。
- 每日摘要 : 接收一个触发的应用程序事件的每日摘要,这些事件在 24 小时时间内发生。
即时通知 :为每个触发的应用程序事件立即接收电子邮件。
重要如果您为 任何服务选择 Instant 通知,您可能会收到大量电子邮件。
- 每周报告 :接收包含 Advisor Weekly Report 的电子邮件。
- 更新您的信息,然后单击保存。电子邮件通知采用您选择的格式和频率发送。如果为集成的第三方应用程序配置了通知,通知也会发送到这些应用程序。
如果您决定停止接收通知,请选择 Deselect all,或取消选中您不想被通知的事件框,然后单击 Save。除非返回此屏幕并再次启用,否则您将不再收到任何电子邮件通知。
5.1. 自定义每日电子邮件通知时间
您可以选择在每天摘要电子邮件中接收 Red Hat Hybrid Cloud Console 服务中发生的触发应用程序事件的摘要,而不是在事件发生时获得通知。
默认情况下,每日摘要在 00:00 Coordinated Universal Time (UTC)发送。
机构管理员和通知管理员可以自定义发送每日摘要的时间。每日摘要从通知设置中指定的时间开始,提供在 24 小时时间段内发生的事件快照。
先决条件
- 以机构管理员或具有通知管理员权限的用户身份登录到 Hybrid Cloud Console。
流程
- 在 Hybrid Cloud Console 中,进入到 Settings > Notifications > Notification Preferences。
- 在 My Notifications 页面上,单击 Edit time settings。
- 选择 Custom time,然后指定要发送您帐户的每日摘要电子邮件的时间和时区。
点击 Save。
注意保存新时间后,混合云控制台会将新时间转换为 UTC 时区。
每日摘要电子邮件在您选择的时间每天发送。
5.2. 更新通知的电子邮件地址
通知服务将电子邮件通知发送到您的红帽帐户中列出的电子邮件地址。
您可以使用此流程中的步骤更新您的电子邮件地址。
先决条件
- 已登陆到 Hybrid Cloud Console。
流程
- 点 Red Hat Hybrid Cloud Console 窗口右上角的用户 avatar。此时会出现一个下拉列表。
- 单击 My profile。
- 在 个人信息 下,点您的电子邮件地址旁边的 Change 链接。这将打开红帽帐户管理应用程序。
在 Email address 字段中,输入您的新电子邮件地址,然后单击 Save。红帽向您的新电子邮件地址发送验证。
重要您必须在一天内验证您的新电子邮件地址才能保存更改。
- 在您的电子邮件帐户中打开来自红帽的验证 电子邮件,然后单击 Link to email- address 验证。这会确认您的电子邮件地址,并返回到红帽帐户管理应用程序。
您的新电子邮件地址保存在您的红帽帐户中。如果更改没有立即显示在 My 配置集中,请注销所有红帽应用程序并重新登录以查看您更新的帐户。
其他资源
- 有关更新红帽帐户详情的更多信息,请参阅 Red Hat Hybrid Cloud Console 入门 中的"更新您的红帽帐户信息"。
第 6 章 对事件日志和集成设置的通知失败进行故障排除
通知服务事件日志可让管理员查看通知无法正常工作。事件日志提供了 Red Hat Hybrid Cloud Console 帐户上所有触发的事件列表,以及过去 14 天所采取的操作(如相关行为组中的配置)。
在 Action taken 列中,每个事件都以绿色或红色显示集成类型,以指示消息传输的状态。filterable 事件日志是一个有用的故障排除工具,可用于查看失败的通知事件,并确定端点的潜在问题。在事件日志中看到失败的操作后,Notifications 管理员可以检查端点,并在 Integrations 屏幕中查看最后五个连接尝试的状态。
在集成服务中,以下连接状态按颜色反映:
- 绿色 : 以前的传输成功。
- 红帽: 之前的传输失败(超时、404 错误等)。
- 黄色: 连接已降级;前五个传输中至少两个失败。
- Unknown : 集成还没有被调用,或者没有与行为组关联。
事件日志可以回答与接收电子邮件相关的问题。通过将事件的电子邮件操作显示为绿色,事件日志可让通知管理员确认电子邮件已成功发送。
即使正确配置了通知和集成,在 Hybrid Cloud Console 帐户上的单个用户都必须配置其用户首选项来接收电子邮件。
在用户使用 webhook 集成类型接收通知前,通知管理员必须为您的机构的首选 webhook 应用程序配置端点。
先决条件
- 以具有通知管理员或机构管理员权限的用户身份登录到 Hybrid Cloud Console。
流程
在 Hybrid Cloud Console 中,进入到 Settings > Notifications > Event Log。
- 根据事件、应用程序、应用程序捆绑包、操作类型或操作状态过滤事件列表。
- 选择显示当天、是天、最后 7 天、最后 14 天(默认)或在最后 14 天内设置自定义范围的时间帧。
- 以升序或降序对 Date 和 time 列进行排序。
- 导航到 Settings > Notifications > Configure Events,并按照 event 验证或更改设置。
- 要求用户检查其用户首选项以接收电子邮件通知。即使正确配置了通知和集成,在混合云控制台帐户中的每一用户都必须配置自己的用户首选项来接收电子邮件。
其他资源
- 有关网络和防火墙配置的更多信息,请参阅 用于访问 Red Hat Insights / Hybrid Cloud Console Integrations 和 Notifications 的防火墙配置。
- 要为接收通知配置个人首选项,请参阅为电子邮件通知配置用户首选项。
对红帽文档提供反馈
我们感谢您对我们文档的反馈。尽可能提供详细信息,以便可以解决您的请求。
先决条件
- 您有红帽帐户。
- 您已登录到您的红帽帐户。
流程
- 要提供反馈,请点击以下链接: Create Issue
- 在 Summary 文本框中描述问题或功能增强。
- 在 Description 文本框中提供有关问题或功能增强的更多详细信息。
- 如果您的红帽用户名没有自动显示在 Reporter 文本框中,请输入它。
- 滚动到页面底部,然后单击 Create 按钮。创建文档问题并路由到适当的文档团队。
感谢您花时间来提供反馈。