Configuring notifications on the Red Hat Hybrid Cloud Console

Red Hat Hybrid Cloud Console 1-latest

Configuring Hybrid Cloud Console settings so that account users receive event-triggered notifications

Red Hat Customer Content Services

Abstract

Use notifications to learn about identified events that have occurred and might impact your organization.

Preface
Copy link

Use the notifications service on the Red Hat Hybrid Cloud Console so that you do not have to check your user interface for event-triggered notifications. Instead, when events occur, the service automatically sends notifications about the events to you.

Important

Groups and roles, including the Notifications administrator role, must be configured by an Organization Administrator in order for events to be reported through email and integrations.

Chapter 1. Introduction to Red Hat Hybrid Cloud Console notifications
Copy link

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.

Important

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
Copy link

Review key concepts to understand how the notifications service works:

Expand

Table 1.1. Notifications concepts
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
Copy link

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:

Expand

Table 1.2. Severity levels for console notifications
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
Copy link

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
Copy link

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
Copy link

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
Copy link

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.

Chapter 2. Configure User Access to manage notifications
Copy link

To configure notifications settings, you must be a member of a group with the Notifications administrator role. This group must be configured in User Access by an Organization Administrator. In the Red Hat Hybrid Cloud Console > Settings > Identity & Access Management > User Access > Groups, an Organization Administrator performs the following high-level steps:

Create a User Access group for Notifications administrators.
Add the Notifications administrator role to the group.
Add members (users with account access) to the group.
Organization Administrator
The Organization Administrator configures the User Access group for Notifications administrators, then adds the Notifications administrator role and users to the group.
Notifications administrator
Notifications administrators configure how services interact with notifications. Notifications administrators configure behavior groups to define how services notify users about events. Administrators can configure additional integrations as they become available, as well as edit, disable, and remove existing integrations.
Notifications viewer
The Notifications viewer role is automatically granted to everyone on the account and limits how a user can interact with notifications service views and configurations. A viewer can view notification configurations, but cannot modify or remove them. A viewer cannot configure, modify, or remove integrations.

2.1. Creating and configuring a notifications group in the Hybrid Cloud Console
Copy link

An Organization Administrator of a Hybrid Cloud Console account creates a group with the Notifications administrator role and adds members to the group.

Prerequisites

You are logged in to the Red Hat Hybrid Cloud Console as an Organization Administrator.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.

Procedure

Click Settings.
Under Identity & Access Management, click User Access.
In the left navigation panel, expand User Access if necessary and then click Groups.
Click Create group.
Enter a group name, for example, Notifications administrators, and a description, and then click Next.
Select the role to add to this group, in this case Notifications administrator, and then click Next.
Add members to the group:
1. Search for individual users or filter by username, email, or status.
2. Check the box next to each intended member’s name, and then click Next.
On the Review details screen, click Submit to finish creating the group.

2.2. Editing or removing a User Access group
Copy link

You can make changes to an existing User Access group in the Red Hat Hybrid Cloud Console and you can delete groups that are no longer needed.

Prerequisites

You are logged in to the Red Hat Hybrid Cloud Console and meet one of the following criteria:
- You are a user with Organization Administrator permissions.
- You are a member of a group that has the User Access administrator role assigned to it.
  Note
  You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.

Procedure

Navigate to Red Hat Hybrid Cloud Console > Settings > Identity & Access Management > User Access > Groups.
Click the options icon (⋮) on the far right of the group name row, and then click Edit or Delete.
Make and save changes or delete the group.

Chapter 3. Configuring integrations
Copy link

The Red Hat Hybrid Cloud Console notifications and integrations services work together to transmit messages to third-party application endpoints, such as instant messaging platforms and external ticketing systems, when triggering events occur.

Notifications administrators can use these services to integrate Hybrid Cloud Console functionality into the operational workflow used in their organization. Integrations are configured by a Notifications administrator as endpoints on the Hybrid Cloud Console Settings > Integrations page.

For more information about configuring integrations, see Integrating the Red Hat Hybrid Cloud Console with third-party applications.

Note

Webhook is the current integration type supported in the Red Hat Hybrid Cloud Console. When configured, the service sends an HTTP POST message to the specified third-party application endpoint.

3.1. Hybrid Cloud Console HTTP POST messages
Copy link

