Abstract
Values for the official Grafana Helm Chart.
Grafana Helm Chart Values#
Repository Contents#
Chart Docs
- Grafana Helm Chart
- Get Repo Info
- Installing the Chart
- Uninstalling the Chart
- Upgrading an existing Release to a new major version
- Configuration
- Import dashboards
- BASE64 dashboards
- Sidecar for dashboards
- Sidecar for datasources
- Sidecar for notifiers
- Sidecar for alerting resources
- Statically provision alerting resources
- How to serve Grafana with a path prefix (/grafana)
- How to securely reference secrets in grafana.ini
- Image Renderer Plug-In
This is a copy
The following information is copied from the GitHub repo, which should be considered the source of truth regarding the use of this chart.
In the event of differences between the two sets of information, the GitHub repo should always be considered as the source of truth.
Grafana Community Kubernetes Helm Charts#
The code is provided as-is with no warranties.
Usage#
Helm must be installed to use the charts. Please refer to Helm’s documentation to get started.
Once Helm is set up properly, add the repo as follows:
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
You can then run helm search repo grafana
to see the charts.
Chart documentation is available in grafana directory.
Contributing#
We’d love to have you contribute! Please refer to our contribution guidelines for details.
License#
Values#
- service
Expose the grafana service to be accessed from outside the cluster (LoadBalancer service).
or access it from within the cluster (ClusterIP service). Set the service type and the port to serve it.
- resources
limits: cpu: 100m memory: 128Mi requests: cpu: 100m memory: 128Mi
- nodeSelector
Node labels for pod assignment
- persistence
Enable persistence using Persistent Volume Claims
ref: https://kubernetes.io/docs/user-guide/persistent-volumes/
- envValueFrom
“valueFrom” environment variable references that will be added to deployment pods. Name is templated.
ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#envvarsource-v1-core
Renders in container spec as:
env:
…
- name:
valueFrom:
- envFromSecret
The name of a secret in the same kubernetes namespace which contain values to be added to the environment
This can be useful for auth tokens, etc. Value is templated.
- envRenderSecret
Sensible environment variables that will be rendered as new secret object
This can be useful for auth tokens, etc.
If the secret values contains “{{”, they’ll need to be properly escaped so that they are not interpreted by Helm
ref: https://helm.sh/docs/howto/charts_tips_and_tricks/#using-the-tpl-function
- envFromSecrets
The names of secrets in the same kubernetes namespace which contain values to be added to the environment
Each entry should contain a name key, and can optionally specify whether the secret must be defined with an optional key.
Name is templated.
- envFromConfigMaps
The names of conifgmaps in the same kubernetes namespace which contain values to be added to the environment
Each entry should contain a name key, and can optionally specify whether the configmap must be defined with an optional key.
Name is templated.
ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapenvsource-v1-core
- enableServiceLinks
Inject Kubernetes services as environment variables. See https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#environment-variables
- extraVolumeMounts
Additional grafana server volume mounts Defines additional volume mounts.
- extraVolumes
Additional Grafana server volumes
- lifecycleHooks
Container Lifecycle Hooks. Execute a specific bash command or make an HTTP request
- plugins
Pass the plugins you want installed as a list.
- datasources
Configure grafana datasources
ref: http://docs.grafana.org/administration/provisioning/#datasources
- alerting
Configure grafana alerting (can be templated)
ref: http://docs.grafana.org/administration/provisioning/#alerting
- notifiers
Configure notifiers
ref: http://docs.grafana.org/administration/provisioning/#alert-notification-channels
- dashboardProviders
Configure grafana dashboard providers
ref: http://docs.grafana.org/administration/provisioning/#dashboards
path
must be /var/lib/grafana/dashboards/<provider_name>- dashboards
Configure grafana dashboard to import
NOTE: To use dashboards you must also enable/configure dashboardProviders
ref: https://grafana.com/dashboards
dashboards per provider, use provider name as key.
- S# default
Reference to external ConfigMap per provider. Use provider name as key and ConfigMap name as value.
A provider dashboards must be defined either by external ConfigMaps or in values.yaml, not in both.
ConfigMap data example:
data:
example-dashboard.json: |
RAW_JSON
- grafana.ini
Grafana’s primary configuration
Note
NOTE: values in map will be converted to ini format
Data Sources#
The PostgreSQL data source requires read-only access.
You can find more information about that here.