Attention: Deprecation notice for Bintray, JCenter, GoCenter and ChartCenter. Learn More

bitnami/grafana-operator

Chart version: 0.4.0
Api version: v2
App version: 3.9.0
Kubernetes Operator based on the Operator SDK for creating and ...
application
Chart Type
Active
Status
Unknown
License
1393
Downloads
https://charts.bitnami.com/bitnami
Set me up:
helm repo add center https://repo.chartcenter.io
Install Chart:
helm install grafana-operator center/bitnami/grafana-operator
Versions (0)

grafana-operator

Grafana Operator is an Operator which introduces Lifecycle Management for Grafana Dashboards and Plugins.

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/grafana-operator

Introduction

Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.

This chart bootstraps a Grafana Operator Deployment Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This Helm chart has been tested on top of Bitnami Kubernetes Production Runtime (BKPR). Deploy BKPR to get automated TLS certificates, logging and monitoring for your applications.

Prerequisites

  • Kubernetes 1.12+
  • Helm 3.1.0

Installing the Chart

To install the chart with the release name my-release:

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/grafana-operator

These commands deploy grafana-operator on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release helm release:

$ helm uninstall my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Differences between the Bitnami Grafana chart and the Bitnami Grafana Operator chart

In the Bitnami catalog we offer both the bitnami/grafana and bitnami/grafana-operator charts. Each solution covers different needs and use cases.

The bitnami/grafana chart deploys a single Grafana installation (with Grafana Image Renderer) using a Kubernetes Deployment object (together with Services, PVCs, ConfigMaps, etc.). The figure below shows the deployed objects in the cluster after executing helm install:

                    +--------------+             +-----+
                    |              |             |     |
 Service & Ingress  |    Grafana   +<------------+ PVC |
<-------------------+              |             |     |
                    |  Deployment  |             +-----+
                    |              |
                    +-----------+--+
                                ^                +------------+
                                |                |            |
                                +----------------+ Configmaps |
                                                 |   Secrets  |
                                                 |            |
                                                 +------------+

Its lifecycle is managed using Helm and, at the Grafana container level, the following operations are automated: persistence management, configuration based on environment variables and plugin initialization. The chart also allows deploying dashboards and data sources using ConfigMaps. The Deployments do not require any ServiceAccounts with special RBAC privileges so this solution would fit better in more restricted Kubernetes installations.

The bitnami/grafana-operator chart deploys a Grafana Operator installation using a Kubernetes Deployment. The figure below shows the Grafana operator deployment after executing helm install:

+--------------------+
|                    |      +---------------+
|  Grafana Operator  |      |               |
|                    |      |     RBAC      |
|    Deployment      |      |   Privileges  |
|                    |      |               |
+-------+------------+      +-------+-------+
        ^                           |
        |   +-----------------+     |
        +---+ Service Account +<----+
            +-----------------+

The operator will extend the Kubernetes API with the following objects: Grafana, GrafanaDashboards and GrafanaDataSources. From that moment, the user will be able to deploy objects of these kinds and the previously deployed Operator will take care of deploying all the required Deployments, ConfigMaps and Services for running a Grafana instance. Its lifecycle is managed using kubectl on the Grafana, GrafanaDashboards and GrafanaDataSource objects. The following figure shows the deployed objects after deploying a Grafana object using kubectl:

+--------------------+
|                    |      +---------------+
|  Grafana Operator  |      |               |
|                    |      |     RBAC      |
|    Deployment      |      |   Privileges  |
|                    |      |               |
+--+----+------------+      +-------+-------+
   |    ^                           |
   |    |   +-----------------+     |
   |    +---+ Service Account +<----+
   |        +-----------------+
   |
   |
   |
   |
   |                                                   Grafana
   |                     +---------------------------------------------------------------------------+
   |                     |                                                                           |
   |                     |                          +--------------+             +-----+             |
   |                     |                          |              |             |     |             |
   +-------------------->+       Service & Ingress  |    Grafana   +<------------+ PVC |             |
                         |      <-------------------+              |             |     |             |
                         |                          |  Deployment  |             +-----+             |
                         |                          |              |                                 |
                         |                          +-----------+--+                                 |
                         |                                      ^                +------------+      |
                         |                                      |                |            |      |
                         |                                      +----------------+ Configmaps |      |
                         |                                                       |   Secrets  |      |
                         |                                                       |            |      |
                         |                                                       +------------+      |
                         |                                                                           |
                         +---------------------------------------------------------------------------+

