Chapter 2. Integrating reporting and automation applications with the Hybrid Cloud Console

Procedure

1. Install the Red Hat Insights Application for Splunk:

   1. Log in to Splunk.
   2. On the home page, search for Red Hat Insights in the filter box and select it.
   3. Click Install. When the installation process completes, the message Install successful displays.
   4. On the home page, click the Settings menu (gear icon). The Apps page opens.
   5. Enter Red Hat Insights in the filter box and then click the magnifying glass. The application appears in the search results.
   6. On the home page, click Find more apps under the Apps heading on the left of the screen. The Browse More Apps page opens.
   7. Enter Red Hat Insights in the filter box and then press the Enter key. Red Hat Insights appears in the search results.
   8. Select Red Hat Insights.
   9. Click Install.
   10. Confirm or enter your Splunk username and password and then click Agree and Install. When the installation process completes, the Complete dialog box opens.

2. Set up the Red Hat Insights Application for Splunk:

   1. In the Complete dialog box, click Open the App. The App configuration page opens.

   2. 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.

      

   3. Under Create Red Hat Default Index, click Settings > Index.The Indexes page opens in a new tab.
   4. On the Indexes page, click New Index.
   5. Type a name for the index in the Name field (for example, redhatinsights).
   6. Enter values in the Max raw data size and Searchable retention (days) field.
   7. Click Save. The index you created appears in the Indexes list. It is enabled by default.
   8. 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).
   9. Type the name of the index you just created in the Default index field (for example, redhatinsights).
   10. Click Next.
   11. Click Review and then click Submit. The HEC name that you created appears in the HEC Name field.

   12. Click Next to create the HEC URL and HEC Token.

       

3. Configure Splunk integration in Insights:

   1. Click Copy to copy the HEC URL value in Splunk Enterprise.

   2. Click Next: 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.

   3. In the Hybrid Cloud Console, navigate to Settings > Integrations.
   4. Click the Reporting & Automation tab.
   5. Click Add Integration.
   6. Click Splunk and then click Next.
   7. Enter a name for the integration (for example, SPLUNK_INTEGRATION).
   8. Paste the HEC URL value into the Endpoint URL field.

   9. 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.

   10. 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.

       

   11. 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>

       • Use the following format for Splunk Cloud Platform on Google Cloud Platform (GCP):

         <protocol>://http-inputs.<host>.splunkcloud.com:<port>

         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:

         https://http-inputs.myhost.splunkcloud.com:443

       • Splunk Cloud free trial on AWS using raw events:

         https://http-inputs-otherhost.splunkcloud.com:443

4. Complete the setup process:

   1. Copy the HEC Token value in Splunk and paste it into the Splunk HEC Token field in on the Hybrid Cloud Console Integrations page.

   2. 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.

      

   3. When the setup completes successfully, click Next: Review. The application returns the message Splunk integration in Insights completed.

      

   4. Click Go back to the Splunk application. This redirects you to the Set up integration with Red Hat screen in Splunk.

   5. Click Finish set up to complete the setup in Splunk.

      

   6. 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.

5. 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.

   

Procedure

1. From the Splunk home page, navigate to Settings.

2. 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.

   

3. Click Global Settings in the upper right corner of the page. The Edit Global Settings dialog box displays.

   

4. 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.

Procedure

1. Click Settings > Identity & Access Management.
2. Under Identity & Access Management, expand User Access if necessary, and select Groups.
3. Click Create group. The Name and description page appears.
4. Enter a name for the group (for example, splunknotifgroup), enter a description, and then click Next. The Add roles page opens.
5. To add the Notifications administrator role, enter notif in the search box.
6. Select Notifications administrator from the search results list, and then click Next. The Add Members page opens.
7. Select the users to add to this group. You can use the search box to search for specific names.
8. Click Next. The Review Details page opens.
9. Review the information, and then click Submit to create the group.
10. Click Exit. The Groups page opens.

Verification