The following screenshot is an example of an HTTP POST message sent to a third-party application endpoint from the Hybrid Cloud Console. Event types are specific to a service or application. For example, the Red Hat Lightspeed application bundle currently notifies configured users of events from the policies, advisor, and drift services. The following example notification from the Red Hat Lightspeed advisor service was triggered by a new recommendation on a host system.

img hcc notif schema

In the example, the blocks contain the following information:

Information about the bundle and application sending the notification:
- bundle: Name of the application bundle
- application: Name of the individual application or service sending the event-triggered notification
- event_type: The event type that triggered the notification
- account_id: The Red Hat account from which the notification was sent
- timestamp: ISO-8601 formatted date showing when the notification was sent
Information about the application or service-specific event:
- payload: The application payload, a JSON string containing all the data sent by the application
Information about the system on which the event occurred. For example:
- inventory_id: System ID
- hostname: System name
- rhel_version: RHEL version running on the system

The metadata field is not currently used.

3.2. Creating and configuring integrations in the Hybrid Cloud Console
Copy link

The Notifications administrator creates and configures integrations for the organization so third-party applications can send event notifications to users.

Prerequisites

You are logged into the Red Hat Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
Your endpoint must be protected by a non-self-signed and globally trusted certificate.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Integrations.
Click the Integrations tab.
Select the tab for the type of integration you want to create. For example, to create a Slack integration, select the Communications tab.
Click Add integration and select the third-party tool to integrate with the Hybrid Cloud Console:
1. Select an integration type.
2. Enter an integration name.
3. Provide the endpoint URL.
  Important
  SSL is essential for protecting the data sent to the integration endpoint. SSL must always be used when integrating the Red Hat Hybrid Cloud Console with third-party applications.
4. Optional: Provide a secret token, if required. If defined, the secret token is used as an X-Insight-Token header on the POST HTTP request.
  Note
  A secret token is essential for protecting the data sent to the integration endpoint and should always be used when integrating the Hybrid Cloud Console with third-party applications.
5. Click Save.
To verify that the new integration is listed on the Integrations page, enter the integration name in Filter by Name box.
Note
The new integration is enabled by default and available as an integration option when a Notifications administrator configures behavior groups in the notifications service. To disable the integration, toggle the switch in the Enabled column. To configure a behavior group, see Configuring Hybrid Cloud Console notification behavior groups.

3.3. Editing, deleting,or removing integrations
Copy link

The Notifications administrator can edit, remove, or disable any Hybrid Cloud Console integration listed on the Integrations page.

Prerequisites

You are logged in to the Red Hat Hybrid Cloud Console as an Organization Administrator or a Notifications administrator.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.
You have configured an integration in the Red Hat Hybrid Cloud Console.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Integrations.
Click the Integrations tab.
Click the options icon (⋮) on the far right of the integration name row, and then click Edit, Delete, or Disable.
Make and save changes, delete, or disable the integration.

Chapter 4. Configuring Hybrid Cloud Console notification behavior groups
Copy link

The Notifications administrator configures notifications for the account through behavior groups. A behavior group defines which notifications will be sent to external services such as Microsoft Teams when a specific event is received by the notifications service. The Notifications administrator can link events from any Red Hat Hybrid Cloud Console service to a behavior group.

After creating a behavior group, the Notifications administrator associates it with triggering events, which are unique to each application bundle.

When an event occurs, all users on the account who selected in their user preferences to receive notifications will receive the notification of the event, as well as all third-party applications specified as integration actions in the behavior group.

Note

Notifications for Red Hat Lightspeed services are triggered based on service-specific criteria. For more details about Red Hat Lightspeed events, see Understanding Red Hat Lightspeed (Insights) Events and Notifications in the Hybrid Cloud Console.

4.1. Creating a behavior group
Copy link

Use the Create behavior group wizard to create a new behavior group in the Hybrid Cloud Console. The wizard enables you to select notifications, assign notifications to users or groups of users, and associate Hybrid Cloud Console events with behavior groups.

Note

You can associate events with multiple behavior groups. If a behavior group is not associated with any event, no notifications are sent when an event occurs.

You can create a maximum of 64 behavior groups within an organization.

Important

If your organization has configured Inventory groups to control user access to systems, review your notifications configuration to ensure that only appropriate groups of users are configured to receive notifications. If you do not review your notifications configuration, users might receive alerts triggered by systems outside of their Inventory group permission scope. See Viewing and managing system inventory for more information about configuring inventory groups.