This solution allows to easily deploy multiple Grafana instances compared to the bitnami/grafana chart. As the operator automatically deploys Grafana installations, the Grafana Operator pods will require a ServiceAccount with privileges to create and destroy multiple Kubernetes objects. This may be problematic for Kubernetes clusters with strict role-based access policies.

Parameters

The following tables list the configurable parameters of the grafana-operator chart and their default values per section/component:

Global parameters

Parameter Description Default
global.imageRegistry Global Docker image registry nil
global.imagePullSecrets Global Docker registry secret names as an array [] (does not add image pull secrets to deployed pods)

Common parameters

Parameter Description Default
nameOverride String to partially override common.names.fullname template with a string (will prepend the release name) nil
fullnameOverride String to fully override common.names.fullname template with a string nil
commonAnnotations Common Annotations which are applied to every ressource deployed {}
commonLabels Common Labels which are applied to every ressource deployed {}
extraDeploy Array of extra objects to deploy with the release [] (evaluated as a template)

Grafana Operator parameters

Parameter Description Default
operator.enabled Enable the deployment of the Grafana Operator true
operator.image.registry Grafana Operator image registry docker.io
operator.image.repository Grafana Operator image name bitnami/grafana-operator
operator.image.tag Grafana Operator image tag {TAG_NAME}
operator.image.pullPolicy Grafana Operator image pull policy IfNotPresent
operator.image.pullSecrets Specify docker-registry secret names as an array [] (does not add image pull secrets to deployed pods)
operator.replicaCount Specify the amount of replicas running 1
operator.updateStrategy Specify the updateStrategy of the containers {"type": "Recreate"}
operator.args.scanAllNamespaces Specify if all namespace should be scanned for dashboards and datasources. (Creates ClusterRole) false
operator.args.scanNamespaces Specify the namespaces which should be scanned for dashboards and datasources (Creates ClusterRole) [] (does not add ClusterRole or Namespaces)
operator.podAffinityPreset Set podAffinity preset from Helm Chart nil
operator.podAntiAffinityPreset Set podAntiAffinity preset from Helm Chart soft
operator.nodeAffinityPreset.type Set nodeAffinity preset type nil
operator.nodeAffinityPreset.key Set nodeAffinity preset key nil
operator.nodeAffinityPreset.values Set nodeAffinity preset values nil
operator.resources.limits Specify resource limits which the container is not allowed to succeed {} (does not add resource limits to deployed pods)
operator.resources.requests Specify resource requests which the container needs to spawn {} (does not add resource limits to deployed pods)
operator.nodeSelector Node labels for controller pod assignment {}
operator.tolerations Tolerations for controller pod assignment []
operator.affinity Affinity for controller pod assignment {}
operator.podAnnotations Pod annotations {}
operator.hostAliases Add deployment host aliases []
operator.podLabels Pod labels {}
operator.serviceAccount.create create a serviceAccount for the deployment true
operator.serviceAccount.name use the serviceAccount with the specified name
operator.podSecurityContext.enabled Enable pods security context true
operator.podSecurityContext.runAsNonRoot Grafana Operator must run as nonRoot true
operator.podSecurityContext.runAsUser User ID for the pods 1001
operator.podSecurityContext.runAsGroup User ID for the pods 1001
operator.podSecurityContext.fsGroup Group ID for the pods 1001
operator.podSecurityContext.supplementalGroups Drop capabilities for the securityContext []
operator.livenessProbe.enabled Enable/disable the Liveness probe true
operator.livenessProbe.initialDelaySeconds Delay before liveness probe is initiated 3
operator.livenessProbe.periodSeconds How often to perform the probe 10
operator.livenessProbe.timeoutSeconds When the probe times out 10
operator.livenessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after having failed 1
operator.livenessProbe.failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded 1
operator.readinessProbe.enabled Enable/disable the Liveness probe true
operator.readinessProbe.initialDelaySeconds Delay before liveness probe is initiated 3
operator.readinessProbe.periodSeconds How often to perform the probe 10
operator.readinessProbe.timeoutSeconds When the probe times out 10
operator.readinessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after having failed 1
operator.readinessProbe.failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded 1
operator.rbac.create Specify if an rbac authorization should be created with the necessarry Rolebindings true
operator.prometheus.serviceMonitor.enabled Specify if a servicemonitor will be deployed for prometheus-operator true
operator.prometheus.serviceMonitor.jobLabel Specify the jobLabel to use for the prometheus-operator app.kubernetes.io/name
operator.prometheus.serviceMonitor.interval Specify the scrape interval if not specified use defaul prometheus scrapeIntervall ""
operator.prometheus.serviceMonitor.metricRelabelings Specify additional relabeling of metrics []
operator.prometheus.serviceMonitor.relabelings Specify general relabeling []

