From a9acc4c5b28e2433bf6512b69c1e0705c204b6d4 Mon Sep 17 00:00:00 2001 From: Alyssa Wada <101596687+alyssawada@users.noreply.github.com> Date: Thu, 12 Dec 2024 16:10:30 -0700 Subject: [PATCH] docs: clarify MS Teams connect steps and limitations (#5361) # What this PR does Addressing a couple of docs support escalations related to the MS teams integration. ## Which issue(s) this PR closes https://github.com/grafana/support-escalations/issues/13489 ## Checklist - [ ] Unit, integration, and e2e (if applicable) tests updated - [ ] Documentation added (or `pr:no public docs` PR label added if not required) - [ ] Added the relevant release notes label (see labels prefixed w/ `release:`). These labels dictate how your PR will show up in the autogenerated release notes. --- docs/sources/manage/notify/ms-teams/index.md | 29 +++++++++++++------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/sources/manage/notify/ms-teams/index.md b/docs/sources/manage/notify/ms-teams/index.md index e6fd9bd7..b62715e6 100644 --- a/docs/sources/manage/notify/ms-teams/index.md +++ b/docs/sources/manage/notify/ms-teams/index.md @@ -23,6 +23,10 @@ aliases: # MS Teams integration for Grafana OnCall +{{< admonition type="note" >}} +This integration is available exclusively on Grafana Cloud. +{{< /admonition >}} + The Microsoft Teams integration for Grafana OnCall embeds your MS Teams channels directly into your incident response workflow to help your team focus on alert resolution. @@ -32,33 +36,38 @@ acknowledge, unacknowledge, resolve, and silence. ## Before you begin -> NOTE: **This integration is available to Grafana Cloud instances of Grafana OnCall only.** - The following is required to connect to Microsoft Teams to Grafana OnCall: - You must have Admin permissions in your Grafana Cloud instance. - You must have Owner permissions in Microsoft Teams. - Install the Grafana IRM app from the [Microsoft Marketplace](https://appsource.microsoft.com/en-us/product/office/WA200004307). -## Install Microsoft Teams integration for Grafana OnCall +## Connect Microsoft Teams with Grafana OnCall -1. Navigate to **Settings** tab in Grafana OnCall. +{{< admonition type="note" >}} +A Microsoft Teams workspace can only be connected to one Grafana Cloud instance and cannot be connected to multiple environments. +{{< /admonition >}} + +To connect Microsoft Teams with Grafana OnCall: + +1. In Grafana OnCall, open **Settings** and click **Chat Ops**. 1. From the **Chat Ops** tab, select **Microsoft Teams** in the side menu. -1. Follow the steps provided to connect to your Teams channels, then click **Done**. -1. To add additional teams and channels click **+Add MS Teams channel** again and repeat step 3 as needed. +1. Follow the in-app instructions to add the Grafana IRM app to your Teams workspace. +1. After your workspace is connected, copy and paste the provided code into a Teams channel to add the IRM bot, then click **Done**. +1. To add additional channels click **+Add MS Teams channel** and repeat step 3 as needed. ## Post-install configuration for Microsoft Teams integration Configure the following settings to ensure Grafana OnCall alerts are routed to the intended Teams channels and users: -- Set a default channel from the list of connected MS Teams channels. This is where alerts will be sent unless otherwise - specified in escalation chains. +- Set a default channel from the list of connected MS Teams channels. +This is where alerts will be sent unless otherwise specified in escalation chains. - Ensure all users verify their MS Teams account in their Grafana OnCall user profile. ### Connect Microsoft Teams user to Grafana OnCall -1. From the **Users** tab in Grafana OnCall, click **View my profile**. -1. In the **User Info** tab, navigate to **Microsoft Teams username**, click **Connect**. +1. From the **Users** tab of Grafana OnCall, click **View my profile**. +1. In the **User Info** tab, locate **Notification channels**, **MS Teams**, and click **Connect account**. 1. Follow the steps provided to connect your Teams user. 1. Navigate back to your Grafana OnCall profile and verify that your Microsoft Teams account is linked to your Grafana OnCall user.