Prerequisites

An Organization Administrator has configured notification groups, roles, and members.
You are logged in to the Hybrid Cloud Console as a Notifications administrator.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Notifications.
Under Notifications, select Configure Events.
Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, OpenShift, or Subscription Services.
Click the Behavior Groups tab.
Click Create new group to open the Create behavior group wizard.
Enter a group name, and then click Next. The Actions and recipients page opens.
From the Actions drop-down list, select Send an email, or select an integration from the list:
- If you selected Send an email, select a recipient from the Recipient drop-down list. You can specify that the email notification go to all users in the organization, or you can limit the recipients to administrators in the organization. If User Access groups are configured, you can select a User Access group to receive email notifications.
- If you selected an integration such as Integration: Slack, Integration: Splunk, or Integration: Webhook, select an integration endpoint from the Recipient drop-down list (for example, SPLUNK_AUTOMATION).
  Note
  Configure endpoints for each integration in Settings > Integrations. If an action is disabled, no integrations exist for that event type.
Optional: To add additional actions to notify additional integration endpoints, click Add action.
When you have finished adding actions, click Next. The Associate event types page opens.
Select the types of events that you want to include in your notifications, and then click Next. The Review page opens.
Review the settings you selected for the behavior group. To modify the settings, click Back. To save the settings and create the behavior group, click Finish.

Additional resources

4.2. Modifying a behavior group
Copy link

Use the Edit behavior group wizard to modify settings for an existing behavior group. You can use the wizard to select notifications, assign notifications to users or groups of users, and associate Hybrid Cloud Console events with behavior groups.

Note

Events can be associated with multiple behavior groups. If a behavior group is not associated with an event, no notifications are sent when an event occurs.

Prerequisites

An Organization Administrator has configured notification groups, roles, and members.
You are logged into the Hybrid Cloud Console with Notifications administrator privileges.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Notifications.
Under Notifications, select Configure Events.
Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, OpenShift, or Subscription Services.
Select the Behavior Groups tab.
Click the more options icon on the behavior group you want to modify and click Edit. The Edit behavior group wizard opens.
On the Review screen, click Finish to save your changes.

Chapter 5. Configuring user preferences for email notifications
Copy link

Each user in the Red Hat Hybrid Cloud Console must opt in to receive email notifications emails about events. You can select the services from which to receive notifications as well as the frequency.

Important

If you select Instant notification for any service, you might receive a very large number of emails.

Prerequisites

You are logged in to the Red Hat Hybrid Cloud Console.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.
You have configured relevant events in the console.
A Notifications administrator or Organization Administrator has configured behavior groups to receive event notifications.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Notifications > Notification Preferences. The My Notifications page appears. On the My Notifications page, the available services are grouped by category, for example OpenShift or Red Hat Enterprise Linux.
Select the service you want to configure your notifications for, for example, Advisor or Inventory. A list of the available event notifications for the selected service opens.
At the top of the list, click Select all to enable all notifications for the service, or select one of the following options for each event listed:
Note
You cannot disable OpenShift notifications on this page because your cluster is managed by Red Hat. These notifications are the primary way that Red Hat Site Reliability Engineering (SRE) will contact you to inform you about cluster problems and request actions you must take to resolve them. Cluster owners cannot unsubscribe from email notifications. If you are not a cluster owner and you do not want to receive notification emails, you can ask your cluster owner or administrator to remove you from the list of cluster notification contacts as described in Removing notification contacts from your cluster.
- Daily digest: Receive a daily summary of triggered application events that occur in a 24 hour time frame.
- Instant notification: Receive an email immediately for each triggered application event. For errata alerts, instant notifications are batched and sent in 15-minute intervals.
  Important
  Some services do not offer both instant notification and daily digest. If you select Instant notification for any service, you might receive a very large number of emails.
- Weekly report: Receive an email that contains the Advisor Weekly Report.
Update your information and then click Save. Email notifications are delivered in the format and frequency that you selected. If notifications are configured for integrated third-party applications, the notifications are sent to those applications as well.
Note
If you decide to stop receiving notifications, select Deselect all or uncheck the boxes for the events you do not want to be notified about, and then click Save. You will no longer receive any email notifications unless you return to this screen and enable them once again.

