From dad6cfc1c8907dd45281f3148570f0c2d7b4c578 Mon Sep 17 00:00:00 2001 From: alyssa wada Date: Tue, 28 Jun 2022 13:55:10 -0600 Subject: [PATCH 1/4] add microsoft teams doc to support integration release --- docs/sources/chat-options/configure-teams.md | 64 ++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/sources/chat-options/configure-teams.md diff --git a/docs/sources/chat-options/configure-teams.md b/docs/sources/chat-options/configure-teams.md new file mode 100644 index 00000000..c3676f36 --- /dev/null +++ b/docs/sources/chat-options/configure-teams.md @@ -0,0 +1,64 @@ +--- +aliases: + - /docs/oncall/latest/chat-options/configure-teams/ +keywords: + - Grafana Cloud + - Alerts + - Notifications + - on-call + - amixr + - oncall + - MS Team + - Microsoft +title: Microsoft Teams integration for Grafana OnCall +canonical: "https://grafana.com/docs/oncall/latest/chat-options/configure-teams/" +weight: 500 +--- + +# Microsoft Teams integration for Grafana OnCall + +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. + +Integrating MS Teams with Grafana OnCall allows users to be notified of alerts directly in MS Teams with automated escalation steps and user notification preferences. Users can also take action on alerts directly from MS Teams, including 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 OnCall app from the [Microsoft Marketplace](https://appsource.microsoft.com/en-us/product/office/WA200004307). + +## Install Microsoft Teams integration for Grafana OnCall +1. From the **ChatOps** tab in Grafana OnCall, select **Microsoft Teams** in the side menu. +1. Click **+Connect Microsoft Teams channel**. +2. Follow the steps provided to connect to your Teams channels, then click **Done**. +3. To add additional teams and channels click **+Connect Microsoft Teams channel** again 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. +- 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. Navigate to **Microsoft Teams username**, click **Connect**. +2. Follow the steps provided to connect your Teams user. +3. Navigate back to your Grafana OnCall profile and verify that your Microsoft Teams account is linked to your Grafana OnCall user. + +### Configure user notifications with Microsoft Teams +To be notified of Grafana OnCall alerts via MS Teams: +1. Navigate to the **Users** tab in Grafana OnCall, click **Edit** next to a user. +1. In the **User Info** tab, edit or configure notification steps by clicking **+Add Notification step** +1. Select **Notify by** in the first dropdown and select **Microsoft Teams** in the second dropdown to receive alert notifications in Teams. + +### Configure Escalation Chains with Microsoft Teams notifications +Once your MS Teams integration is configured you can configure Escalation Chains to automatically send alerts from Grafana OnCall to MS Teams channels. + +To automatically send alerts to MS Teams channels: + +1. Navigate to the **Escalation Chains** tab in Grafana OnCall, select an existing escalation chain or click **+New escalation chain**. +1. Click the dropdown for **Add escalation step**. +1. Enable **Post to Microsoft Teams channel** by selecting a connected channel from the dropdown. \ No newline at end of file From 876d2ce7ee3526cf953fab14d99800decf868c88 Mon Sep 17 00:00:00 2001 From: alyssa wada Date: Wed, 29 Jun 2022 11:28:32 -0600 Subject: [PATCH 2/4] update escalation instruction --- docs/sources/chat-options/configure-teams.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/sources/chat-options/configure-teams.md b/docs/sources/chat-options/configure-teams.md index c3676f36..b17ca99d 100644 --- a/docs/sources/chat-options/configure-teams.md +++ b/docs/sources/chat-options/configure-teams.md @@ -54,11 +54,11 @@ To be notified of Grafana OnCall alerts via MS Teams: 1. In the **User Info** tab, edit or configure notification steps by clicking **+Add Notification step** 1. Select **Notify by** in the first dropdown and select **Microsoft Teams** in the second dropdown to receive alert notifications in Teams. -### Configure Escalation Chains with Microsoft Teams notifications -Once your MS Teams integration is configured you can configure Escalation Chains to automatically send alerts from Grafana OnCall to MS Teams channels. +### Configure escalation chains to post to Microsoft Teams channels +Once your MS Teams integration is configured you can add an escalation step at the integration level to automatically send alerts from a specific integration to a channel in MS Teams. + +To automatically send alerts from an integration to MS Teams channels: -To automatically send alerts to MS Teams channels: - -1. Navigate to the **Escalation Chains** tab in Grafana OnCall, select an existing escalation chain or click **+New escalation chain**. -1. Click the dropdown for **Add escalation step**. -1. Enable **Post to Microsoft Teams channel** by selecting a connected channel from the dropdown. \ No newline at end of file +1. Navigate to the **Integrations** tab in Grafana OnCall, select an existing integration or click **+New integration for receiving alerts**. +1. From the integrations settings, navigate to the escalation chain panel. +1. Enable **Post to Microsoft Teams channel** by selecting a channel to connect from the dropdown. \ No newline at end of file From a67ac794e3dc68e2733fd5c41cf4c72bf4123052 Mon Sep 17 00:00:00 2001 From: Matvey Kukuy Date: Thu, 30 Jun 2022 17:18:05 +0300 Subject: [PATCH 3/4] Fixing links, restoring "Production environment" part --- docs/sources/open-source.md | 33 +++++++++++++-------------------- 1 file changed, 13 insertions(+), 20 deletions(-) diff --git a/docs/sources/open-source.md b/docs/sources/open-source.md index 7261d13b..750297f9 100644 --- a/docs/sources/open-source.md +++ b/docs/sources/open-source.md @@ -12,11 +12,7 @@ weight: 300 Grafana OnCall is a developer-friendly incident response tool that's available to Grafana open source and Grafana Cloud users. The OSS version of Grafana OnCall provides the same reliable on-call management solution along with the flexibility of a self-managed environment. -This guide describes the necessary installation and configuration steps needed to configure OSS Grafana OnCall. - -The intended audience for this guide includes: -- Grafana open source admins who are responsible for deploying and configuring Grafana OnCall. -- Grafana open source users who need to configure SMS and phone notifications using Grafana Cloud. +This guide describes the necessary installation and configuration steps needed to configure OSS Grafana OnCall. ## Install Grafana OnCall OSS @@ -24,13 +20,16 @@ There are three Grafana OnCall OSS environments available: - **Hobby** playground environment for local usage: [README.md](https://github.com/grafana/oncall#getting-started) - **Development** environment for contributors: [DEVELOPER.md](https://github.com/grafana/oncall/blob/dev/DEVELOPER.md) -- **Production** environment for reliable Cloud installation: [Production Environment](#production-environment) +- **Production** environment for reliable cloud installation using Helm: [Production Environment](#production-environment) -For detailed installation instructions and additional resources, refer to the OSS Grafana OnCall [README.md](https://github.com/grafana/oncall#getting-started) +## Production Environment +We suggest using our official helm chart for the reliable production deployment of Grafana OnCall. It will deploy Grafana OnCall engine and celery workers, along with RabbitMQ cluster, Redis Cluster, and the database. -For more information on production environment installation, refer to the following OSS Grafana OnCall [production environment helm chart](https://github.com/grafana/oncall/helm) +Check the [helm chart](https://github.com/grafana/oncall/helm) for more details. -## Configure Slack for Grafana OnCall OSS +We'll always be happy to provide assistance with production deployment in [our communities](https://github.com/grafana/oncall#join-community)! + +## Slack Setup The Slack integration for Grafana OnCall leverages Slack API features to provide a customizable and useful integration. Refer to the following steps to configure the Slack integration: @@ -156,7 +155,7 @@ lt --port 8080 -s pretty-turkey-83 --print-requests 1. Configure additional Slack settings. - ## Configure Telegram for Grafana OnCall OSS +## Telegram Setup The Telegram integration for Grafana OnCall is designed for collaborative team work and improved incident response. Refer to the following steps to configure the Telegram integration: @@ -168,22 +167,16 @@ The Telegram integration for Grafana OnCall is designed for collaborative team w 1. From the **ChatOps** tab in Grafana OnCall, click **Telegram**. -## Connect Grafana Cloud to Grafana OnCall OSS - -Open source Grafana OnCall can be connected to Grafana Cloud to configure a variety of notifications. +## Grafana OSS-Cloud Setup The benefits of connecting to Grafana Cloud include: -- Heartbeat notification +- Cloud OnCall could monitor OSS OnCall uptime using heartbeat - SMS for user notifications - Phone calls for user notifications. -To connect to Grafana Cloud, refer to the **Cloud** page in your OSS Grafana OnCall instance. +To connect to Grafana Cloud, refer to the **Cloud** page in your OSS Grafana OnCall instance. - ->**NOTE:** As an alternative option to Grafana Cloud, phone call and SMS notifications can be configured using Twilio. - - -## Connect Twilio for Grafana OnCall OSS +## Twilio Setup Grafana OnCall supports Twilio SMS and phone call notifications delivery. If you prefer to configure SMS and phone call notifications using Twilio, complete the following steps: From 01d1d0588b7deb719ad9da42f1df998c54190d33 Mon Sep 17 00:00:00 2001 From: Matvey Kukuy Date: Thu, 30 Jun 2022 17:21:26 +0300 Subject: [PATCH 4/4] Fixing helm chart link --- docs/sources/open-source.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/open-source.md b/docs/sources/open-source.md index 750297f9..525924ed 100644 --- a/docs/sources/open-source.md +++ b/docs/sources/open-source.md @@ -25,7 +25,7 @@ There are three Grafana OnCall OSS environments available: ## Production Environment We suggest using our official helm chart for the reliable production deployment of Grafana OnCall. It will deploy Grafana OnCall engine and celery workers, along with RabbitMQ cluster, Redis Cluster, and the database. -Check the [helm chart](https://github.com/grafana/oncall/helm) for more details. +Check the [helm chart](https://github.com/grafana/oncall/tree/dev/helm/oncall) for more details. We'll always be happy to provide assistance with production deployment in [our communities](https://github.com/grafana/oncall#join-community)!