Chapter 2. Integrating reporting and automation applications with the Hybrid Cloud Console
Chapter 2. Integrating reporting and automation applications with the Hybrid Cloud Console Receive and manage event notifications where you manage other sources of data by connecting the Hybrid Cloud Console with Splunk, ServiceNow, or Event-Driven Ansible. 2.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 the admin role, see Create secure administration credentials in the Splunk documentation. You have Organization Administrator permissions for the Hybrid Cloud Console. 2.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 the admin role, see Create secure administration credentials in the Splunk documentation. 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 . Click Review and then click Submit . The HEC name that you created appears in the HEC Name field. Click 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 : Configure Splunk integration in Insights . The Hybrid Cloud Console opens in a new browser tab. Note This 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 . Click the Reporting & Automation tab. Click Add Integration . Click Splunk and then click . Enter a name for the integration (for example, SPLUNK_INTEGRATION ). Paste the HEC URL value into the Endpoint URL field. Enter the Splunk HTTP event collector token in the Secret token field. Note If 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): Use the following format for Splunk Cloud Platform on Google Cloud Platform (GCP): Replace the following placeholders: protocol : Either http or https . 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). Examples: Splunk Cloud Platform on GCP using JSON: Splunk Cloud free trial on AWS using raw events: 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 : 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. Note If 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 2.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 the admin role, see Create secure administration credentials in the Splunk documentation. 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. Note The 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. 2.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 then click . 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 then click . 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 . The Review Details page opens. Review the information, and then 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. 2.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. Your Splunk instance has an SSL certificate that is signed by a globally trusted certificate authority (CA). 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 then click . 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 . Note The service automatically adds <endpoint> (the http 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 In the Secret token field, add the Splunk HEC token value. Click . 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. 2.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 . 2.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.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), or sn_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. 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 then click . 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. Optional: Associate events with the integration. Doing this automatically creates a behavior group. Note You can skip this step and associate the event types later. Select a product family, for example OpenShift , Red Hat Enterprise Linux , or Console . Select the event types you would like your integration to react to. To enable the integration, review the integration details and click Submit . Refresh the Integrations page to show the ServiceNow integration in the Integrations > Reporting & Automation list. Under Last connection attempt , the status is Ready to show the connection can accept notifications from the Hybrid Cloud Console. Verification To confirm that the application has been configured successfully, view the event log on the Red Hat Hybrid Cloud Console, and view Flow Executions on your ServiceNow instance ( Process Automation > Flow Administration > Today's Executions ). 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. Note If the integration configuration fails during the Insights setup process, contact Red Hat support. 2.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 . 2.3. 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 . 2.3.1. Configuring Event-Driven Ansible 2.5 for integration with the Red Hat Hybrid Cloud Console You can configure Event-Driven Ansible 2.5 to receive event notifications from the Red Hat Hybrid Cloud Console or a third-party application. Prerequisites You have an environment with Ansible Automation Platform and Event-Driven Ansible 2.5 installed. You have Organization Administrator or Notifications administrator permissions for the Hybrid Cloud Console. You have a Github repository that contains at least one rulebook that uses the Insights EDA collection as a source. For examples, see Event-Driven Ansible for Red Hat Insights . Procedure In your Ansible Automation Platform 2.5 environment, navigate to Automation Decisions > Infrastructure > Credentials . On the Credentials page, click Create credential . On the Create credential page, enter a name for the credential, for example Red Hat Insights . Select the Organization type, and then select Token Event Stream under Credential type . Enter a token and copy it. The token value is used for token authentication between the Hybrid Cloud Console and your Ansible Automation Platform with Event-Driven Ansible. Note The token value can be any random string of characters, including uppercase or lowercase letters, numbers, and symbols. You can find token generators on the web. Enter X-Insight-Token under HTTP Header Key . Click Save credential . Navigate to Automation Decisions > Event Streams and click Create event stream . On the Create event stream page, enter a name for the event stream, for example Red Hat Insights event stream . Select your organization under Organization . Select Token Event Stream under Event stream type . Select the credential that you created, for example Red Hat Insights . Click Create event stream . On the Details tab of your event stream page, copy the event stream endpoint URL. This URL is used when setting up your Event-Driven Ansible integration in the Hybrid Cloud Console. Import an Ansible rulebook from your Github repository: To create an Ansible project, navigate to Red Hat Ansible Automation Platform > Automation Decisions > Projects . On the Create project page, enter a name for the project, for example Insights . Under Source control URL , paste the URL for the Github repository that contains your Red Hat Insights rulebook and then click Create project . To activate your Insights rulebook, navigate to Red Hat Ansible Automation Platform > Automation Decisions > Rulebook Activations and click Create rulebook activation . Enter a name for your activation, for example Insights rulebook . Under Organization , select your organization. Under Project , select Insights . Under Rulebook , select a rulebook from the list. Select the gear icon to Event streams and select the event stream that you created. Under Descision enviroment , select Default Decision Environment and then click Create rulebook activation . The rulebook page appears. Wait for the activation status to change to Running . 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 . In the Integration name field, enter a name for your integration (for example, My EDA Integration ). Enter the event stream URL that you copied earlier into the Endpoint URL field. This is the endpoint that points to the Event-Driven Ansible listener. This endpoint URL must be accessible for the Hybrid Cloud Console to send HTTP POST events. You might need to configure your network access or firewall, or both, to accept HTTP POST events from the Hybrid Cloud Console. Enter the secret token that you created earlier. 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. Click . 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: 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 Ansible Automation Platform with Event-Driven Ansible, navigate to Automation Decisions > Event Streams . On the Details tab of your event stream, confirm that the number under Events received has increased. 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. 2.3.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 as described in Section 2.3.1, "Configuring Event-Driven Ansible 2.5 for integration with the Red Hat 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 . 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 . 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 . 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. For example, you can run the insights client command on a registered system to trigger a new recommendation event from Advisor. To validate that the Hybrid Cloud Console integration was successful, in the Hybrid Cloud Console, go to Settings > Notifications > Event Log and check that the last event that you triggered shows the label Integrations: Event-Driven Ansible . If the label is green, the notification succeeded. If the label is red, verify that the stream has been properly created and exposed in Event-Driven Ansible, and that the correct stream URL is configured in the Hybrid Cloud Console integration configuration. Note See Troubleshooting notification failures in the notifications documentation for more details. 2.3.3. Additional resources For more information about Event-Driven Ansible and how to configure and use the event-driven controller, see Using automation decisions . 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 . 2.4. Integrating PagerDuty with the Red Hat Hybrid Cloud Console You can configure the Red Hat Hybrid Cloud Console to send event notifications to a PagerDuty service. The PagerDuty integration supports events from all Hybrid Cloud Console services. When an issue in the Hybrid Cloud Console is detected, PagerDuty automatically notifies the appropriate team members through phone calls, SMS, emails, or push notifications. PagerDuty uses scheduling to ensure team members are alerted only during their designated times. You can create escalation policies to escalate an issue to another team member if the first on-call team member does not respond to the alert. PagerDuty also provides incident management features for a coordinated response to resolve issues. Contacting Support If you have any issues with the Hybrid Cloud Console integration with PagerDuty, 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 . PagerDuty will not provide troubleshooting. The Hybrid Cloud Console integration with PagerDuty is fully supported by Red Hat. 2.4.1. Creating a PagerDuty service Create a PagerDuty service that you will integrate with the Hybrid Cloud Console so that your organization will receive notifications about the Hybrid Cloud Console. Note If you already have a PagerDuty service that you want to integrate with the Hybrid Cloud Console, see Section 2.4.2, "Generating an integration key for an existing PagerDuty service" . Prerequisites You are logged in to PagerDuty. At least one PagerDuty team exists. Procedure On the PagerDuty home page, click Services . Click New Service . The Create a Service wizard opens. Enter a name and description for the new service, for example Red Hat PagerDuty Service , and then click . Either select an existing escalation policy, or generate a new one, and then click . On the Reduce Noise screen, make any desired selection and then click . On the Create a Service screen, select the Events API V2 integration and then click Create Service . If necessary, on the Integrations page, click the arrow to Events API V2 to expand the panel. Copy the integration key to Events API v2 Overview . You will use this key to integrate the service with the Hybrid Cloud Console. steps To integrate your PagerDuty service with the Hybrid Cloud Console, see Section 2.4.3, "Adding a PagerDuty account as an integration" . Additional resources For more information about creating a PagerDuty service, see Create a Service in the PagerDuty Knowledge Base. 2.4.2. Generating an integration key for an existing PagerDuty service You can add an integration key to an existing PagerDuty service so that you can integrate the service with the Hybrid Cloud Console. After you integrate the service, the Hybrid Cloud Console will send notifications to that PagerDuty service. Note For information about creating a new PagerDuty service to integrate with the Hybrid Cloud Console, see Section 2.4.1, "Creating a PagerDuty service" . Prerequisites You are logged in to PagerDuty. At least one PagerDuty service exists. At least one PagerDuty team exists. Procedure On the PagerDuty home page, click Services . Select the service that you want to generate the integration key for. Select the Integrations tab and click Add another integration . On the Add Integrations screen, select the Events API V2 integration and then click Add . If necessary, click the arrow to Events API V2 to expand the panel. Copy the integration key to Events API v2 Overview . You will use this key to integrate the service with the Hybrid Cloud Console. steps To integrate your PagerDuty service with the Hybrid Cloud Console, see Section 2.4.3, "Adding a PagerDuty account as an integration" . Additional resources For information about adding an integration key, see Add Integrations to an Existing Service in the PagerDuty Knowledge Base. 2.4.3. Adding a PagerDuty account as an integration You can connect your PagerDuty account to the Red Hat Hybrid Cloud Console as an integration so that the Hybrid Cloud Console sends event notifications to a PagerDuty service through phone calls, SMS, emails, or push notifications. Prerequisites You are logged in to the Red Hat Hybrid Cloud Console as an Organization Administrator or as a user with Notifications administrator permissions. You have a PagerDuty integration key. For information about generating an integration key, see one of the following sections: Section 2.4.1, "Creating a PagerDuty service" Section 2.4.2, "Generating an integration key for an existing PagerDuty service" Procedure Go to Settings > Integrations . Select the Reporting & Automation tab. Click Add integration to open the Add integration wizard. If this is the first integration you are adding, skip this step. Select PagerDuty , and then click . Enter a descriptive name for the integration, for example, PagerDuty Integration . Enter the integration key for the PagerDuty account you are integrating. See Section 2.4.1, "Creating a PagerDuty service" for information about creating an integration key. Specify an alert severity. Click . Optional: Associate events with the integration. Doing this automatically creates a behavior group. Note You can skip this step and associate the event types later. Select a product family, for example OpenShift , Red Hat Enterprise Linux , or Console . Select the event types you would like your integration to react to. To enable the integration, review the integration details and click Submit . Refresh the Integrations page to show the PagerDuty integration in the Integrations > Reporting & Automation 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 PagerDuty to the Hybrid Cloud Console: Go to the Integrations page, and select the Reporting & Automation tab. Confirm that your PagerDuty integration is listed and the status is Ready . to your PagerDuty integration, 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 PagerDuty instance 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: PagerDuty 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. 2.4.4. Creating the behavior group for the PagerDuty integration A behavior group defines which notifications will be sent to external services such as PagerDuty 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 PagerDuty 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 . In the Actions and Recipients step, select Integration: PagerDuty from the Actions drop-down list. From the Recipient drop-down list, select the name of the integration you created (for example, PagerDuty Integration ) and click . 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 . 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 PagerDuty. In your PagerDuty account, 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: PagerDuty . 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 Events API v2 integration key was properly created in PagerDuty, and that the correct incoming integration key is added in the Hybrid Cloud Console integration configuration. Note See Troubleshooting notification failures in the notifications documentation for more details.
<protocol>://http-inputs-<host>.splunkcloud.com:<port> <protocol>://http-inputs.<host>.splunkcloud.com:<port> https://http-inputs.myhost.splunkcloud.com:443 https://http-inputs-otherhost.splunkcloud.com:443