5.1. Customizing the daily digest email notification time
Copy link

You can choose to receive a summary of triggered application events occurring in your Red Hat Hybrid Cloud Console services in a daily digest email, instead of being notified as events occur.

By default, the daily digest is sent at 00:00 Coordinated Universal Time (UTC).

Organization Administrators and Notifications administrators can customize the time the daily digest is sent. The daily digest provides a snapshot of events occurring over a 24-hour time frame, starting from the time you specify in the notifications settings.

Prerequisites

You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Notifications > Notification Preferences. The My Notifications page appears.
On the My Notifications page, click Edit time settings.
Select Custom time and then specify the time and time zone to send your account’s daily digest email.
Click Save. The daily digest email is sent each day at the time you selected.
Note
After you save a new time, the Hybrid Cloud Console converts the new time to the UTC time zone.

5.2. Updating your email address for notifications
Copy link

The notifications service sends email notifications to the email address listed in your Red Hat account.

You can update your email address using the steps in this procedure.

Prerequisites

You are logged in to the Hybrid Cloud Console.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.

Procedure

Click your user avatar in the upper right of the Red Hat Hybrid Cloud Console window. A drop-down list appears.
Click My profile.
Under Personal information, click the Change link next to your email address. This opens the Red Hat account management application.
In the Email address field, enter your new email address and then click Save. Red Hat sends a verification to your new email address.
Important
You must verify your new email address within one day to save the change.
Open the verification email from Red Hat in your email account and click Link to e-mail address verification. This confirms your email address and returns you to the Red Hat account management application. Your new email address is saved in your Red Hat account. If the change does not show in My profile immediately, log out of all Red Hat applications and log back in to view your updated account.

Chapter 6. Example: Configuring email notifications for advisories affecting your systems
Copy link

Event notifications are triggered differently in different Hybrid Cloud Console services. Events can be system-based (impacting individual registered systems), account-based (impacting multiple systems within an account), or subscription-based (impacting a product within a subscription).

You can customize your own notification preferences so that you receive the type of notifications you want in the Hybrid Cloud Console. For example, for advisory notifications:

To receive an notification only if one of your registered systems is affected by an advisory, subscribe to account-based notifications by opting in to Red Hat Lightspeed content service notifications.
To receive an notification about subscription-based updates such as bug fixes or new releases that impact any product in your subscriptions, opt in to errata notifications.

Important

Content service events only are triggered once per account, even if multiple systems are affected. The event is sent again if all affected systems are fixed and a new system is found with the advisory. See Understanding Red Hat Lightspeed Events and Notifications in the Hybrid Cloud Console for more information.

This example shows you how to configure notifications so that you only receive email notifications for advisories that impact specific systems in your inventory, instead of notifications for any product within your Red Hat subscription.

Key concepts, Errata advisory

Errata refers to the correction or update of a software package based on a security issue, bug, or the availability of a new feature. The advisory (or errata advisory) is the published text, while the errata is the packaged release. There are 3 types of errata advisories: Red Hat Security Advisory (RHSA), Red Hat Bug Advisory (RHBA), and Red Hat Enhancement Advisory (RHEA). For more detailed information about errata and types of advisories, see Explaining Red Hat Errata (RHSA, RHBA, and RHEA).

An errata notification is sent when a product within your subscription is affected, allowing you to determine the impact to your systems and what action (if any) to take.

Content advisory

A content advisory is similar to an errata advisory, but contains only the advisories that actually affect one or more of your systems so you can apply updates. The Red Hat Lightspeed content service in the Hybrid Cloud Console provides content advisories. See Managing system content and patch updates on RHEL systems for more information.

The notifications workflow: Before you can receive notifications from the content service, an Organization Administrator or Notifications Administrator must configure a behavior group to allow content notifications to be sent to specific users in the organization.

After you are added to the behavior group, you can select the services you want to receive notifications from, as well as the frequency, from Notification Preferences.

When an event occurs, all users on the account who opted in within their user preferences to receive notifications will receive the notification of the event.

You can further customize how you want to receive notifications by integrating third-party tools with the Hybrid Cloud Console. In addition to receiving email notifications, you can receive notifications in Event-Driven Ansible, Microsoft Teams, Slack, ServiceNow, and other applications. To configure third-party integrations for notifications, see Integrating the Red Hat Hybrid Cloud Console with third-party applications.