1. Enter the new group name in the search box.
2. Click the group name. The page for the group opens.
3. On the Roles tab, verify that the group has the Notifications administrator role.
4. Click the Members tab and verify that the group includes the correct members.

Procedure

1. In the Hybrid Cloud Console, navigate to Settings > Integrations.
2. Select the Reporting & Automation tab.
3. Click Add integration.
4. Select Splunk as the integration type, and then click Next.
5. Enter a name for your new integration in the Integration name field (for example, redhat_splunk).

6. In the Endpoint URL field, add your Splunk HEC endpoint URL:

   1. For Splunk Enterprise, Splunk uses port 8088 by default. For example: https://<splunk-endpoint>:8088

   2. 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
7. In the Secret token field, add the Splunk HEC token value.
8. Click Next.
9. Review the integration details and click Submit.

Procedure

1. Log in to your ServiceNow instance.

2. 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).

     1. Create a new user with User ID rh_insights_integration.
     2. Check Internal Integration User for the user you just created.
     3. Ensure that the user is Active.
     4. Assign role x_rhtpp_rh_webhook.rest to the user.
     5. Generate a password for the user. Copy this information for use during the setup process.
3. Open the Hybrid Cloud Console in a new browser window or tab.

4. Navigate to Settings > Integrations, select the Reporting & Automation tab, and complete the following steps:

   1. Click Add integration.
   2. Select ServiceNow as the integration type, and then click Next.
   3. Enter a name for the integration, such as ServiceNow integration.

   4. 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

   5. The checkbox to Enable SSL is checked by default.
   6. In the Secret token field, paste the generated password of the rh_insights_integration user that you created in ServiceNow.

5. 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.

   1. Select a product family, for example OpenShift, Red Hat Enterprise Linux, or Console.
   2. Select the event types you would like your integration to react to.
6. To enable the integration, review the integration details and click Submit.
7. 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.

Procedure

1. In your Ansible Automation Platform 2.5 environment, navigate to Automation Decisions > Infrastructure > Credentials.
2. On the Credentials page, click Create credential.
3. On the Create credential page, enter a name for the credential, for example Red Hat Insights.
4. Select the Organization type, and then select Token Event Stream under Credential type.

5. 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.

6. Enter X-Insight-Token under HTTP Header Key.
7. Click Save credential.
8. Navigate to Automation Decisions > Event Streams and click Create event stream.
9. On the Create event stream page, enter a name for the event stream, for example Red Hat Insights event stream.
10. Select your organization under Organization.
11. Select Token Event Stream under Event stream type.
12. Select the credential that you created, for example Red Hat Insights.
13. Click Create event stream.
14. 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.

15. Import an Ansible rulebook from your Github repository:

    1. To create an Ansible project, navigate to Red Hat Ansible Automation Platform > Automation Decisions > Projects.
    2. On the Create project page, enter a name for the project, for example Insights.
    3. Under Source control URL, paste the URL for the Github repository that contains your Red Hat Insights rulebook and then click Create project.
    4. To activate your Insights rulebook, navigate to Red Hat Ansible Automation Platform > Automation Decisions > Rulebook Activations and click Create rulebook activation.
    5. Enter a name for your activation, for example Insights rulebook.
    6. Under Organization, select your organization.
    7. Under Project, select Insights.
    8. Under Rulebook, select a rulebook from the list.
    9. Select the gear icon next to Event streams and select the event stream that you created.
    10. Under Descision enviroment, select Default Decision Environment and then click Create rulebook activation. The rulebook page appears.
    11. Wait for the activation status to change to Running.
16. In the Hybrid Cloud Console, navigate to Settings > Integrations.
17. Select the Reporting & Automation tab.
18. Click Add integration.
19. Select Event-Driven Ansible as the integration type, and then click Next.
20. In the Integration name field, enter a name for your integration (for example, My EDA Integration).
21. 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.

22. 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.

23. Click Next.
24. Review the integration details, and then click Submit to enable the integration.