Grafana parameters

Parameter Description Default
grafana.enabled Enabled the deployment of the Grafana CRD object into the cluster true
grafana.image.registry Grafana image registry docker.io
grafana.image.repository Grafana image name bitnami/grafana
grafana.image.tag Grafana image tag {TAG_NAME}
grafana.image.pullSecrets Specify docker-registry secret names as an array [] (does not add image pull secrets to deployed pods)
grafana.envFrom Extra environment variable to pass to the running container []
grafana.client.timeout The timeout in seconds for the Grafana Rest API on that instance 5
grafana.client.preferService If the API should be used via Ingress or via the internal service true
grafana.adminUsername Set Grafana instance admin username ""
grafana.adminPassword Set Grafana instance admin password ""
grafana.replicaCount Specify the amount of replicas running 1
grafana.ingress.enabled If an ingress or OpenShift Route should be created false
grafana.ingress.hostname The hostname under which the grafana instance should be reachable grafana.local
grafana.ingress.path The path for the ingress instance to forward to the grafana app /
grafana.ingress.labels Additional Labels for the ingress resource nil
grafana.ingress.annotations Additional Annotations for the ingress resource nil
grafana.ingress.tls This enables tls support for the ingress resource false
grafana.ingress.tlsSecret The name for the secret to use for the tls termination grafana.local-tls
grafana.persistence.enabled Enable persistent storage for the grafana deployment false
grafana.persistence.storageClass Define the storageClass for the persistent storage if not defined default is used nil
grafana.persistence.accessMode Define the accessMode for the persistent storage ReadWriteOnce
grafana.persistence.size Define the size of the PersistentVolumeClaim to request for 10Gi
grafana.config grafana.ini configuration for the instance for this to configure please look at upstream docs {}
grafana.jsonnetLibrarySelector The LabelSelector to grab for jsonnet lib resources {}
grafana.dashboardLabelSelectors The LabelSelector to grab for dashboard resources []
grafana.podAffinityPreset Set podAffinity preset from Helm Chart nil
grafana.podAntiAffinityPreset Set podAntiAffinity preset from Helm Chart soft
grafana.nodeAffinityPreset.type Set nodeAffinity preset type nil
grafana.nodeAffinityPreset.key Set nodeAffinity preset key nil
grafana.nodeAffinityPreset.values Set nodeAffinity preset values nil
grafana.resources.limits Specify resource limits which the container is not allowed to succeed {} (does not add resource limits to deployed pods)
grafana.resources.requests Specify resource requests which the container needs to spawn {} (does not add resource limits to deployed pods)
grafana.nodeSelector Node labels for controller pod assignment {}
grafana.tolerations Tolerations for controller pod assignment []
grafana.affinity Affinity for controller pod assignment {}
grafana.podAnnotations Pod annotations {}
grafana.podLabels Pod labels {}
grafana.podSecurityContext.enabled Enable pods security context true
grafana.podSecurityContext.runAsNonRoot Grafana Operator must run as nonRoot true
grafana.podSecurityContext.runAsUser User ID for the pods 1001
grafana.podSecurityContext.runAsGroup User ID for the pods 1001
grafana.podSecurityContext.fsGroup Group ID for the pods 1001
grafana.podSecurityContext.supplementalGroups Drop capabilities for the securityContext []
grafana.containerSecurityContext.enabled Enable containers security context true
grafana.containerSecurityContext.runAsUser User ID for the containers 1001
grafana.containerSecurityContext.runAsGroup Group ID for the containers 1001
grafana.containerSecurityContext.fsGroup Filesystem Group ID for the containers 1001
grafana.containerSecurityContext.allowPrivilegeEscalation Don’t allow privilege escalation for the containers false
grafana.speaker.extraEnvVars Extra environment variable to pass to the running container []
grafana.livenessProbe.enabled Enable/disable the Liveness probe true
grafana.livenessProbe.initialDelaySeconds Delay before liveness probe is initiated 3
grafana.livenessProbe.periodSeconds How often to perform the probe 10
grafana.livenessProbe.timeoutSeconds When the probe times out 10
grafana.livenessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after having failed 1
grafana.livenessProbe.failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded 1
grafana.readinessProbe.enabled Enable/disable the Liveness probe true
grafana.readinessProbe.initialDelaySeconds Delay before liveness probe is initiated 3
grafana.readinessProbe.periodSeconds How often to perform the probe 10
grafana.readinessProbe.timeoutSeconds When the probe times out 10
grafana.readinessProbe.successThreshold Minimum consecutive successes for the probe to be considered successful after having failed 1
grafana.readinessProbe.failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded 1