Note

See Understanding Red Hat Lightspeed Events and Notifications in the Hybrid Cloud Console for information about Red Hat Lightspeed events and how they are triggered.
See Understanding errata in the Subscriptions documentation for information about errata notifications.
See Managing system content and patch updates on RHEL systems for more information.

6.1. Creating a behavior group for content notifications
Copy link

To allow users in the organization to receive notifications from the content service, a Notifications administrator creates a new behavior group in the Hybrid Cloud Console for certain users.

From the Create behavior group wizard, select and assign notifications to users or groups of users, and associate Hybrid Cloud Console events with behavior groups.

You can associate events with multiple behavior groups. If a behavior group is not associated with any event, no notifications are sent when an event occurs.

Important

If your organization has configured workspaces to control user access to systems, review your notifications configuration to ensure that only appropriate groups of users are configured to receive notifications. If you do not review your notifications configuration, users might receive alerts triggered by systems outside of their workspace permission scope. See Viewing and managing system inventory for more information about configuring workspaces.

Prerequisites

An Organization Administrator has configured notification groups, roles, and members. See Configure User Access to manage notifications for more details.
You are logged in to the Hybrid Cloud Console as a Notifications administrator. To verify you have Notifications administrator permissions, check My User Access.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Notifications.
Under Notifications, select Configure Events.
Select the application bundle tab you want to configure event notification behavior for. For this example, select Red Hat Enterprise Linux.
Click the Behavior Groups tab.
Click Create new group to open the Create behavior group wizard.
Enter a group name (such as Content advisories), and then click Next.
From the Actions drop-down list, specify how you want to receive the notification. For this example, select Send an email:
Select a recipient from the Recipient drop-down list. You can specify that the email notification go to all users in the organization, or you can limit the recipients to administrators in the organization. If User Access groups are configured, you can select a User Access group to receive email notifications.
- Optional: To receive notifications in a third-party tool, click Add action to configure an additional notification method. If you select an integration such as Integration: Slack, Integration: Splunk, or Integration: Webhook, select an integration endpoint from the Recipient drop-down list.
  Note
  Configure endpoints for each integration in Settings > Integrations. If an action is disabled, no integrations exist for that event type. To configure third-party integrations to receive notifications, see Integrating the Red Hat Hybrid Cloud Console with third-party applications.
When you have finished configuring how to receive your notifications, click Next.
From the Associate event types screen, select the Content event type to be notified of content advisories, and then click Next.
Review the settings you selected for the behavior group. To save the settings and create the behavior group, click Finish.

Additional resources

6.2. Opting in to content notifications
Copy link

Each user in the Red Hat Hybrid Cloud Console must configure their notification preferences to receive email notifications about events. You can select the services from which to receive notifications as well as the frequency.

This example shows how to opt in to event notifications from the Red Hat Lightspeed content service, and opt out of errata notifications. The content service sends notifications for advisories that affect one or more of your registered systems, instead of sending notifications about all advisories affecting products in your subscription.

When you receive a notification from the content service (a content advisory), it indicates you have at least one system affected by the advisory.

Note

To be notified about subscription-level advisories that impact any of your subscribed products, opt in to errata notifications. See Understanding Red Hat Lightspeed Events and Notifications in the Hybrid Cloud Console for more information about Red Hat Lightspeed events and how they are triggered.

Prerequisites

You are logged in to the Hybrid Cloud Console.
You have configured relevant events in the console.
A Notifications administrator or Organization Administrator has configured behavior groups to receive event notifications from the content service.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Notifications > Notification Preferences. The My Notifications page appears.
Opt in to content notifications:
1. Search for the Content service and select it. A list of the available event notifications for the content service opens.
2. At the top of the list, click Select all to enable all notifications for the content service, or select one of the following options:
  - Daily digest: Receive a daily summary of content advisory events that occur in a 24 hour time frame.
  - Instant notification: Receive an email immediately for each content advisory.
    Important
    If you select Instant notification for any service, you might receive a very large number of emails.
3. Update your information and then click Save. Email notifications are delivered in the format and frequency that you selected. If notifications are configured for integrated third-party applications, the notifications are sent to those applications as well.
Opt out of errata notifications so that you do not receive all notifications for your subscription:
1. On the My Notifications page, search for the Errata service and select it. A list of the available event notifications for the errata service opens.
2. Click Deselect all or uncheck the boxes for the events you do not want to be notified about, and then click Save. You will no longer receive any email notifications unless you return to this screen and enable them once again.