1. Next to your Event-Driven Ansible integration on the Integrations > Reporting & Automation page, click the options icon (⋮) and click Test.
2. 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.
3. In Ansible Automation Platform with Event-Driven Ansible, navigate to Automation Decisions > Event Streams.
4. On the Details tab of your event stream, confirm that the number under Events received has increased.
5. 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.

Procedure

1. In the Hybrid Cloud Console, navigate to Settings > Notifications.
2. Under Notifications, select Configure Events.
3. Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, or OpenShift.
4. Click the Behavior Groups tab.
5. Click Create new group to open the Create behavior group wizard.
6. Type a name for the behavior group and click Next.
7. In the Actions and Recipients step, select Integration: Event-Driven Ansible from the Actions drop-down list.
8. From the Recipient drop-down list, select the name of the integration you created (for example, My EDA Listener) and click Next.
9. 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.
10. Review your behavior group settings and click Finish. The new behavior group appears on the Notifications page.

Verification

1. 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.

2. 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.

Procedure

1. On the PagerDuty home page, click Services.
2. Click New Service. The Create a Service wizard opens.
3. Enter a name and description for the new service, for example Red Hat PagerDuty Service, and then click Next.
4. Either select an existing escalation policy, or generate a new one, and then click Next.
5. On the Reduce Noise screen, make any desired selection and then click Next.
6. On the Create a Service screen, select the Events API V2 integration and then click Create Service.
7. If necessary, on the Integrations page, click the arrow next to Events API V2 to expand the panel.
8. Copy the integration key next to Events API v2 Overview. You will use this key to integrate the service with the Hybrid Cloud Console.

Procedure

1. On the PagerDuty home page, click Services.
2. Select the service that you want to generate the integration key for.
3. Select the Integrations tab and click Add another integration.
4. On the Add Integrations screen, select the Events API V2 integration and then click Add.
5. If necessary, click the arrow next to Events API V2 to expand the panel.
6. Copy the integration key next to Events API v2 Overview. You will use this key to integrate the service with the Hybrid Cloud Console.

Procedure

1. Go to Settings > Integrations.
2. Select the Reporting & Automation tab.
3. Click Add integration to open the Add integration wizard. If this is the first integration you are adding, skip this step.
4. Select PagerDuty, and then click Next.
5. Enter a descriptive name for the integration, for example, PagerDuty Integration.
6. 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.
7. Specify an alert severity.
8. Click Next.

9. 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.

   1. Select a product family, for example OpenShift, Red Hat Enterprise Linux, or Console.
   2. Select the event types you would like your integration to react to.
10. To enable the integration, review the integration details and click Submit.
11. 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.

1. Go to the Integrations page, and select the Reporting & Automation tab.
2. Confirm that your PagerDuty integration is listed and the status is Ready.
3. Next to your PagerDuty integration, click the options icon (⋮) and click Test.
4. 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.
5. Open your PagerDuty instance and check for the message sent from the Hybrid Cloud Console.
6. In the Hybrid Cloud Console, go to Notifications > Event Log and check that the Integration: PagerDuty event is listed with a green label.

Procedure

1. In the Hybrid Cloud Console, navigate to Settings > Notifications.
2. Under Notifications, select Configure Events.
3. Select the application bundle tab you want to configure event notification behavior for: Red Hat Enterprise Linux, Console, or OpenShift.
4. Click the Behavior Groups tab.
5. Click Create new group to open the Create behavior group wizard.
6. Type a name for the behavior group and click Next.
7. In the Actions and Recipients step, select Integration: PagerDuty from the Actions drop-down list.
8. From the Recipient drop-down list, select the name of the integration you created (for example, PagerDuty Integration) and click Next.
9. 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.
10. Review your behavior group settings and click Finish. The new behavior group is listed on the Notifications page.

Verification

1. 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.
2. Wait a few minutes, and then navigate to PagerDuty.
3. In your PagerDuty account, check for notifications from the Hybrid Cloud Console.

4. 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.
5. 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.