PluginInit parameters

Parameter Description Default
grafanaPluginInit.image.registry Grafana Plugin Init image registry docker.io
grafanaPluginInit.image.repository Grafana Plugin Init image name bitnami/grafana
grafanaPluginInit.image.tag Grafana Plugin Init image tag {TAG_NAME}
grafanaPluginInit.image.pullSecrets Specify docker-registry secret names as an array [] (does not add image pull secrets to deployed pods)

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
  --set livenessProbe.successThreshold=5 \
    bitnami/grafana-operator

The above command sets the livenessProbe.successThreshold to 5.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/grafana-operator

Configuration and installation details

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Documentation for the Configuration of Dashboards

After the installation you can create your Dashboards under a CRD of your kubernetes cluster.

For more details regarding what is possible with those CRDs please have a look at Working with Dashboards.

Deploying extra resources

There are cases where you may want to deploy extra objects, such your custom Grafana, GrafanaDashboards or GrafanaDataSource objects. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy parameter.

For instance, to deploy your custom Grafana definition, you can install the Grafana Operator using the values below:

grafana:
  enabled: false
extraDeploy:
  - apiVersion: integreatly.org/v1alpha1
    baseImage: docker.io/bitnami/grafana:7
    kind: Grafana
    metadata:
      name: grafana
    spec:
      deployment:
        securityContext:
          runAsUser: 1001
          fsGroup: 1001
        containerSecurityContext:
          runAsUser: 1001
          fsGroup: 1001
          allowPrivilegeEscalation: false
      service:
        type: LoadBalancer
      ingress:
        enabled: false
      config:
        log:
          mode: "console"
          level: "warn"
        security:
          admin_user: "admin"
          admin_password: "hello"
        auth.anonymous:
          enabled: true
      dashboardLabelSelector:
        - matchExpressions:
            - { key: app, operator: In, values: [grafana] }

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

$ helm upgrade my-release bitnami/grafana-operator