Merge pull request #256269 from maud-lv/ml-grafanaplugins

ShannonLeavitt · web-flow · commit 701dcff5b641 · 2023-11-07T09:13:01.000-06:00
Add plugin management feature
diff --git a/articles/managed-grafana/concept-whats-new.md b/articles/managed-grafana/concept-whats-new.md
@@ -5,7 +5,7 @@ author: maud-lv
 ms.author: malev
 ms.service: managed-grafana
 ms.topic: conceptual
-ms.date: 10/30/2023
+ms.date: 10/01/2023
 
 ---
 
@@ -19,7 +19,7 @@ ms.date: 10/30/2023
 
 * [Microsoft Entra groups](how-to-sync-teams-with-azure-ad-groups.md) is available in preview in Azure Managed Grafana.
 
-* Plugin management is available in preview. This feature lets you manage installed Grafana plugins directly within an Azure Managed Grafana workspace.
+* [Plugin management](how-to-manage-plugins.md) is available in preview. This feature lets you manage installed Grafana plugins directly within an Azure Managed Grafana workspace.
 
 * Azure Monitor workspaces integration is available in preview. This feature allows you to link your Grafana dashboard to Azure Monitor workspaces. This integration simplifies the process of connecting AKS clusters to an Azure Managed Grafana workspace and collecting metrics.
 
diff --git a/articles/managed-grafana/how-to-data-source-plugins-managed-identity.md b/articles/managed-grafana/how-to-data-source-plugins-managed-identity.md
@@ -1,24 +1,28 @@
 ---
-title: How to configure data sources for Azure Managed Grafana
-description: In this how-to guide, discover how you can configure data sources for Azure Managed Grafana using Managed Identity.
+title: How to manage data sources for Azure Managed Grafana
+description: In this how-to guide, discover how you can configure data sources for Azure Managed Grafana
 author: maud-lv 
 ms.author: malev 
 ms.service: managed-grafana 
 ms.topic: how-to
-ms.date: 10/13/2023
+ms.date: 10/24/2023
 ---
 
-# How to configure data sources for Azure Managed Grafana
+# How to manage data sources in Azure Managed Grafana
+
+In this guide, you learn about data sources supported in each Azure Managed Grana plan and learn how to add, manage and remove these data sources.
 
 ## Prerequisites
 
-[An Azure Managed Grafana instance](./how-to-permissions.md)
+[An Azure Managed Grafana instance](./how-to-permissions.md).
 
 ## Supported Grafana data sources
 
 By design, Grafana can be configured with multiple *data sources*. A data source is an externalized storage backend that holds telemetry information.
 
-Azure Managed Grafana supports many popular data sources. The table below lists the data sources that can be added to Azure Managed Grafana for each service tier.
+### Grafana core data sources
+
+Azure Managed Grafana supports many popular data sources. The table below lists the Grafana core data sources that can be added to Azure Managed Grafana for each service tier.
 
 | Data sources                                                                                                                  | Essential (preview) | Standard |
 |-------------------------------------------------------------------------------------------------------------------------------|-----------|----------|