Next steps

Optionally, you can further customize how you want to receive notifications by integrating third-party tools with the Hybrid Cloud Console.

In addition to receiving email notifications, you can receive notifications in Event-Driven Ansible, Microsoft Teams, Slack, ServiceNow, and other applications. To configure a third-party integration to receive notifications, see Integrating the Red Hat Hybrid Cloud Console with third-party applications.

Additional resources

Chapter 7. Troubleshooting notification failures
Copy link

The notifications service event log enables Notifications administrators to see when notifications are not working properly. The event log provides a list of all triggered events on the Red Hat Hybrid Cloud Console account, and actions taken (as configured in the associated behavior group) for the past 14 days.

img notif event log

In the Action taken column, each event shows the notification method highlighted in green or red to indicate the status of the message transmission. The filterable event log is a useful troubleshooting tool to see a failed notification event and identify potential issues with endpoints.

After seeing a failed action in the event log, the Notifications administrator can check the endpoint and the status of the last five connection attempts on the Integrations screen.

In the integrations service, the following connection statuses are reflected by color:

Green: Five previous transmissions were successful.
Red: Five previous transmissions were unsuccessful (timeout, 404 error, etc).
Yellow: Connection is degraded; at least two of the five previous transmissions were unsuccessful.
Unknown: The integration has not yet been called, or is not associated with a behavior group.

The event log can answer questions related to receipt of emails. By showing the email action for an event as green, the event log enables a Notifications administrator to confirm that emails were sent successfully.

Even when notifications and integrations are configured properly, individual users on the Hybrid Cloud Console account must configure their user preferences to receive emails.

Before users receive notifications using the webhook integration type, a Notifications administrator must configure endpoints for your organization’s preferred webhook application.

Note

Prerequisites

You are logged in to the Hybrid Cloud Console as a user with Notifications administrator or Organization Administrator permissions.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.

Procedure

In the Hybrid Cloud Console, navigate to Settings > Notifications > Event Log.
- Filter the events list by event, application, application bundle, action type, or action status.
- Select the time frame to show events from today, yesterday, the last seven days, the last 14 days (default), or set a custom range within the last 14 days.
- Sort the Date and time column in ascending or descending order.
Navigate to Settings > Notifications > Configure Events, and verify or change settings by event.
Ask users to check their user preferences for receiving email notifications. Even when notifications and integrations are configured properly, individual users on the Hybrid Cloud Console account must configure their user preferences to receive emails.

Providing feedback on Red Hat documentation
Copy link

We appreciate your feedback on our documentation. Provide as much detail as possible so that your request can be addressed.

Prerequisites

You have a Red Hat account.
You are logged in to your Red Hat account.
Note
You cannot log in to the Hybrid Cloud Console with your email address unless your email address is the same as your Red Hat login. For more information, see Finding your login.

Procedure

To provide your feedback, click the following link: Create Issue
Describe the issue or enhancement in the Summary text box.
Provide more details about the issue or enhancement in the Description text box.
If your Red Hat user name does not automatically appear in the Reporter text box, enter it.
Scroll to the bottom of the page and then click the Create button. A documentation issue is created and routed to the appropriate documentation team. Thank you for taking the time to provide feedback.

Legal Notice
Copy link

Except as otherwise noted below, the text of and illustrations in this documentation are licensed by Red Hat under the Creative Commons Attribution–Share Alike 3.0 Unported license . If you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, the Red Hat logo, JBoss, Hibernate, and RHCE are trademarks or registered trademarks of Red Hat, LLC. or its subsidiaries in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

XFS is a trademark or registered trademark of Hewlett Packard Enterprise Development LP or its subsidiaries in the United States and other countries.

The OpenStack® Word Mark and OpenStack logo are trademarks or registered trademarks of the Linux Foundation, used under license.

All other trademarks are the property of their respective owners.

Configuring notifications on the Red Hat Hybrid Cloud Console

Configuring Hybrid Cloud Console settings so that account users receive event-triggered notifications

Preface
Copy link

Chapter 1. Introduction to Red Hat Hybrid Cloud Console notifications
Copy link