Red Hat SummitQuesto contenuto non è disponibile nella lingua selezionata.
Chapter 1. Introduction to Red Hat Hybrid Cloud Console notifications
Through the notifications service, Red Hat Hybrid Cloud Console services have a standardized way of notifying users of events. By setting up behavior groups, a Notifications administrator specifies the notification delivery method and whether event notifications are sent to all users on an account, specific users, or only to Organization Administrators.
For example, the Notifications administrator can configure the service to send an email notification for new-recommendation hits on a system. Similarly, the Notifications administrator might decide to trigger a notification that sends a message to a third-party application using the webhook integration type.
An Organization Administrator designates Notifications administrators by creating a User Access group with the Notifications administrator role, then adding account members to the group. A Notifications administrator then configures notification behavior groups that define actions taken when service-specific events occur.
The notifications service transmits event-triggered notifications to users’ email accounts or to third-party applications using webhooks.
Users on the Hybrid Cloud Console account set their own preferences for receiving email notifications. In Settings > Notifications > Notification preferences, each user configures their personal settings to receive event notification emails as an instant notification or daily digest. Note that some services do not offer both instant notification and daily digest. For errata alerts, instant notifications are batched and sent out in 15-minute intervals.
Selecting Instant notification for any service can cause the recipient to receive a very large number of emails.
1.1. Hybrid Cloud Console notification service concepts
Review key concepts to understand how the notifications service works:
| Concept | Description |
|---|---|
| Actions | Operations are performed in response to an event, for example sending an email. Actions are defined in behavior groups that are configured by a Notifications administrator. |
| Application bundle | Application bundle refers to an application group within the Hybrid Cloud Console, such as Red Hat Enterprise Linux, OpenShift, or Subscription Services. |
| Behavior groups | Behavior groups determine what actions to take when an event occurs, and whether to notify all account users or only designated administrators. After a Notifications administrator creates a behavior group, they associate it with event types which enables Notifications administrators to apply the same actions to all application-specific events. NOTE: Notifications administrators configure notification behavior groups separately for each application bundle. |
| Email preferences | Individual users with access to applications on the Hybrid Cloud Console set their personal email preferences. Users can configure personal email notifications to arrive either instantly, as the event occurs, or consolidated into a daily digest that arrives at midnight, 00:00 Coordinated Universal Time (UTC), for all accounts. For errata alerts, instant notifications are batched and sent in 15-minute intervals. IMPORTANT: Selecting instant notification for any service can potentially result in the recipient receiving a very large number of emails. |
| Event type | Event types are application-specific system changes that trigger the application or service to initiate notification actions. Event types are created by application developers at Red Hat and are unique for each application bundle. |
| Notification | A message that a user receives from the notifications service as a result of a event occurring in the Hybrid Cloud Console. A notification can be delivered as an email, a message in a configured third-party tool, or in the Event Log in the console. |
| Integrations | Integrations define the method of delivery of notifications configured by the Notifications administrator. After integrations are configured, the notifications service sends the HTTP POST messages to endpoints. |
| Severity | Email notifications and notifications sent to third-party integrations show a severity level for most events. This allows you to easily determine the importance of the event and filter the notifications you receive by severity. Severity levels include Critical, Important, Moderate, Low, and None. See Section 1.2, “Notification severity” for details. |
| User access roles | The following User Access roles interact with notifications: * Organization Administrator * Notifications administrator * Notifications viewer |
1.2. Notification severity
Notifications sent to email or third-party applications are labeled with a severity level for most events. This allows you to easily determine the importance of the event and filter the notifications you receive by severity.
Notification severity levels include Critical, Important, Moderate, Low, and None, similar to the Red Hat security ratings described in Severity ratings. A notification labeled Critical has the highest impact and should be reviewed urgently, while a notification labeled Low is informative only.
The following table contains details about each severity level:
| Severity level | Description | Action | Examples |
|---|---|---|---|
| Critical | Urgent notification about an event with impact to your systems | Review and take action immediately | Subscription security updates and bug fixes (errata), Advisor recommendations, compliance below threshold |
| Important | Errors or other events that may impact your systems | Review and take action as needed | Compliance upload failures, failed RHEL tasks, successful Ansible on AWS provisioning |
| Moderate | Warning | Review and consider if action needs to be taken | Subscription utilization threshold exceeded, User Access default groups customized, Red Hat access request created, stale cost management data |
| Low | Information only | No action required | New User Access role available, integrations availability status change |
| None | Debug or informative updates | No action required | User-modified User Access groups and custom roles, stale RHEL inventory, RHEL tasks successfully completing |
1.3. Hybrid Cloud Console notifications methods
You can use the following methods to integrate the Hybrid Cloud Console into your organization’s workflows:
- Hybrid Cloud Console APIs
- Webhooks or emails, or both, directly to users
- Integrations with a third-party application, such as Splunk
1.3.1. Hybrid Cloud Console APIs
Hybrid Cloud Console APIs are publicly available and can be queried from any authenticated client (role-based access controlled).
- For more information about the available endpoints for applications and services, refer to the Hybrid Cloud Console API documentation.
- For an example of CSV-formatted API responses, see the System Comparison API Documentation.
- For examples to help you to get started quickly with authentication and with querying API endpoints, see Red Hat Lightspeed API cheat sheet.
1.3.2. Webhooks
Webhooks work in a similar way to APIs, except that they enable one-way data sharing when events trigger them. APIs share data in both directions.
Third-party applications can be configured to allow inbound data requests by exposing webhooks and using them to listen for incoming events. The Hybrid Cloud Console integrations service uses this functionality to send events and associated data from each service.
You can configure the Hybrid Cloud Console notifications service to send POST messages to those third-party application webhook endpoints. For example, you can configure the Hybrid Cloud Console to automatically forward events triggered when a new Advisor recommendation is found. The event and its data are sent as an HTTP POST message to the third-party application on its incoming webhook endpoint.
After you configure the endpoints in the notifications service, you can subscribe to a stream of Hybrid Cloud Console events and automatically forward that stream to the webhooks of your choice. Each event contains additional metadata, which you can use to process the event, for example, to perform specific actions or trigger responses, as part of your operational workflow. You configure the implementation and data handling within your application.
For more information about how to configure and use webhooks, refer to Configure integrations.
1.3.3. Third-party application integrations
You can use Hybrid Cloud Console third-party application integrations in two ways, depending on your use case:
- Use Hybrid Cloud Console APIs to collect data and perform tasks.
- Subscribe to streams of Hybrid Cloud Console events.
You can use Hybrid Cloud Console integrations to forward events to specific third-party applications. The Red Hat Lightspeed application for Splunk forwards selected Hybrid Cloud Console events to Splunk. This allows you to view and use data from Hybrid Cloud Console in your existing workflows from the Red Hat Lightspeed application for Splunk dashboard.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}