grafana/docs/sources/plugins/catalog.md
Levente Balogh 35c2c95fdc
Plugins: remove deprecated code (components) (#41686)
* refactor(plugins): use routes specific to the new plugins/admin

* refactor(plugins): remove unused pages (PluginList, PluginItem)

* refactor(plugins): remove PluginPage

* refactor(plugins): remove UpdatePluginModal

* refactor(plugins): move AppConfigWrapper under plugins/admin

* refactor(plugins): move PluginDashboards under plugins/admin

* refactor(plugins): rename the "specs" folder to "tests"

* refactor(plugins): move test files to /tests folder

* refactor(plugins): move AppRootPage into a /components folder

* refactor(plugins): move PluginsErrorsInfo into a /plugins folder

* refactor(plugins): move PluginSettingsCache into a /components folder

* refactor(plugins): move PluginStateInfo into a /plugins folder

* refactor(plugins): move AppRootPage.test.tsx next to the tested component

* refactor(plugins): remove old snapshot tests

* fix(plugins): fix tests

* refactor(plugins/admin): move & rename PluginSettingsCache

* fix(plugins): fix a few rebase issues

* Plugins: remove deprecated code (state handling) (#41739)

* refactor(plugins): use the plugins/admin reducer only

* refactor(plugins): remove tests for the deprecated plugins reducer

* refactor(plugins): remove tests for the deprecated plugins selectors

* refactor(plugins/state): add a short comment note to selectors

* feat(plugins/state): add a selector for selecting errors

* feat(plugins/state): add a hook for getting plugin errors

* refactor(plugins): udpate the PluginsErrorsInfo component to use the new state selectors

* refactor(plugins/state): remove the old (deprecated) selectors

* refactor(plugins/state): use the new actions under /admin

* refactor(plugins/state): remove old (deprecated) reducers and actions

* refactor(plugins): update component definition

* fix(plugins): remove unnecessary {children} prop for PluginsErrorsInfo

* Plugins: show / hide install controls based on the `pluginAdminEnabled` flag (#41749)

* docs(plugins): update documentation for the `plugin_admin_enabled` flag

* refactor(InstallControls): move the main component to a named module

* feat(plugins): use the `pluginAdminEnable` flag to hide / show install controls in the UI

* test(plugins): add tests for enabling/disabling install controls
2021-11-19 13:42:26 +01:00

3.4 KiB
Raw Blame History

+++ title = "Plugin catalog" aliases = ["/docs/grafana/latest/plugins/catalog/"] weight = 1 +++

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:

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

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.

In order to be able to install / uninstall / update plugins using plugin catalog, you must enable it via the plugin_admin_enabled flag in the [configuration]({{< relref "../administration/configuration.md#plugin_admin_enabled" >}}) file. Before following the steps below, make sure you are logged in as a Grafana administrator.

Currently, there are two entry points to the Plugin catalog.

  • Grafana server administrators can find it at Server Admin > Plugins.
  • Organization administrators can find it at Configuration > Plugins.

Browse plugins

To browse for available plugins:

  1. In Grafana, navigate to the Plugin catalog to view installed plugins.
  2. Click the All filter to browse all available plugins.
  3. Click the Data sources, Panels, or Applications buttons to filter by plugin type.

Plugin catalog browse

Install a plugin

To install a plugin:

  1. In Grafana, navigate to the Plugin catalog to view installed plugins.
  2. Browse and find a plugin.
  3. Click on the plugin logo.
  4. Click Install.

When the update is complete, you see a confirmation message that the installation was successful.

Plugin catalog install

Update a plugin

To update a plugin:

  1. In Grafana, navigate to the Plugin catalog to view installed plugins.
  2. Click on the plugin logo.
  3. Click Update.

When the update is complete, you see a confirmation message that the update was successful.

Plugin catalog update

Uninstall a plugin

To uninstall a plugin:

  1. In Grafana, navigate to the Plugin catalog to view installed plugins.
  2. Click on the plugin logo.
  3. Click Uninstall.

When the update is complete, you see a confirmation message that the uninstall was successful.

Plugin catalog uninstall