From 6bf69d141e32cae8ec9fa0d3688b5c3644a1f929 Mon Sep 17 00:00:00 2001 From: Usman Ahmad Date: Tue, 21 May 2024 10:24:26 +0200 Subject: [PATCH] Docs/usman plugin mgmt (#85424) * fixed text and better formatting * added examples of community and partners plugins * added more clarity to apps plugin usage * added and also fixed more * added clarity to the server and org admin roles * run prettier * fixed some minor typos * Apply suggestions from code review thanks. looks good now- Co-authored-by: David Harris * Technical edit * restorted the changes in panel and datasource examples as requested * revert duplicated change * Apply suggestions from code review Thanks Jack for the suggestions. Looks good!! Co-authored-by: Jack Baldry * added minor adjustment * fixed typo * added bash syntax * revert changes * added changes from PR 87168 for index.md file * Delete docs/sources/shared/find-and-use-plugins.md removed this file from the PR as was not intended to be part of this PR. This PR is only for the Grafana OSS and not for the Grafana Cloud * run prettier * Apply suggestions from code review Co-authored-by: David Harris * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris * Update docs/sources/administration/plugin-management/index.md Co-authored-by: David Harris * added a small text fix * added cloud tag in product labels * run prettier * Apply suggestions from code review thanks for the review Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> * fixed typo for note section * run prettier to fix --------- Co-authored-by: David Harris Co-authored-by: Joe Perez Co-authored-by: Jack Baldry Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> --- .../administration/plugin-management/index.md | 109 ++++++++++-------- 1 file changed, 59 insertions(+), 50 deletions(-) diff --git a/docs/sources/administration/plugin-management/index.md b/docs/sources/administration/plugin-management/index.md index 2fd0da04432..285292ea5a3 100644 --- a/docs/sources/administration/plugin-management/index.md +++ b/docs/sources/administration/plugin-management/index.md @@ -8,6 +8,7 @@ aliases: labels: products: - enterprise + - cloud - oss title: Plugin management weight: 600 @@ -15,11 +16,17 @@ weight: 600 # Plugin management -Besides the wide range of visualizations and data sources that are available immediately after you install Grafana, you can extend your Grafana experience with _plugins_. +You can enhance your Grafana experience with _plugins_, extensions to Grafana beyond the wide range of visualizations and data sources that are built-in. -You can [install](#install-a-plugin) one of the plugins built by the Grafana community, or [build one yourself](/developers/plugin-tools). +This guide shows you how to [install](#install-a-plugin) plugins that are built by Grafana Labs, commercial partners, our community, or plugins that you have [built yourself](/developers/plugin-tools). -Grafana supports three types of plugins: [panels](/grafana/plugins?type=panel), [data sources](/plugins?type=datasource), and [apps](/grafana/plugins?type=app). +## Types of plugins + +Grafana supports three types of plugins: + +- [Panels](/grafana/plugins/panel-plugins) - These plugins make it easy to create and add any kind of panel, to show your data, or improve your favorite dashboards. +- [Data sources](/grafana/plugins/data-source-plugins) - These plugins allow you to pull data from various data sources such as databases, APIs, log files, and so on, and display it in the form of graphs, charts, and dashboards in Grafana. +- [Apps](/grafana/plugins/app-plugins) - These plugins enable the bundling of data sources, panels, dashboards, and Grafana pages into a cohesive experience. ## Panel plugins @@ -37,7 +44,7 @@ Data source plugins add support for new databases, such as [Google BigQuery](/gr Data source plugins communicate with external sources of data and return the data in a format that Grafana understands. By adding a data source plugin, you can immediately use the data in any of your existing dashboards. -Use data source plugins when you want to import data from external systems. +Use data source plugins when you want to query data from external or third-party systems. ## App plugins @@ -47,29 +54,29 @@ Apps can also add custom pages for things like control panels. Use app plugins when you want an out-of-the-box monitoring experience. -### Managing app plugins access +### Managing access for app plugins -With [RBAC]({{< relref "../roles-and-permissions/access-control/#about-rbac" >}}), it is now possible to customize access to app plugins. +Customize access to app plugins with [RBAC]({{< relref "../roles-and-permissions/access-control/#about-rbac" >}}). -By default, Viewers, Editors and Admins have access to all App Plugins that their organization role allows them to access, thanks to the `fixed:plugins.app:reader` role. +By default, the Viewer, Editor and Admin roles have access to all app plugins that their Organization role allows them to access. Access is granted by the `fixed:plugins.app:reader` role. {{% admonition type="note" %}} -Revoking this RBAC role from some users, will prevent them from accessing app plugins. But granting this RBAC role to users will only allow them to see app plugins their organization role allows them to see. +To prevent users from seeing an app plugin, refer to [these permissions scenarios]({{< relref "../roles-and-permissions/access-control/plan-rbac-rollout-strategy#prevent-viewers-from-accessing-an-app-plugin" >}}). {{% /admonition %}} -To prevent users from seeing an app plugin, refer to [this permissions scenarios]({{< relref "../roles-and-permissions/access-control/plan-rbac-rollout-strategy#prevent-viewers-from-accessing-an-app-plugin" >}}). - ## Plugin catalog -The Plugin catalog allows you to browse and manage plugins from within Grafana. Only Grafana server administrators and organization administrators can access and use the plugin catalog. The following access rules apply depending on the user role: +The Grafana plugin catalog allows you to browse and manage plugins from within Grafana. Only Grafana server administrators and Organization administrators can access and use the plugin catalog. For more information about Grafana roles and permissions, refer to [Roles and permissions]({{< relref "../administration/roles-and-permissions" >}}). -| Org Admin | Server Admin | Permissions | -| --------- | ------------ | ------------------------------------------------------------------------------------------- | -| ✓ | ✓ |
  • Can configure app plugins
  • Can install/uninstall/update plugins
| -| ✓ | × |
  • Can configure app plugins
  • Cannot install/uninstall/update plugins
| -| × | ✓ |
  • Cannot configure app plugins
  • Can install/uninstall/update plugins
| +The following access rules apply depending on the user role: -> **Note:** The Plugin catalog is designed to work with a single Grafana server instance only. Support for Grafana clusters will be added in future Grafana releases. +- If you are an **Org Admin**, you can configure app plugins, but you can't install, uninstall, or update them. +- If you are a **Server Admin**, you can't configure app plugins, but you can install, uninstall, or update them. +- If you are both **Org Admin** and **Server Admin**, you can configure app plugins and also install, uninstall, or update them. + +{{% admonition type="note" %}} +The Grafana plugin catalog is designed to work with a single Grafana server instance only. Support for Grafana clusters is planned for future Grafana releases. +{{% /admonition %}}