From fef5d7a67fcc600a7569d87af62d3650c565666b Mon Sep 17 00:00:00 2001 From: Syerikjan Kh Date: Mon, 11 Aug 2025 10:54:37 -0400 Subject: [PATCH] Docs: Helm chart plugin installation (#109467) * docs: helm chart plugin installation * Update docs/sources/administration/plugin-management/_index.md Co-authored-by: Anna Urbiztondo --------- Co-authored-by: Anna Urbiztondo --- .../plugin-management/_index.md | 33 ++++++++++++++++--- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/docs/sources/administration/plugin-management/_index.md b/docs/sources/administration/plugin-management/_index.md index b7c674b4b18..ac5d102b8f0 100644 --- a/docs/sources/administration/plugin-management/_index.md +++ b/docs/sources/administration/plugin-management/_index.md @@ -151,10 +151,11 @@ Here is an example based on `grafana-lokiexplore-app` plugins. #### Install plugins using the Grafana Helm chart -With the Grafana Helm chart, add the plugins you want to install as a list using the `plugins` field in the your values file. For more information about the configuration, refer to [the Helm chart configuration reference](https://github.com/grafana/helm-charts/tree/main/charts/grafana#configuration). +With the Grafana Helm chart, you can install plugins using one of the following methods: -The following YAML snippet installs v1.9.0 of the Grafana OnCall App plugin and the Redis data source plugin. -You must incorporate this snippet within your Helm values file. +##### Method 1: Using the `plugins` field + +Add the plugins you want to install as a list in your values file. For more information about the configuration, refer to [the Helm chart configuration reference](https://github.com/grafana/helm-charts/tree/main/charts/grafana#configuration). ```yaml plugins: @@ -162,7 +163,31 @@ plugins: - redis-datasource ``` -When the update is complete, a confirmation message will indicate the installation was successful. +##### Method 2: Using `GF_PLUGINS_PREINSTALL_SYNC` + +Add the following to your `values.yaml` file: + +```yaml +env: + # Format: @[]@ + GF_PLUGINS_PREINSTALL_SYNC: grafana-oncall-app@1.9.0@https://grafana.com/api/plugins/grafana-oncall-app/versions/v1.9.0/download + + # Or without version and URL (latest version will be used) + # GF_PLUGINS_PREINSTALL_SYNC: grafana-oncall-app + + # Multiple plugins (comma-separated) + # GF_PLUGINS_PREINSTALL_SYNC: grafana-oncall-app,redis-datasource +``` + +##### Method 3: Using `GF_PLUGINS_INSTALL` (Deprecated since 12.1.0) + +```yaml +env: + # Comma-separated list of plugin IDs + GF_PLUGINS_INSTALL: grafana-oncall-app,redis-datasource +``` + +When the installation is complete, a confirmation message will indicate that the plugins were successfully installed. ### Update a plugin