@@ -40,9 +44,11 @@ Azure Managed Grafana supports many popular data sources. The table below lists
 | [PostgreSQL](https://grafana.com/docs/grafana/latest/datasources/postgres/)                                                   | -         | ✔       |
 | [Prometheus](https://grafana.com/docs/grafana/latest/datasources/prometheus/)                                                 | ✔        | ✔       |
 | [Tempo](https://grafana.com/docs/grafana/latest/datasources/tempo/)                                                           | -         | ✔       |
-| [TestData](https://grafana.com/docs/grafana/latest/datasources/testdata/)                                                  | ✔        | ✔       |
+| [TestData](https://grafana.com/docs/grafana/latest/datasources/testdata/)                                                     | ✔        | ✔       |
 | [Zipkin](https://grafana.com/docs/grafana/latest/datasources/zipkin/)                                                         | -         | ✔       |
 
+### Data sources for Grafana Enterprise customers
+
 Within the Standard service tier, users who have subscribed to the Grafana Enterprise option can also access the following data sources.
 
 * [AppDynamics](https://grafana.com/grafana/plugins/dlopes7-appdynamics-datasource)
@@ -62,29 +68,47 @@ Within the Standard service tier, users who have subscribed to the Grafana Enter
 * [Splunk Infrastructure monitoring (SignalFx)](https://grafana.com/grafana/plugins/grafana-splunk-monitoring-datasource)
 * [Wavefront](https://grafana.com/grafana/plugins/grafana-wavefront-datasource)
 
+### Additional data sources
+
+More data sources can be added from the [Plugin management (preview) feature](how-to-manage-plugins.md).
+
 For more information about data sources, go to [Data sources](https://grafana.com/docs/grafana/latest/datasources/) on the Grafana Labs website.
 
 ## Add a data source
 
-A number of data sources, such as Azure Monitor, are added to your Grafana instance by default. To add more data sources, follow the steps below using the Azure portal or the Azure CLI.
+To add a data source to Azure Managed Grafana, follow the steps below using the Azure portal or the Azure CLI.
 
 ### [Portal](#tab/azure-portal)
 
+### Grafana core data sources
+
+To add a [Grafana core data source](https://grafana.com/docs/grafana/latest/datasources/#built-in-core-data-sources) with the Azure portal:
+
 1. Open your Azure Managed Grafana instance in the Azure portal.
 1. Select **Overview** from the left menu, then open the **Endpoint** URL.
-1. In the Grafana portal, deploy the menu on the left and select **Connections**.
-1. Under Connect data, select a data source from the list, and add the data source to your instance.
-1. Fill out the form with the data source settings and select **Save and test** to validate the connection to your data source.
+1. In the Grafana portal, deploy the menu on the left and select **Connections** > **Connect data**.
+1. Select a data source from the list, and add it to your instance by selecting **Create** or **Add** in the top right hand corner.
+1. Fill out the form and select **Save and test** to test and update the data source configuration.
 
    :::image type="content" source="media/data-sources/add-data-source.png" alt-text="Screenshot of the Add data source page.":::
 
+### Other data sources
+
+1. To add a data source that isn't part of the Grafana built-in core data sources, start by [installing the corresponding data source plugin](how-to-manage-plugins.md#add-a-plugin).
+
+1. Then add the datasource from the Grafana portal.
+
+    1. In the Grafana portal, go to **Connections** > **Connect data**.
+    1. Select a data source from the list, and add the data source to your instance by selecting **Create** in the top right hand corner.
+    1. Fill out the form and select **Save and test** to test and update the data source configuration.
+
 ### [Azure CLI](#tab/azure-cli)
 
-Run the [az grafana data-source create](/cli/azure/grafana/data-source#az-grafana-data-source-create) command to add and manage Azure Managed Grafana data sources with the Azure CLI.
+Run the [az grafana data-source create](/cli/azure/grafana/data-source#az-grafana-data-source-create) command to add a [Grafana core data source](https://grafana.com/docs/grafana/latest/datasources/#built-in-core-data-sources) with the Azure CLI.
 
 For example, to add an Azure SQL data source, run:
 
-```azurecli-interactive
+```azurecli
 
 az grafana data-source create --name <instance-name> --definition '{
   "access": "proxy",
@@ -103,12 +127,16 @@ az grafana data-source create --name <instance-name> --definition '{
 }'
 ```
 
+Other data sources can be added [from the Azure portal](#other-data-sources).
+
 ---
 
 > [!TIP]
 > If you can't connect to a data source, you may need to [modify access permissions](how-to-permissions.md) to allow access from your Azure Managed Grafana instance.
 
-## Update a data source
+## Configure a data source
+
+The content below, shows how to configure some of the most popular data sources in Azure Managed Grafana: Azure Monitor and Azure Data Explorer. A similar process can be used to configure other types of data sources. For more information about a specific data source, refer to [Grafana's documentation](https://grafana.com/docs/grafana/latest/datasources/#built-in-core-data-sources).
 
 ### Azure Monitor configuration
 
@@ -216,10 +244,33 @@ Azure Managed Grafana can also access data sources using a service principal set
 
 ---
 
-## Next steps
+## Remove a data source
 
-> [!div class="nextstepaction"]
-> [Connect to a data source privately](./how-to-connect-to-data-source-privately.md)
+This section describes the steps for removing a data source.
+
+> [!CAUTION]
+> Removing a data source that is used in a dashboard will make the dashboard unable to collect the corresponding data and will trigger an error or result in no data being shown in the panel.
+
+### [Portal](#tab/azure-portal)
+
+Remove a data source in the Azure portal:
+
+1. Open your Azure Managed Grafana instance in the Azure portal.
+1. Select **Overview** from the left menu, then open the **Endpoint** URL.
+1. In the Grafana portal, go to **Connections** > **Your connections**
+1. Select the data source you want to remove and select **Delete**.
+
+### [Azure CLI](#tab/azure-cli)
+
+Run the [az grafana data-source delete](/cli/azure/grafana/data-source#az-grafana-data-source-delete) command to remove an Azure Managed Grafana data source using the Azure CLI. In the sample below, replace the placeholders `<instance-name>` and `<id>` with the name of the Azure Managed Grafana workspace and the name, ID or UID of the data source.
+
+```azurecli
+az grafana data-source delete --name <instance-name> --data-source <id>
+```
+
+---
+
+## Next steps
 
 > [!div class="nextstepaction"]
-> [Share an Azure Managed Grafana instance](./how-to-share-grafana-workspace.md)
+> [Create a dashboard](how-to-create-dashboard.md)
diff --git a/articles/managed-grafana/how-to-manage-plugins.md b/articles/managed-grafana/how-to-manage-plugins.md
@@ -0,0 +1,72 @@
+---
+title: How to manage plugins in Azure Managed Grafana
+description: In this how-to guide, discover how you can add a Grafana plugin or remove a Grafana plugin you no longer need.
+author: maud-lv 
+ms.author: malev 
+ms.service: managed-grafana 
+ms.topic: how-to
+ms.date: 10/26/2023
+---
+
+# How to manage Grafana plugins (Preview)
+
+Grafana supports data source, panel, and app plugins. When you create a new Grafana instance, some plugins, such as Azure Monitor, are installed by default. In the following guide, learn how you can add or remove optional plugins.
+
+> [!NOTE]
+> Installing and removing plugins isn't available from the Grafana UI or the Azure CLI at this stage. Plugin management is done from the Azure Managed Grafana workspace in the Azure portal.
+
+> [!IMPORTANT]
+> Plugin management is currently in PREVIEW.
+> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
+
+## Prerequisites
+
+[An Azure Managed Grafana instance](./how-to-permissions.md)
+
+## Add a plugin
+
+To install Grafana plugins, follow the process below.
+
+1. Open your Azure Managed Grafana instance in the Azure portal.
+1. Select **Plugin management (Preview)**. This page shows a table with three columns containing checkboxes, plugin names, and plugin IDs. Review the checkboxes. A checked box indicates that the corresponding plugin is already installed and can be removed, an unchecked box indicates that the corresponding plugin isn't installed and can be added.
+
+   > [!NOTE]
+   > This page only shows optional plugins. Core Grafana plugins that are included in your pricing plan by default aren't listed here.
+
+1. Select a plugin to add to your Grafana instance by checking its checkbox. A refresh icon appears in the table next to the plugin you selected, indicating that a change is pending.
+
+   :::image type="content" source="media/plugin-management/add-plugin.png" alt-text="Screenshot of the Plugin management feature data source page.":::
+
+1. Select **Save**. Azure displays a message stating which plugins will be added or removed. Select **Yes** to confirm.
+1. An **Updating** status bar indicates that the update is in progress. The update might take a while.
+1. A notification appears, indicating if the update operation has been successful.
+1. Select **Refresh** above the table to get an updated list of installed plugins.
+
+## Remove a plugin
+
+To remove a plugin that isn't part of the Grafana built-in core plugins, follow the steps below:
+
+1. Open your Azure Managed Grafana instance in the Azure portal.
+1. Select **Plugin management (Preview)**. This page displays a table with data source plugins. It contains three columns including checkboxes, plugin names, and plugin IDs. Review the checkboxes. A checked box indicates that the corresponding plugin is already installed and can be removed, an unchecked box indicates that the corresponding plugin can be added.
+1. Select a plugin to remove from your Grafana instance by unchecking its checkbox. A refresh icon appears in the table next to the plugin you selected, indicating that a change is pending.
+
+   :::image type="content" source="media/plugin-management/remove-plugin.png" alt-text="Screenshot of the Plugin management feature data source page. Remove plugin.":::
+
+1. Select **Save**. Azure displays a message stating which plugins will be added or removed. Select **Yes** to confirm.
+1. An **Updating** status bar indicates that the update is in progress. The update might take a while.
+1. A notification appears, indicating if the update operation has been successful.
+1. Select **Refresh** above the table to get an updated list of installed plugins.
+
+> [!IMPORTANT]
+> Plugin management is currently in PREVIEW.
+> See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
+
+> [!CAUTION]
+> Removing a data source that is used in a dashboard will make the dashboard unable to collect the corresponding data and will trigger an error or result in no data being shown in the panel.
+
+## Next steps
+
+Now that you know how to add and remove plugins, learn how to manage data sources.
+
+> [!div class="nextstepaction"]
+> [Configure a data source](./how-to-data-source-plugins-managed-identity.md)
diff --git a/articles/managed-grafana/index.yml b/articles/managed-grafana/index.yml
@@ -33,8 +33,10 @@ landingContent:
     linkLists:
       - linkListType: how-to-guide
         links:
-          - text: Configure data sources with Managed Identity
+          - text: Configure data sources
             url: how-to-data-source-plugins-managed-identity.md
+          - text: Manage plugins
+            url: how-to-manage-plugins.md
           - text: Call Grafana APIs programmatically
             url: how-to-api-calls.md
           - text: Enable zone redundancy
diff --git a/articles/managed-grafana/media/plugin-management/add-plugin.png b/articles/managed-grafana/media/plugin-management/add-plugin.png
diff --git a/articles/managed-grafana/media/plugin-management/remove-plugin.png b/articles/managed-grafana/media/plugin-management/remove-plugin.png
diff --git a/articles/managed-grafana/toc.yml b/articles/managed-grafana/toc.yml
@@ -47,6 +47,8 @@ items:
       href: how-to-permissions.md
     - name: Enable Grafana Enterprise
       href: how-to-grafana-enterprise.md
+    - name: Manage plugins
+      href: how-to-manage-plugins.md
   - name: Dashboards
     expanded: false
     items:
