Skip to content

Commit

Permalink
created slack quick start for integrations
Browse files Browse the repository at this point in the history
  • Loading branch information
@dayleparker
dayleparker committed Apr 3, 2024
1 parent fe2de61 commit 4e116c5
Showing 1 changed file with 46 additions and 71 deletions.
117 changes: 46 additions & 71 deletions docs/quickstarts/integrations-slack-notifs-qs/integrations-slack-notifs-qs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
# - If set to null (icon: ~) will not show an icon
icon: ~
prerequisites:
- Notifications administrator permissions (included in the Default admin access group) for the Hybrid Cloud Console.
- Notifications administrator permissions (included in the Default admin access group) for the console.
- Owner or admin permissions to the Slack instance where you want to add incoming webhooks.
- App Manager permissions to add Slack apps to a channel.
- A Slack channel to receive notifications.
Expand All @@ -31,18 +31,18 @@ spec:
You can configure the console to send event notifications to various third-party applications, including Slack. You can send notifications to all users on a Slack channel, or a selected user in Slack.
This quick start shows you how to configure a Slack channel to receive event notifications about a new User Access group being created. You'll also learn how to validate your configuration by sending a test event.
Follow this quick start to configure a Slack channel to receive event notifications when a new User Access group is created in the console. You'll also learn how to validate your configuration by sending a test event.
[If you have any issues with the Hybrid Cloud Console integration with Slack, contact Red Hat for support.]{{admonition note}}
tasks:
- title: Configuring Slack to receive incoming webhooks
- title: Configure Slack to receive incoming webhooks
description: |-
The Slack integration uses incoming webhooks to receive event data.
To prepare Slack for integration with the console, you need to first configure incoming webhooks in Slack.
To prepare Slack for integration with the console, configure incoming webhooks in Slack.
You will complete these steps in Slack.
You'll complete these steps in Slack.
1. In Slack, open the channel where you want to receive notifications.
Expand All @@ -51,27 +51,23 @@ spec:
3. Click **Integrations**, then under **Apps**, click **Add an App**.
4. Search for *Incoming WebHooks*, and then select it from the search results.
4. Search for the *Incoming WebHooks* app and select it.
5. Click **Add to Slack** to add the Hybrid Cloud Console integration to the channel. The **Post to Channel** box opens.
5. Click **Add to Slack** to add the Hybrid Cloud Console integration to the channel.
6. Perform one of the following tasks:
- To select an existing channel, click the **Choose a Channel** drop-down menu or type the user or channel name in the field.
- To create a new channel, click or create a new channel, type the name of the new channel and an optional description, and click **Create**.
6. Select an existing channel or create a new channel in the **Post to Channel** box.
7. Click **Add Incoming Webhooks Integration**. The **Configuration** page for the app opens in the Slack app directory.
8. Scroll down to **Integration Settings**. The generated webhook URL appears in the **Webhook URL** field.
8. Scroll down to **Integration Settings** and copy the generated webhook URL shown in the **Webhook URL** field.
9. Copy the URL displayed in the field. You will use it to set up the integration in the Hybrid Cloud Console.
9. (Optional) Customize your integration:
10. Optional: Add a name for the integration in the **Customize Name** field.
a. Add a name for the integration in the **Customize Name** field.
11. Optional: Upload an icon in the **Customize Icon** field.
b. Upload an icon in the **Customize Icon** field.
12. Click **Save Settings**.
10. Click **Save Settings**.
Your Slack channel is now ready to receive incoming notifications from the console.
Expand All @@ -81,61 +77,43 @@ spec:
- [Sending messages using incoming webhooks](https://api.slack.com/messaging/webhooks)
- For general help with Slack, see the [Slack Help Center](https://slack.com/help).
# optional - the task's Check your work module
review:
instructions: |-
- NEED STEP TO CHECK THAT EVERYTHING'S GOOD
failedTaskHelp: Try completing the steps again.
# optional - the task's success and failure messages
summary:
success: Shows a success message in the task header
failed: Shows a failed message in the task header
- title: Configuring Slack integration in the Hybrid Cloud Console
- title: Add the Slack integration to the Hybrid Cloud Console
description: |-
Now that you’ve configured your Slack channel for incoming webhooks, configure the console to send event notifications to that Slack channel.
You will complete these steps in the Hybrid Cloud Console.
You'll complete these steps in the Hybrid Cloud Console.
1. From **Integrations**, select the **Communications** tab.
1. Click **Integrations** > **Communications**.
2. Click **Add integration**.
3. Select **Slack** and click **Next**.
4. Add details for your Slack integration:
4. Configure your Slack integration details:
a. In **Integration name**, enter a name. You can include your Slack channel name if desired. (for example, *My Slack notifications (#my_channel)*)
a. In **Integration name**, enter a name such as *My Slack notifications (#my_channel)*. You can include your Slack channel name if desired.
b. In **Workspace URL**, paste the URL that you copied from the Webhook URL field in Slack.
b. In **Workspace URL**, paste the webhook URL that you copied from Slack.
c. In **Channel**, enter the name of your Slack channel that you configured.
d. Click **Next**.
e. Review the integration details and click **Submit**.
5. Review the integration details and click **Submit**.
6. If needed, refresh your browser window to show your Slack integration on the **Integrations** > **Communications** page.
Your Slack integration is now listed on the **Integrations** > **Communications** page. Under **Last connection attempt**, the status will be **Ready** to show the connection can accept notifications from the console.
5. If needed, refresh your browser window to show your Slack integration on the **Integrations** > **Communications** page.
You can now create a test notification to confirm you have correctly connected your Slack channel to your integration in the console:
To confirm you've correctly connected your Slack channel to the console, you can create a test notification:
1. Next to your Slack integration in the list, click : (options) > **Test**.
2. In the **Integration Test** screen, enter a message and click **Send**. If you leave the field empty, the console sends a default message.
3. Go to your Slack channel - if configured correctly, your message will show up in Slack.
1. Next to your Slack integration in the list, click ⋮ > **Test**.
2. Enter a message in the **Integration Test** screen, and click **Send**. If you leave the field empty, the console sends a default message.
3. In your Slack channel, check for your message.
Now that you’ve validated your integration, all events you configure in the next step will be forwarded to Slack. Next, you’ll select which notifications to send to Slack.


# To learn more, see: Do we need any links here? Integrations guide maybe?
# - The [Red Hat Insights documentation](https://access.redhat.com/documentation/en-us/red_hat_insights/1-latest/html/assessing_and_reporting_malware_signatures_on_rhel_systems/index) for more about using the malware detection service in the console.

# optional - the task's Check your work module
review:
instructions: |-
- Did you receive a test message in your Slack channel?
- In the console, check **Notifications** > **Event log** for the test event. Does the **Event log** show an event called **Integration Test** with **Integration: Slack** showing in a green label in the Action taken column?
- In the console, check **Notifications** > **Event log** for the event called **Integration Test**. Does **Integration: Slack** show in a green label?
failedTaskHelp: Try completing the steps again.
Expand All @@ -144,35 +122,32 @@ spec:
success: Shows a success message in the task header
failed: Shows a failed message in the task header

- title: Selecting notifications to send to Slack
- title: Select notifications to send to Slack
description: |-
The last step is to configure which event notifications to send to your Slack channel. You’ll configure this in the Hybrid Cloud Console Settings as well.
To do this, you’ll create a new behavior group and select the events you want to be notified about. Alternatively, if you have an existing behavior group, you can edit that group and add the notifications to that group to send to Slack.
Next, configure which event notifications to send to your Slack channel.
1. In Settings, click **Notifications** > **Configure Events**.
To do this, create a new behavior group in the console and select the events you want to be notified about. For this example, you'll configure notifications for when a new User Access group is created in the console.
2. Select the application bundle tab to find the related service(s) you want to receive notifications for: **Red Hat Enterprise Linux**, **Console**, or **OpenShift**.
[Alternatively, you can add events to an existing behavior group to be notified of. To edit a behavior group, see [Configure notification behavior groups](https://access.redhat.com/documentation/en-us/red_hat_hybrid_cloud_console/1-latest/html-single/configuring_notifications_on_the_red_hat_hybrid_cloud_console/index#assembly-config-behavior-groups_notifications) for more information.]{{admonition note}}
3. Click the **Behavior Groups** tab to add the new endpoint to a new behavior group.
[You can also edit an existing behavior group instead of creating a new one. See [Configure notification behavior groups](https://access.redhat.com/documentation/en-us/red_hat_hybrid_cloud_console/1-latest/html-single/configuring_notifications_on_the_red_hat_hybrid_cloud_console/index#assembly-config-behavior-groups_notifications) for more information.]{{admonition note}}
1. Click **Notifications** > **Configure Events**.
4. Click **Create new group**.
2. Select the application bundle tab to find the related service(s) you want to receive notifications for: **Red Hat Enterprise Linux**, **Console**, or **OpenShift**. For this example, select **Console** > **Behavior Groups** .
a. Add details for your behavior group:
3. Click **Create new group**:
b. In **Behavior group name**, enter a name (for example,* Default behavior*), and click **Next**.
a. In **Behavior group name**, enter a name (for example, *Default behavior*), and click **Next**.
c. In the **Actions** column, select **Integration: Slack**.
b. In **Actions**, select **Integration: Slack**.
d. From the **Recipient** drop-down list, select the integration you configured earlier in the console, and click **Next**.
c. In **Recipient**, select your Slack integration and click **Next**.
e. In the **Associate event types** screen, select the event types for which you want notifications. For this example, select the **Group created** event, and click **Next**.
d. In **Associate event types**, select the event type(s) you want to be notified about. For this example, select **Group created**, and click **Next**.
f. Review your behavior group settings, and click **Finish**.
e. Review your settings and click **Finish**.
5. Trigger an event in the console to test the configuration. For this example, you’ll create a new User Access group that you’ll be notified of in Slack. An event will be triggered when you create a new group.
5. Trigger an event in the console to test the configuration. For this example, you’ll create a new User Access group to be notified of in Slack.
a. Go to **Settings** > **User Access**.
Expand All @@ -194,23 +169,23 @@ spec:
# optional - the task's Check your work module
review:
instructions: |-
- In Slack: Did you receive a message in your Slack channel about the creation of the new User Access group?
- Did you receive a message in your Slack channel about the new User Access group?
- In the console: Go to **Settings** > **Notifications** > **Event log** and find the **Group created** event. Does **Integration: Slack** show in the **Action taken** column with a green label? (You can click on this label to view details about the notification.)
- In the console: Go to **Settings** > **Integrations** > **Communications** and check your integration in the list. Does the status in Last connection attempt report **Success**?
# - In the console: Go to **Settings** > **Integrations** > **Communications** and check your integration in the list. Does the status in Last connection attempt report **Success**?


failedTaskHelp: If you see a red label in **Action taken** in the **Event Log**, check your configuration and create another test event to verify the configuration.
failedTaskHelp: If you see a red label in **Action taken** in the console **Event Log**, check your configuration and create another test event to verify the configuration.
# optional - the task's success and failure messages
summary:
success: Shows a success message in the task header
failed: Shows a failed message in the task header

conclusion: |-
Congratulations! You’ve successfully configured the Hybrid Cloud Console to send notifications about selected events to your Slack channel.
Congratulations! You’ve successfully configured the console to send notifications about selected events to your Slack channel.
From here:
- You can add more events to be notified about in your Slack channel by editing your behavior group from **Notifications** > **Configure Events** and assigning it more events.
- You can configure additional Slack channels to be notified of other events by creating additional Slack integrations. For example, your organization may want to send certain types of notifications to different Slack channels based on your teams or security policies.
- You can configure additional Slack channels to receive additional event notifications by creating additional Slack integrations. For example, your organization may want to send certain types of notifications to different Slack channels based on your teams or security policies.
**Learn more:**
- To learn about other applications where you can receive console notifications, see [Integrating the Red Hat Hybrid Cloud Console with third-party applications](https://access.redhat.com/documentation/en-us/red_hat_hybrid_cloud_console/1-latest/html-single/integrating_the_red_hat_hybrid_cloud_console_with_third-party_applications/index#assembly-configuring-insights-integration-with-slack_integrations).
Expand Down

0 comments on commit 4e116c5

Please sign in to comment.