Integrating the Red Hat Hybrid Cloud Console with third-party applications
Configuring integrations between third-party tools and the Red Hat Hybrid Cloud Console
Abstract
Preface
You can integrate some public clouds and third-party applications with the Hybrid Cloud Console. For information about integrating public clouds, see Configuring cloud integrations for Red Hat services.
You can integrate the Red Hat Hybrid Cloud Console with Splunk, ServiceNow, Slack, Event-Driven Ansible, Microsoft Teams, Google Chat, and more applications to route event-triggered notifications to those third-party applications. Integrating third-party applications expands the scope of notifications beyond emails and messages, so that you can view and manage Hybrid Cloud Console events from your preferred platform dashboard or communications tool.
To learn more about notifications, see Configuring notifications on the Red Hat Hybrid Cloud Console.
Prerequisites
- You have Organization Administrator or Notifications administrator permissions for the Hybrid Cloud Console.
- You have the required configuration permissions for each third-party application that you want to integrate with the Hybrid Cloud Console.
Chapter 1. Installing and configuring the Red Hat Insights application for Splunk
The Red Hat Insights application for Splunk forwards selected Hybrid Cloud Console events to Splunk. The application seamlessly integrates with the Hybrid Cloud Console, so that you can focus on handling the data on the Splunk application side in the same way that you manage other sources of data. After the integration has been configured, you can view and manage Hybrid Cloud Console notifications from the Splunk dashboard without having to open the Red Hat Hybrid Cloud Console.
Contacting support
If you have any issues with the Red Hat Insights application for Splunk, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help (? icon) > Open a support case, or view more options from ? > Support options.
Splunk will not provide troubleshooting. The Red Hat Insights application for Splunk is fully supported by Red Hat.
Prerequisites
You have Splunk login credentials:
-
On Splunk Cloud Platform, you must have the Splunk Cloud Administrator
sc-admin
role. -
On Splunk Enterprise, you must have the
admin
role. For more information about creating theadmin
role, see Create secure administration credentials in the Splunk documentation.
-
On Splunk Cloud Platform, you must have the Splunk Cloud Administrator
- You have Organization Administrator permissions for the Hybrid Cloud Console.
1.1. Installing the Red Hat Insights application for Splunk
Install and configure the Red Hat Insights application for Splunk to integrate Splunk with the Hybrid Cloud Console so that Splunk can receive event notifications from the Hybrid Cloud Console. The setup automation performs the following tasks:
- Creates a user group with the Notifications administrator role using the Organization Administrator permissions. You can also create the user group manually. For more information about manual configuration, see Manually configuring a Notifications administrator group in your Hybrid Cloud Console account.
- Uses the Splunk HEC URL and HEC token to create a new integration called SPLUNK_AUTOMATION, with the integration type Splunk.
- Creates a new behavior group called SPLUNK_AUTOMATION_GROUP on the RHEL bundle. The group includes an action to send notifications to the SPLUNK_AUTOMATION Splunk integration.
- Assigns the new behavior group SPLUNK_AUTOMATION_GROUP to all Hybrid Cloud Console services. This forwards the events from all services to Splunk. Currently, the behavior group forwards events from the Advisor, Policies, Drift, Compliance, Malware Detection, Patch, and Vulnerability services.
When Splunk begins to receive notifications from the Hybrid Cloud Console, the Red Hat Insights application for Splunk dashboard shows event activity. Each number contains a hyperlink to the Hybrid Cloud Console.
Prerequisites
- You have Organization Administrator permissions for the Hybrid Cloud Console.
You have Splunk login credentials:
-
To install applications on Splunk Cloud Platform, you must have the Splunk Cloud Administrator
sc-admin
role. -
To install applications on Splunk Enterprise, you must have the
admin
role. For more information about creating theadmin
role, see Create secure administration credentials in the Splunk documentation.
-
To install applications on Splunk Cloud Platform, you must have the Splunk Cloud Administrator
- Popup blockers are disabled in your browser.
Procedure
Install the Red Hat Insights Application for Splunk:
- Log in to Splunk.
- On the home page, search for Red Hat Insights in the filter box and select it.
-
Click Install. When the installation process completes, the message
Install successful
displays. - On the home page, click the Settings menu (gear icon). The Apps page opens.
- Enter Red Hat Insights in the filter box and then click the magnifying glass. The application appears in the search results.
- On the home page, click Find more apps under the Apps heading on the left of the screen. The Browse More Apps page opens.
- Enter Red Hat Insights in the filter box and then press the Enter key. Red Hat Insights appears in the search results.
- Select Red Hat Insights.
- Click Install.
- Confirm or enter your Splunk username and password and then click Agree and Install. When the installation process completes, the Complete dialog box opens.
Set up the Red Hat Insights Application for Splunk:
- In the Complete dialog box, click Open the App. The App configuration page opens.
Click Continue to app setup page. The Set up integration with Red Hat Insights page opens. The page includes the HTTP Event Collector (HEC) name and default index fields.
- Under Create Red Hat Default Index, click Settings > Index.The Indexes page opens in a new tab.
- On the Indexes page, click New Index.
-
Type a name for the index in the Name field (for example,
redhatinsights
). - Enter values in the Max raw data size and Searchable retention (days) field.
- Click Save. The index you created appears in the Indexes list. It is enabled by default.
-
On the first Splunk screen, on the Set up integration with Red Hat page, type the name for the HEC in the HEC name field (for example,
redhatinsights
). -
Type the name of the index you just created in the Default index field (for example,
redhatinsights
). - Click Next.
- Click Review and then click Submit. The HEC name that you created appears in the HEC Name field.
Click Next to create the HEC URL and HEC Token.
Configure Splunk integration in Insights:
- Click Copy to copy the HEC URL value in Splunk Enterprise.
Click Next: Configure Splunk integration in Insights. The Hybrid Cloud Console opens in a new browser tab.
NoteThis button is disabled until you click the Copy button for either the HEC URL or HEC token.
- In the Hybrid Cloud Console, navigate to Settings > Integrations.
Paste the HEC URL value into the Splunk HEC URL field.
NoteIf the new tab for the console does not open, disable the popup blocker in your browser.
Add the port, if needed. The default port for Splunk Cloud Platform is 443. The default port for Splunk Enterprise and Splunk Cloud free trial is 8088.
Optional: If you are using Splunk Cloud, edit the HEC URL that you pasted into the Splunk HEC URL field on the Integrations page to match the Splunk Cloud format:
Use the following format for Splunk Cloud Platform on all clouds except Google Cloud Platform (GCP):
<protocol>://http-inputs-<host>.splunkcloud.com:<port>/<endpoint>
Use the following format for Splunk Cloud Platform on Google Cloud Platform (GCP):
<protocol>://http-inputs.<host>.splunkcloud.com:<port>/<endpoint>
Replace the following placeholders:
-
protocol
: Eitherhttp
orhttps
. -
host
: The name of the Splunk Cloud Platform instance that runs the HEC, followed by the domain.splunkcloud.com
. -
port
: The HEC port number (443 by default on Splunk Cloud Platform instances). endpoint
: The HEC endpoint that you want to use. In many cases, you use the/services/collector/event
endpoint for JSON-formatted events, or theservices/collector/raw
endpoint for raw events.Examples:
Splunk Cloud Platform on GCP using JSON:
https://http-inputs.myhost.splunkcloud.com:443/services/collector/event
Splunk Cloud free trial on AWS using raw events:
https://http-inputs-otherhost.splunkcloud.com:443/services/collector/raw
- Complete the setup process:
- Copy the HEC Token value in Splunk and paste it into the Splunk HEC Token field in on the Hybrid Cloud Console Integrations page.
In the Hybrid Cloud Console, click Run configuration. The Hybrid Cloud Console sets up the integration, creates the behavior group, and associates Hybrid Cloud Console events to the behavior group. The status message section on the right side of the page shows the status of each of these actions.
When the setup completes successfully, click Next: Review. The application returns the message
Splunk integration in Insights completed
.- Click Go back to the Splunk application. This redirects you to the Set up integration with Red Hat screen in Splunk.
Click Finish set up to complete the setup in Splunk.
Click Go to dashboard to be redirected to your Splunk dashboard.
NoteIf the integration configuration fails during the Insights setup process, contact Red Hat support.
To view a list of Hybrid Cloud Console events on the Splunk dashboard, click the Events tab. Each event is hyperlinked to the Hybrid Cloud Console.
Additional Resources
- Splunk Enterprise
- Install apps on your Splunk Cloud deployment
- Configure HTTP Event Collector on Splunk Enterprise
- Configure HTTP Event Collector on Splunk Cloud Platform
- Configure user access
- Configure notifications on the Red Hat Hybrid Cloud Console
- Manually configuring a Notifications administrator group in your Hybrid Cloud Console account
1.2. Enabling the HEC token
Before Splunk can receive Hybrid Cloud Console events, you must enable the HEC token.
Prerequisites
- You have Organization Administrator permissions for the Hybrid Cloud Console.
You have Splunk login credentials:
-
On Splunk Cloud Platform, you must have the Splunk Cloud Administrator
sc-admin
role. -
On Splunk Enterprise, you must have the
admin
role. For more information about creating theadmin
role, see Create secure administration credentials in the Splunk documentation.
-
On Splunk Cloud Platform, you must have the Splunk Cloud Administrator
Procedure
- From the Splunk home page, navigate to Settings.
Select Data Inputs, and then select HTTP Event Collector. The HTTP Event Collector page shows the HEC, its Token value, the corresponding index that you selected during setup, and the status of the HEC.
Click Global Settings in the upper right corner of the page. The Edit Global Settings dialog box displays.
Select Enabled. This enables the HEC token that was automatically created during the setup process.
NoteThe HEC token uses a default HTTP port number of 8088. If you are using a different port (such as port 443 for Splunk Cloud), you must update your Hybrid Cloud Console Splunk Integration to match.
Additional Resources
- For more information about the HEC token in Splunk Cloud, see Configure HTTP Event Collector on Splunk Cloud Platform in the Splunk documentation.
- For more information about setting up and using the HEC in Splunk Enterprise, see Set up and use HTTP Event Collector on Splunk Enterprise in the Splunk Enterprise documentation.
1.3. Manually configuring a Notifications administrator group in your Hybrid Cloud Console account
The Red Hat Insights application for Splunk automated installation and setup process automatically configures a Notifications administrator role and group in your Hybrid Cloud Console account. However, you can create the Notifications administrator manually.
Prerequisites
- You are logged in to the Hybrid Cloud Console with the Organization Administrator role.
Procedure
- Click Settings > Identity & Access Management.
- Under Identity & Access Management, expand User Access if necessary, and select Groups.
- Click Create group. The Name and description page appears.
-
Enter a name for the group (for example,
splunknotifgroup
), enter a description, and click Next. The Add roles page opens. -
To add the Notifications administrator role, enter
notif
in the search box. - Select Notifications administrator from the search results list, and click Next. The Add Members page opens.
- Select the users to add to this group. You can use the search box to search for specific names.
- Click Next. The Review Details page opens.
- Review the information, and click Submit to create the group.
- Click Exit. The Groups page opens.
Verification
- Enter the new group name in the search box.
- Click the group name. The page for the group opens.
- On the Roles tab, verify that the group has the Notifications administrator role.
- Click the Members tab and verify that the group includes the correct members.
1.4. Manually configuring a Splunk integration
The Red Hat Insights application for Splunk automated installation and setup process automatically configures Splunk integration to your Hybrid Cloud Console account. Use this procedure if you want to configure the integration manually.
Prerequisites
- You have an HTTP Event Collector (HEC) URL from Splunk Cloud or Splunk Enterprise.
- You have the HEC token value from Splunk Cloud or Splunk Enterprise.
- You are logged in to the Hybrid Cloud Console with the Notifications administrator role.
Procedure
- In the Hybrid Cloud Console, navigate to Settings > Integrations.
- Select the Reporting & Automation tab.
- Click Add integration.
- Select Splunk as the integration type, and click Next.
-
Enter a name for your new integration in the Integration name field (for example,
redhat_splunk
). In the Endpoint URL field, add your Splunk HEC endpoint URL:
-
For Splunk Enterprise, Splunk uses port 8088 by default. For example:
https://<splunk-endpoint>:8088
For Splunk Cloud, Splunk uses port 443. For more information about Splunk Cloud on AWS or GCP, see Send data to HTTP Event Collector.
NoteThe service automatically adds
<endpoint>
(thehttp
path). You do not need to include it in the form input for the Endpoint URL.The following examples show endpoint URLs with the correct port numbers for Splunk platforms.
-
On premise (Splunk Enterprise):
https://splunk.company.com:8088
-
Splunk Cloud (on AWS):
https://http-inputs-mycompany.splunkcloud.com:443
-
Splunk Cloud (on GCP):
https://http-inputs.mycompany.splunkcloud.com:443
-
On premise (Splunk Enterprise):
-
For Splunk Enterprise, Splunk uses port 8088 by default. For example:
- In the Secret token field, add the Splunk HEC token value.
- Click Next.
- Review the integration details and click Submit.
Additional resources
- For more information about the HEC token in Splunk Cloud, see Configure HTTP Event Collector on Splunk Cloud Platform in the Splunk documentation.
- For more information about configuring ports for Splunk Cloud, see Send data to HTTP Event Collector.
- For more information about setting up and using the HEC in Splunk Enterprise, see Set up and use HTTP Event Collector on Splunk Enterprise in the Splunk Enterprise documentation.
1.5. Additional resources
- For more information about Splunk, see the Splunk website.
- For more information about Splunkbase, see the Splunkbase website.
- For information about troubleshooting your Splunk integration, see Troubleshooting Hybrid Cloud Console integrations.
Chapter 2. Integrating ServiceNow with the Red Hat Hybrid Cloud Console
The ServiceNow Flow Templates for Red Hat Insights application integrates with Insights for Red Hat Enterprise Linux services. The templates provide ServiceNow flows for creating incidents out of found vulnerabilities, performance, system configuration recommendation, and other risks. The application includes a sample flow that you can edit to customize it for your organization.
This application forwards selected Hybrid Cloud Console events to ServiceNow. The Flow Templates for Red Hat Insights application seamlessly integrates with the Hybrid Cloud Console so that you can focus on handling the data on the ServiceNow application side in the same way you manage other sources of data.
You can use the Flow Templates for Red Hat Insights application to handle events from the following Hybrid Cloud Console services:
- Advisor
- Vulnerability
- Any additional Red Hat Hybrid Cloud Console events that you might have configured
Insights for RHEL is included as part of your Red Hat subscription and is accessible through the Red Hat Hybrid Cloud Console.
Contacting support
If you have any issues with the Red Hat Insights application for ServiceNow, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help (? icon) > Open a support case, or view more options from ? > Support options.
ServiceNow will not provide troubleshooting. The Red Hat Insights application for ServiceNow is fully supported by Red Hat.
2.1. Installing and configuring the ServiceNow Flow Templates for Red Hat Insights application
You can use the Flow Templates for Red Hat Insights application to integrate ServiceNow with the Hybrid Cloud Console to create ServiceNow flows from triggered events in the Hybrid Cloud Console. To integrate ServiceNow with Red Hat Hybrid Cloud Console, you must install the ServiceNow IntegrationHub Enterprise Pack Installer plugin. After the plugin and the application are configured, event data flows from the Hybrid Cloud Console to your ServiceNow instance. A ServiceNow REST API asynchronous trigger receiver is used within the application flow.
Prerequisites
- You have Organization Administrator permissions for the Hybrid Cloud Console.
- Notifications administrator permissions are configured in User Access.
- You have a Red Hat subscription and you can access the Red Hat Hybrid Cloud Console.
- Popup blockers are disabled in your browser.
- ServiceNow IntegrationHub Enterprise Pack Installer plugin is installed. If it is not installed, request the plugin from ServiceNow.
You have access to the following ServiceNow roles:
-
admin
-
x_rhtpp_rh_webhook.rest
-
sn_appclient.app_client_company_installer
(can only install applications that match the instance company), orsn_appclient.app_client_user
.
-
- In ServiceNow you have incident (write) access for table permissions.
- You are using the San Diego or later release of ServiceNow.
Procedure
- Log in to your ServiceNow instance.
Navigate to the ServiceNow Store home page and install or update the Flow Templates:
Install the Flow Templates for Red Hat Insights application from the ServiceNow Store (or as an Update Set).
-
Create a new user with User ID
rh_insights_integration
. - Check Internal Integration User for the user you just created.
- Ensure that the user is Active.
-
Assign role
x_rhtpp_rh_webhook.rest
to the user. - Generate a password for the user. Copy this information for use during the setup process.
-
Create a new user with User ID
- Open the Hybrid Cloud Console in a new browser window or tab.
Navigate to Settings > Integrations, select the Reporting & Automation tab, and complete the following steps:
- Click Add integration.
- Select ServiceNow as the integration type, and click Next.
- Enter a name for the integration, such as ServiceNow integration.
Provide the Endpoint URL and replace
<instance.servicenow.com>
with your ServiceNow instance:https://<instance.servicenow.com>/api/x_rhtpp_rh_webhook/flow_templates_for_red_hat_insights
- The checkbox to Enable SSL is checked by default.
-
In the Secret token field, paste the generated password of the
rh_insights_integration
user that you created in ServiceNow. - Click Next.
- Review the integration details and click Submit.
Navigate to Hybrid Cloud Console > Settings > Notifications and complete the following steps:
- Under Notifications, select Configure Events.
- Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, or OpenShift.
- Click the Behavior Groups tab.
- Click Create new group to open the Create behavior group wizard.
- Type the name of the new behavior group in the Name field and click Next.
- For Actions, select Integration: ServiceNow from the drop-down list.
- For Recipient, select the integration for ServiceNow that you created earlier (for example, ServiceNow integration).
- Click Next. The Associate event types window opens.
Select the following event types from the list:
- Advisor new recommendation
- New vulnerability with CVSS >= 7.0
- New vulnerability with Critical Severity
- New vulnerability containing Security rule
- Any vulnerability with known exploit
- Click Next, and then click Finish to complete the setup process.
Note that events are generated on certain conditions (for example, when a system configured with Red Hat Insights checks in). If no events appear in ServiceNow, check the Event log to see whether any events matching the conditions have occurred.
If the integration configuration fails during the Insights setup process, contact Red Hat support.
2.2. Additional resources
Additional resources
- For information about designing ServiceNow flows, see the ServiceNow Flow Designer.
- To download ServiceNow applications, see the ServiceNow Store.
- For information about installing an application that you purchased from the ServiceNow Store to make it available on your instance, see Install a ServiceNow Store Application.
- For information about configuring notifications after you have integrated ServiceNow with the Hybrid Cloud Console, see Configuring notifications on the Red Hat Hybrid Cloud Console.
- For information about troubleshooting your ServiceNow integration, see Troubleshooting Hybrid Cloud Console integrations.
- For more information about the ServiceNow Store, see ServiceNow Store.
- For more information about ServiceNow, see ServiceNow.
Chapter 3. Integrating Slack with the Hybrid Cloud Console
You can configure the Hybrid Cloud Console to send event notifications to a Slack channel or directly to a user. The Slack integration supports events from all Hybrid Cloud Console services.
The Slack integration in this example is configured for Red Hat Enterprise Linux. The integration also works with Red Hat OpenShift and Hybrid Cloud Console events.
The Slack integration uses incoming webhooks to receive event data. For more information about webhooks, see Sending messages using incoming webhooks in the Slack API documentation.
Contacting support
If you have any issues with the Hybrid Cloud Console integration with Slack, contact Red Hat for support. Slack will not provide troubleshooting. The Hybrid Cloud Console integration with Slack is fully supported by Red Hat.
You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help > Open a support case, or view more options from Help > Support options.
3.1. Configuring incoming webhooks in Slack
To prepare Slack for integration with the Hybrid Cloud Console, you must configure incoming webhooks in Slack.
Prerequisites
- You have owner or admin permissions to the Slack instance where you want to add incoming webhooks.
- You have App Manager permissions to add Slack apps to a channel.
- You have a Slack channel or user to receive notifications.
Procedure
Create a Slack app:
- Go to the Slack API web page and click the Create your Slack app button. This opens the Create an app dialog.
- Select From scratch to use the Slack configuration UI to create your app.
Enter a name for your app and select the workspace where you want to receive notifications.
NoteIf you see a message that administrator approval is required, you can request approval in the next step.
- Click Create App to finish creating the Slack app.
Enable incoming webhooks:
- Under the Features heading in the left navigation, click Incoming Webhooks.
- Toggle the Activate Incoming Webhooks switch to On.
- Click the Request to Add New Webhook button. If required, enter a message to your administrators to grant access to your app and click Submit Request. A success message confirms you have configured this correctly.
Create an incoming webhook:
- Under Settings in the left navigation, click Basic Information.
- In the Install your app section, click the Install to Workspace button.
- Select the channel where you want your Slack app to post notifications, or select a user to send notifications to as direct messages.
- Click Allow to save changes.
Optional: Configure how your Hybrid Cloud Console notifications appear in Slack:
- Scroll down to Display Information.
- Configure your app description, icon, and background color as desired.
Copy the webhook URL:
- Under Features, click Incoming Webhooks.
- Click the Copy button next to the webhook URL. You will use the URL to set up the integration in the Hybrid Cloud Console in Section 3.2, “Configuring the Slack integration in the Red Hat Hybrid Cloud Console”.
Verification
- Open the Slack channel or user you selected during configuration, and check for a message confirming you have added the integration.
Additional resources
- For information about webhooks in Slack, see Sending messages using incoming webhooks.
- For information about workflows, see Build a workflow: Create a workflow that starts outside of Slack.
- For information about managing app approvals, see Managing app approvals in Enterprise Grid workspaces.
- For general help with Slack, see the Slack Help Center.
3.2. Configuring the Slack integration in the Red Hat Hybrid Cloud Console
After you have configured an incoming webhook in Slack, you can configure the Hybrid Cloud Console to send event notifications to the Slack channel or user you configured.
Prerequisites
- You have Organization Administrator or Notifications administrator permissions for the Red Hat Hybrid Cloud Console.
Procedure
If necessary, go to the Slack API web page and copy the webhook URL that you configured.
NoteSee Section 3.1, “Configuring incoming webhooks in Slack” for the steps to create a Slack webhook URL.
- In the Hybrid Cloud Console, navigate to Settings > Integrations.
- Select the Communications tab.
- Click Add integration.
- Select Slack as the integration type and click Next.
- Enter a name for the integration (for example, My Slack notifications).
- Paste the Slack webhook URL that you copied from Slack into the Workspace URL field and click Next.
- To enable the integration, review the integration details and click Submit.
- Refresh the integrations page to show the Slack integration in the Integrations > Communications list. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the Hybrid Cloud Console.
Verification
Create a test notification to confirm you have successfully connected Slack to the Hybrid Cloud Console:
- Next to your Slack integration on the Integrations > Communications page, click the options icon (⋮) and click Test.
- In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
- Open the Slack channel you configured and check for the message sent from the Hybrid Cloud Console.
- In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Slack event is listed with a green label.
Additional resources
- For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in the notifications documentation.
3.3. Creating the behavior group for the Slack integration
A behavior group defines which notifications will be sent to external services such as Slack when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group.
Prerequisites
- You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
- You have configured the Slack integration.
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, or OpenShift.
- Click the Behavior Groups tab.
- Click Create new group to open the Create behavior group wizard.
- Enter a name for the behavior group and click Next.
- In the Actions and Recipients step, select Integration: Slack from the Actions drop-down list.
From the Recipient drop-down list, select the name of the integration you created (for example, My Slack notifications) and click Next.
- In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.
Review your behavior group settings and click Finish. The new behavior group appears on the Notifications > Configure Events page in the Behavior Groups tab.
NoteYou can create and edit multiple behavior groups to include any additional platforms that the notifications service supports.
Select Settings > Integrations and click the Communications tab. When the Slack integration is ready to send events to Slack, the Last connection attempt column shows Ready. If the notification reached Slack successfully, the Last connection attempt column shows Success.
Verification
-
Create an event that will trigger a Hybrid Cloud Console notification. For example, run
insights-client
on a system that will trigger a policy event. - Wait a few minutes, and then navigate to Slack.
- In your Slack channel, check for notifications from the Hybrid Cloud Console.
In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Slack.
- If the label is green, the notification succeeded.
- If the label is red, the integration might need to be adjusted.
If the integration is not working as expected, verify that the incoming webhook connector was properly created in Slack, and that the correct incoming webhook URL is added in the Hybrid Cloud Console integration configuration.
NoteSee Troubleshooting notification failures with the event log and integration settings in the notifications documentation for more details.
3.4. Additional resources
- For detailed information about Slack configuration, see Sending messages using incoming webhooks in the Slack documentation.
- For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups.
- For information about troubleshooting your Slack integration, see Troubleshooting Hybrid Cloud Console integrations.
Chapter 4. Integrating Event-Driven Ansible with the Red Hat Hybrid Cloud Console
You can use Event-Driven Ansible to take advantage of Hybrid Cloud Console capabilities such as Red Hat Insights to continuously analyze your inventory for potential issues and recommendations. Event-Driven Ansible connects sources of events with corresponding actions through rules.
The integration with the Hybrid Cloud Console notifications service uses Event-Driven Ansible to trigger actions. Each account configures how and who can receive these events, with the ability to perform actions depending on the event type.
Contacting support
If you have any issues with the Hybrid Cloud Console integration with Event-Driven Ansible, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help (? icon) > Open a support case, or view more options from ? > Support options.
4.1. Configuring Event-Driven Ansible for integration with the Red Hat Hybrid Cloud Console
You can configure Event-Driven Ansible to receive event notifications from the Red Hat Hybrid Cloud Console or a third-party application.
Prerequisites
-
The
ansible-rulebook
CLI is installed. See Ansible rulebook installation for instructions. - You have Organization Administrator or Notifications administrator permissions for the Hybrid Cloud Console.
Procedure
Connect your environment to the Red Hat Ansible Automation Hub:
- In the Hybrid Cloud Console, navigate to Ansible Automation Platform > Connect to Hub.
- Under Offline token, copy the string under The token will expire after 30 days of inactivity. Run the command below periodically to prevent your token from expiring.
- In a terminal window, paste the string that you copied in the previous step.
Enter the following command to install the Red Hat Insights collection for Event-Driven Ansible:
$ ansible-galaxy collection install redhat.insights_eda
To install the Red Hat Insights requirements, enter the following command as the
root
user:# pip3 install -r ~/.ansible/collections/ansible_collections/redhat/insights_eda/requirements.txt
Enter the following command and verify that
redhat.insights_eda
is included in the output:$ ansible-galaxy collection list
Sample output for this command:
# /home/username/.ansible/collections/ansible_collections Collection Version ------------------ ------- ansible.eda 1.3.8 community.general 7.0.1 redhat.insights_eda 1.0.0
Use a text editor to create a YAML file that contains a simple Ansible rulebook that uses the Red Hat Insights collection. For example, create a file called
simple-rulebook.yaml
with the following content:--- - name: Listen for events from Red Hat Insights hosts: all sources: - redhat.insights_eda.insights: rules: - name: Handle Red Hat Insights payload condition: event.payload is defined action: debug: msg: "Received: {{ event.payload }}"
This simple playbook uses the
redhat.insights_eda.insights
collection as the source. If an event withpayload
is defined, the contents ofevent.payload
are displayed as output.The rulebook exposes an endpoint that is used to receive events and communicate with the Hybrid Cloud Console. See the Event-Driven Ansible for Red Hat Insights documentation in Ansible Automation Hub for more advanced examples for the Red Hat Insights Advisor, Compliance, and Vulnerability services.
Create a YAML file that contains an associated playbook. For example, create a file called
inventory.yaml
that contains a simple inventory:all:
Run the
ansible-rulebook
command to start your Event-Driven Ansible listener to listen for new events. In the following example, this command exposes yourlocalhost
on the default port 5000:$ ansible-rulebook --verbose --rulebook simple-rulebook.yml -i inventory.yml
Run the
curl
command in a separate terminal window to verify that your Event-Driven Ansible listener is configured correctly, for example:$ curl -H 'Content-Type: application/json' -d "{\"payload\": \"Test incoming event\"}" localhost:5000/endpoint
In this example, if the configuration is correct, a new message appears in the EDA listener window with the content of the event:
Received: {'payload': 'Test incoming event'}
- In the Hybrid Cloud Console, navigate to Settings > Integrations.
- Select the Reporting & Automation tab.
- Click Add integration.
- Select Event-Driven Ansible as the integration type, and then click Next.
- In the Integration name field, enter a name for your integration (for example, My EDA Integration).
Enter the URL that you configured in your Ansible rulebook into the Endpoint URL field. This is the endpoint that points to the Event-Driven Ansible listener.
NoteThe Endpoint URL must include
http://
orhttps://
, for examplehttps://<eda_hostname>:5000/endpoint
.If necessary, ask the security administrator for your organization to configure access to the Red Hat Hybrid Cloud Console.
Optional: Enter a Secret token if one is configured.
NoteA 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.
- Click Next.
- Review the integration details, and then click Submit to enable the integration.
Your Event-Driven Ansible integration is now listed on the Integrations > Reporting & Automation page. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the console.
Verification
Create a test notification to confirm you have correctly connected Event-Driven Ansible to the Hybrid Cloud Console:
- Next to your Event-Driven Ansible integration on the Integrations > Reporting & Automation page, click the options icon (⋮) and click Test.
- In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
- In the Event-Driven Ansible listener terminal, check for the message sent from the Hybrid Cloud Console.
- In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Event-Driven Ansible event is listed with a green label.
Additional resources
- For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in Configuring notifications on the Red Hat Hybrid Cloud Console.
-
For more Event-Driven Ansible configuration information and examples of Red Hat Insights rulebooks, see the Documentation tab in the
insights_eda
collection available from the Ansible Automation Hub Collections page.
4.2. Creating the behavior group for the Event-Driven Ansible integration
A behavior group defines which notifications will be sent to external services such as Event-Driven Ansible when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group.
Prerequisites
- You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
- The Event-Driven Ansible integration with the Hybrid Cloud Console is configured. See Section 4.1, “Configuring Event-Driven Ansible for integration with the Red Hat Hybrid Cloud Console” for information about configuring Event-Driven Ansible integration.
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, or OpenShift.
- Click the Behavior Groups tab.
- Click Create new group to open the Create behavior group wizard.
- Type a name for the behavior group and click Next.
- In the Actions and Recipients step, select Integration: Event-Driven Ansible from the Actions drop-down list.
- From the Recipient drop-down list, select the name of the integration you created (for example, My EDA Listener) and click Next.
- In the Associate event types step, select one or more events for which you want to send notifications (for example, Advisor: New recommendation) and click Next.
- Review your behavior group settings and click Finish. The new behavior group appears on the Notifications page.
Verification
- Create an event that will trigger a Hybrid Cloud Console notification. See the Ansible Automation Hub page for an example.
To test that the Hybrid Cloud Console integration was successful, in the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Event-Driven Ansible.
- If the label is green, the notification succeeded.
- If the label is red, verify that the webhook has been properly created and exposed in Event-Driven Ansible, and that the correct webhook URL is configured in the Hybrid Cloud Console integration configuration.
See Troubleshooting notification failures with the event log and integration settings in the notifications documentation for more details.
4.3. Additional resources
- For more information about Event-Driven Ansible, see the Getting Started with Event-Driven Ansible Guide.
- For information about how to configure and use the Event-Driven Ansible controller, see Event-Driven Ansible controller user guide.
- For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups.
- For configuration examples, see Red Hat Insights Collection for Event-Driven Ansible and Using Red Hat Insights as a source of events for Event-Driven Ansible automation in the Red Hat Ansible blog.
- For information about troubleshooting your Event-Driven Ansible integration, see Troubleshooting Hybrid Cloud Console integrations.
Chapter 5. Integrating Microsoft Teams with the Hybrid Cloud Console
You can configure the Red Hat Hybrid Cloud Console to send event notifications to all users on a new or existing channel in Microsoft Teams. The Microsoft Teams integration supports events from all services in the Hybrid Cloud Console. The Microsoft Teams integration uses incoming webhooks to receive event data.
Contacting support
If you have any issues with integrating the Hybrid Cloud Console with Microsoft Teams, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help (? icon) > Open a support case, or view more options from ? > Support options.
Microsoft will not provide troubleshooting. The Hybrid Cloud Console integration with Microsoft Teams is fully supported by Red Hat.
5.1. Configuring Microsoft Teams for integration with the Hybrid Cloud Console
You can use incoming webhooks to configure Microsoft Teams to receive event notifications from the Red Hat Hybrid Cloud Console or a third-party application.
Prerequisites
- You have admin permissions for Microsoft Teams.
- You have Organization Administrator or Notifications administrator permissions for the Hybrid Cloud Console.
Procedure
- Create a new channel in Microsoft Teams or select an existing channel.
- Navigate to Apps and search for the Incoming Webhook application.
- Select the Incoming Webhook application and click Add to a team.
- Select the team or channel name and click Set up a connector.
- Enter a name for the incoming webhook (for example, Red Hat Notifications). This name appears on all notifications that the Microsoft Teams channel receives from the Red Hat Hybrid Cloud Console through this incoming webhook.
- Optional: Upload an image to associate with the name of the incoming webhook. This image appears on all notifications that the Microsoft Teams channel receives from the Hybrid Cloud Console through this incoming webhook.
- Click Create to complete creation and display the webhook URL.
- Copy the URL to your clipboard. You need the URL to configure notifications in the Hybrid Cloud Console.
- Click Done. The Microsoft Teams page displays the channel and the incoming webhook.
- In the Hybrid Cloud Console, navigate to Settings > Integrations.
- Click the Communications tab.
- Click Add integration.
- Select Microsoft Office Teams as the integration type, and click Next.
- In the Integration name field, enter a name for your integration (for example, console-teams).
- Paste the incoming webhook URL that you copied from Microsoft Teams into the Endpoint URL field.
- Click Next.
- Review the integration details and click Submit to enable the integration.
Your Microsoft Teams integration is now listed on the Integrations > Communications page. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the console.
Verification
Create a test notification to confirm you have correctly connected Microsoft Teams to the Hybrid Cloud Console:
- Next to your Microsoft Teams integration on the Integrations > Communications page, click the options icon (⋮) and click Test.
- In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
- Open your Microsoft Teams channel and check for the message sent from the Hybrid Cloud Console.
- In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Microsoft Teams event is listed with a green label.
Additional resources
- For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in the notifications documentation.
5.2. Creating the behavior group for the Microsoft Teams integration
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. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group. For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups.
Prerequisites
- You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
- The Microsoft Teams integration is configured. For information about configuring Microsoft Teams integration, see Section 5.1, “Configuring Microsoft Teams for integration with the Hybrid Cloud Console”.
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, or OpenShift.
- Click the Behavior Groups tab.
- Click Create new group to open the Create behavior group wizard.
- Type a name for the behavior group and click Next.
- In the Actions and Recipients step, select Integration: Microsoft Teams from the Actions drop-down list.
- From the Recipient drop-down list, select the name of the integration you created (for example, console-teams) and click Next.
- In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.
- Review your behavior group settings and click Finish. The new behavior group appears on the Notifications > Configure Events page in the Behavior Groups tab.
Verification
-
Create an event that will trigger a Hybrid Cloud Console notification. For example, run
insights-client
on a system that will trigger a policy event. - Wait a few minutes, and then navigate to Microsoft Teams.
- Select the channel that you configured from the left menu. If the setup process succeeded, the page displays a notification from the Hybrid Cloud Console. The notification contains the name of the host that triggered the event and a link to that host, as well as the number of events and a link that opens the corresponding Hybrid Cloud Console service.
In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Microsoft Teams.
- If the label is green, the notification succeeded.
If the label is red, verify that the incoming webhook connector was properly created in Microsoft Teams, and that the correct incoming webhook URL is added in the Hybrid Cloud Console integration configuration.
NoteSee Troubleshooting notification failures with the event log and integration settings in the notifications documentation for more details.
5.3. Additional resources
- For information about troubleshooting your Microsoft Teams integration, see Troubleshooting Hybrid Cloud Console integrations.
- For more information about webhooks, see Create an Incoming Webhook and Webhooks and Connectors in the Microsoft Teams documentation.
Chapter 6. Integrating Google Chat with the Red Hat Hybrid Cloud Console
You can configure the Red Hat Hybrid Cloud Console to send event notifications to a new or existing Google space in Google Chat. The Google Chat integration supports events from all Hybrid Cloud Console services.
The integration with the Hybrid Cloud Console notifications service uses incoming webhooks to receive event data. Each Red Hat account configures how and who can receive these events, with the ability to perform actions depending on the event type.
Contacting Support
If you have any issues with the Hybrid Cloud Console integration with Google Chat, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help > Open a support case, or view more options from Help > Support options.
Google will not provide troubleshooting. The Hybrid Cloud Console integration with Google Chat is fully supported by Red Hat.
6.1. Configuring incoming webhooks in Google Chat
In Google spaces, create a new webhook to connect with the Hybrid Cloud Console.
Prerequisites
- You have a new or existing Google space in Google Chat.
Procedure
In your Google space, click the arrow on the space name to open the dropdown menu:
- Select Apps & Integrations.
- Click Webhooks.
Enter the following information in the Incoming webhooks dialog:
- Enter a name for the integration (for example, Engineering Google Chat).
- Optional: To add an avatar for the notifications, enter a URL to an image.
- Click Save to generate the webhook URL.
- Copy the webhook URL to use for configuration in the Hybrid Cloud Console.
Additional resources
- See Send messages to Google Chat with incoming webhooks in the Google Chat documentation for more detailed information about Google Chat configuration.
6.2. Configuring the Google Chat integration in the Red Hat Hybrid Cloud Console
Create a new integration in the Hybrid Cloud Console using the webhook URL from Google Chat.
Prerequisites
- You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
- You have a Google Chat incoming webhook.
Procedure
- In the Hybrid Cloud Console, navigate to Settings > Integrations.
- Select the Communications tab.
- Click Add integration.
- Select Google Chat as the integration type, and click Next.
- In the Integration name field, enter a name for your integration (for example, console-gchat).
- Paste the incoming webhook URL that you copied from your Google space into the Endpoint URL field, and click Next.
- Review the integration details and click Submit to enable the integration.
Your Google Chat integration is now listed on the Integrations > Communications page. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the console.
Verification
Create a test notification to confirm you have successfully connected Google Chat to the Hybrid Cloud Console:
- Next to your Google Chat integration on the Integrations > Communications page, click the options icon (⋮) and click Test.
- In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
- Open your Google space and check for the message sent from the Hybrid Cloud Console.
- In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Google Chat event is listed with a green label.
Additional resources
- For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in the notifications documentation.
6.3. Creating the behavior group for the Google Chat integration
A behavior group defines which notifications will be sent to external services such as Google Chat when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group.
Prerequisites
- You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
- You have configured the Google Chat integration.
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, or OpenShift.
- Click the Behavior Groups tab.
- Click Create new group to open the Create behavior group wizard.
- Type a name for the behavior group and click Next.
- In the Actions and Recipients step, select Integration: Google Chat from the Actions drop-down list.
- From the Recipient drop-down list, select the name of the integration you created (for example, console-gchat) and click Next.
- In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.
- Review your behavior group settings and click Finish. The new behavior group is listed on the Notifications page.
Verification
-
Create an event that will trigger a Hybrid Cloud Console notification. For example, run
insights-client
on a system that will trigger a policy event. - Wait a few minutes, and then navigate to Google Chat.
- In your Google Space, check for notifications from the Hybrid Cloud Console.
In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Google Chat.
- If the label is green, the notification succeeded.
- If the label is red, the integration might need to be adjusted.
- If the integration is not working as expected, verify that the incoming webhook connector was properly created in Google Chat, and that the correct incoming webhook URL is added in the Hybrid Cloud Console integration configuration.
See Troubleshooting notification failures with the event log and integration settings in the notifications documentation for more details.
6.4. Additional resources
- For information about troubleshooting your Google Chat integration, see Troubleshooting Hybrid Cloud Console integrations.
- See the Google Chat documentation about incoming webhooks for more detailed information about Google Chat configuration.
- For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups.
Chapter 7. Configuring a webhook integration with the Hybrid Cloud Console
For third-party applications that do not have a native Hybrid Cloud Console integration available, you can use the webhook integration type to receive event notifications from the Hybrid Cloud Console in your chosen application. Webhook integrations support events from all Hybrid Cloud Console services.
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.
Contacting support
If you have any issues with integrating the Hybrid Cloud Console with webhooks, contact Red Hat for support. You can open a Red Hat support case directly from the Hybrid Cloud Console by clicking Help (? icon) > Open a support case, or view more options from ? > Support options.
7.1. Configuring a webhook integration with the Hybrid Cloud Console
For third-party applications that do not have a native Hybrid Cloud Console integration available, configure a webhook integration to receive event notifications from the Hybrid Cloud Console in your chosen application.
Prerequisites
- You have configured a webhook in your third-party application.
- You have Organization Administrator or Notifications administrator permissions for the Hybrid Cloud Console.
Procedure
- In the Hybrid Cloud Console, navigate to Settings > Integrations.
- Click the Webhooks tab.
- Click Add integration.
- In the Integration name field, enter a name for your integration.
- Paste the webhook URL from your third-party application into the Endpoint URL field.
Optional: Enter a Secret token if one is configured.
NoteA 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.
- Click Next.
- Review the integration details and click Submit to enable the integration.
- Refresh the integrations page to show the webhook integration in the Integrations > Webhooks list. Under Last connection attempt, the status is Ready to show the connection can accept notifications from the Hybrid Cloud Console.
Verification
Create a test notification to confirm you have correctly connected your application to the Hybrid Cloud Console:
- Next to your integration on the Integrations > Webhooks page, click the options icon (⋮) and then click Test.
- In the Integration Test screen, enter a message and click Send. If you leave the field empty, the Hybrid Cloud Console sends a default message.
- Open your third-party application and check for the message sent from the Hybrid Cloud Console.
- In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: Webhook event is listed with a green label.
Additional resources
- For more information about setting up Notifications administrator permissions, see Configure User Access to manage notifications in the notifications documentation.
7.2. Creating the behavior group for a webhook integration
A behavior group defines which notifications will be sent to external services when a specific event is received by the notifications service. You can link events from any Red Hat Hybrid Cloud Console service to your behavior group. For more information about behavior groups, see Configuring Hybrid Cloud Console notification behavior groups.
Prerequisites
- You are logged in to the Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions.
- A webhook integration is configured. For configuration steps, see Section 7.1, “Configuring a webhook integration with the Hybrid Cloud Console”.
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, or OpenShift.
- Click the Behavior Groups tab.
- Click Create new group to open the Create behavior group wizard.
- Type a name for the behavior group and click Next.
- In the Actions and Recipients step, select Integration: Webhook from the Actions drop-down list.
- From the Recipient drop-down list, select the name of the webhook integration you created and click Next.
- In the Associate event types step, select one or more events for which you want to send notifications (for example, Policies: Policy triggered) and click Next.
- Review your behavior group settings and click Finish. The new behavior group appears on the Notifications > Configure Events page in the Behavior Groups tab.
Verification
-
Create an event that will trigger a Hybrid Cloud Console notification. For example, run
insights-client
on a system that will trigger a policy event. - Wait a few minutes, and then navigate to your third-party application to check for a notification.
In the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check for an event that shows the label Integration: Webhook.
- If the label is green, the notification succeeded.
If the label is red, verify that the incoming webhook connector was properly created in your application, and that the correct incoming webhook URL is added in the Hybrid Cloud Console integration configuration.
NoteSee Troubleshooting notification failures with the event log and integration settings in the notifications documentation for more details.
7.3. Additional resources
- For more information about Hybrid Cloud Console notifications methods, see Configuring notifications on the Red Hat Hybrid Cloud Console.
- For information about troubleshooting your integration, see Troubleshooting Hybrid Cloud Console integrations.
For webhook configuration examples, see these articles in the Red Hat blog:
Appendix A. Troubleshooting Hybrid Cloud Console integrations
If you experience issues while integrating a third-party application with the Hybrid Cloud Console, review the following troubleshooting solutions.
A.1. Troubleshooting connection issues between third-party integrations and Red Hat Insights
If you experience connection issues between your third-party application and Red Hat Insights, ensure that your third-party application accepts incoming requests from the following Red Hat IP addresses:
-
23.20.194.86
-
23.22.242.238
-
54.147.218.140
Additional resources
- For the most up-to-date list of IP addresses, see Firewall Configuration for accessing Red Hat Insights / Hybrid Cloud Console Integrations & Notifications.
A.2. Troubleshooting Hybrid Cloud Console integration with Splunk
Review the following issues if your Hybrid Cloud Console console integration with Splunk is not working as expected:
Splunk does not receive event notifications from the Hybrid Cloud Console
Configuration errors in the Splunk environment can result in Splunk not receiving event notifications from the Hybrid Cloud Console.
- In Splunk, make sure that the HTTP Event Collector (HEC) is enabled under Global Settings. See Enabling the HEC token.
-
Make sure that the default index is
redhatinsights
. - Make sure the firewall allows for incoming requests on the configured Splunk HEC port (default for Splunk Enterprise is 8088, and default for Splunk Cloud is 443). If you are using AWS for your instance, allow any of the ports Splunk might need. For more information, refer to Splunk Phantom ports and endpoints.
For more information about configuring Splunk HEC ports, see Splunk Phantom ports and endpoints.
Cannot click links in the Events table in Splunk when using real-time search
In Splunk, if you select a relative value from the Timestamp field in the Events table, you can then click any displayed event in the table to display a new tab with information about the affected system or policy.
However, if you select a real-time value from the Timestamp field, the displayed events do not respond when clicked. This is a limitation in Splunk. Splunk recommends that you avoid clicking real-time events to view event details.
A.3. Troubleshooting Hybrid Cloud Console integration with ServiceNow
If ServiceNow is not receiving events from the Red Hat Hybrid Cloud Console, verify the configuration:
-
Ensure that the integration in the Red Hat Hybrid Cloud Console is enabled and has type
ServiceNow
. -
Ensure that the integration in the Red Hat Hybrid Cloud Console has a correct URL. The URL should start with
https://<instance.servicenow.com>/api/x_rhtpp_rh_webhook/flow_templates_for_red_hat_insights
. -
Ensure that the
x_rhtpp_rh_webhook.rest
user role is defined in ServiceNow. Otherwise, notifications from the Hybrid Cloud Console will not work even if the application has been installed correctly. -
Ensure that the
rh_insights_integration
ServiceNow user exists, is active, and has thex_rhtpp_rh_webhook.rest
role assigned. -
If necessary, reset the password for the
rh_insights_integration
ServiceNow user, and reset the user password in the integration on the Red Hat Hybrid Cloud Console.
Additional resources
- For more troubleshooting information, see link: Troubleshooting notification failures with the event log and integration settings.
A.4. Additional resources
- For more troubleshooting information, see link: Troubleshooting notification failures with the event log and integration settings.
Providing feedback on Red Hat documentation
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.
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.