|
@@ -16,7 +16,7 @@ _See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation
|
|
To install the chart with the release name `my-release`:
|
|
To install the chart with the release name `my-release`:
|
|
|
|
|
|
```console
|
|
```console
|
|
-helm install --name my-release grafana/grafana
|
|
|
|
|
|
+helm install my-release grafana/grafana
|
|
```
|
|
```
|
|
|
|
|
|
## Uninstalling the Chart
|
|
## Uninstalling the Chart
|
|
@@ -42,6 +42,10 @@ This version requires Helm >= 2.12.0.
|
|
|
|
|
|
You have to add --force to your helm upgrade command as the labels of the chart have changed.
|
|
You have to add --force to your helm upgrade command as the labels of the chart have changed.
|
|
|
|
|
|
|
|
+### To 6.0.0
|
|
|
|
+
|
|
|
|
+This version requires Helm >= 3.1.0.
|
|
|
|
+
|
|
## Configuration
|
|
## Configuration
|
|
|
|
|
|
| Parameter | Description | Default |
|
|
| Parameter | Description | Default |
|
|
@@ -55,47 +59,55 @@ You have to add --force to your helm upgrade command as the labels of the chart
|
|
| `securityContext` | Deployment securityContext | `{"runAsUser": 472, "runAsGroup": 472, "fsGroup": 472}` |
|
|
| `securityContext` | Deployment securityContext | `{"runAsUser": 472, "runAsGroup": 472, "fsGroup": 472}` |
|
|
| `priorityClassName` | Name of Priority Class to assign pods | `nil` |
|
|
| `priorityClassName` | Name of Priority Class to assign pods | `nil` |
|
|
| `image.repository` | Image repository | `grafana/grafana` |
|
|
| `image.repository` | Image repository | `grafana/grafana` |
|
|
-| `image.tag` | Image tag (`Must be >= 5.0.0`) | `7.0.3` |
|
|
|
|
-| `image.sha` | Image sha (optional) | `17cbd08b9515fda889ca959e9d72ee6f3327c8f1844a3336dfd952134f38e2fe` |
|
|
|
|
|
|
+| `image.tag` | Overrides the Grafana image tag whose default is the chart appVersion (`Must be >= 5.0.0`) | `` |
|
|
|
|
+| `image.sha` | Image sha (optional) | `` |
|
|
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
|
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
|
-| `image.pullSecrets` | Image pull secrets | `{}` |
|
|
|
|
|
|
+| `image.pullSecrets` | Image pull secrets (can be templated) | `[]` |
|
|
|
|
+| `service.enabled` | Enable grafana service | `true` |
|
|
| `service.type` | Kubernetes service type | `ClusterIP` |
|
|
| `service.type` | Kubernetes service type | `ClusterIP` |
|
|
| `service.port` | Kubernetes port where service is exposed | `80` |
|
|
| `service.port` | Kubernetes port where service is exposed | `80` |
|
|
| `service.portName` | Name of the port on the service | `service` |
|
|
| `service.portName` | Name of the port on the service | `service` |
|
|
|
|
+| `service.appProtocol` | Adds the appProtocol field to the service | `` |
|
|
| `service.targetPort` | Internal service is port | `3000` |
|
|
| `service.targetPort` | Internal service is port | `3000` |
|
|
| `service.nodePort` | Kubernetes service nodePort | `nil` |
|
|
| `service.nodePort` | Kubernetes service nodePort | `nil` |
|
|
-| `service.annotations` | Service annotations | `{}` |
|
|
|
|
|
|
+| `service.annotations` | Service annotations (can be templated) | `{}` |
|
|
| `service.labels` | Custom labels | `{}` |
|
|
| `service.labels` | Custom labels | `{}` |
|
|
| `service.clusterIP` | internal cluster service IP | `nil` |
|
|
| `service.clusterIP` | internal cluster service IP | `nil` |
|
|
| `service.loadBalancerIP` | IP address to assign to load balancer (if supported) | `nil` |
|
|
| `service.loadBalancerIP` | IP address to assign to load balancer (if supported) | `nil` |
|
|
| `service.loadBalancerSourceRanges` | list of IP CIDRs allowed access to lb (if supported) | `[]` |
|
|
| `service.loadBalancerSourceRanges` | list of IP CIDRs allowed access to lb (if supported) | `[]` |
|
|
| `service.externalIPs` | service external IP addresses | `[]` |
|
|
| `service.externalIPs` | service external IP addresses | `[]` |
|
|
|
|
+| `headlessService` | Create a headless service | `false` |
|
|
| `extraExposePorts` | Additional service ports for sidecar containers| `[]` |
|
|
| `extraExposePorts` | Additional service ports for sidecar containers| `[]` |
|
|
| `hostAliases` | adds rules to the pod's /etc/hosts | `[]` |
|
|
| `hostAliases` | adds rules to the pod's /etc/hosts | `[]` |
|
|
| `ingress.enabled` | Enables Ingress | `false` |
|
|
| `ingress.enabled` | Enables Ingress | `false` |
|
|
| `ingress.annotations` | Ingress annotations (values are templated) | `{}` |
|
|
| `ingress.annotations` | Ingress annotations (values are templated) | `{}` |
|
|
| `ingress.labels` | Custom labels | `{}` |
|
|
| `ingress.labels` | Custom labels | `{}` |
|
|
| `ingress.path` | Ingress accepted path | `/` |
|
|
| `ingress.path` | Ingress accepted path | `/` |
|
|
|
|
+| `ingress.pathType` | Ingress type of path | `Prefix` |
|
|
| `ingress.hosts` | Ingress accepted hostnames | `["chart-example.local"]` |
|
|
| `ingress.hosts` | Ingress accepted hostnames | `["chart-example.local"]` |
|
|
-| `ingress.extraPaths` | Ingress extra paths to prepend to every host configuration. Useful when configuring [custom actions with AWS ALB Ingress Controller](https://kubernetes-sigs.github.io/aws-alb-ingress-controller/guide/ingress/annotation/#actions). | `[]` |
|
|
|
|
|
|
+| `ingress.extraPaths` | Ingress extra paths to prepend to every host configuration. Useful when configuring [custom actions with AWS ALB Ingress Controller](https://kubernetes-sigs.github.io/aws-alb-ingress-controller/guide/ingress/annotation/#actions). Requires `ingress.hosts` to have one or more host entries. | `[]` |
|
|
| `ingress.tls` | Ingress TLS configuration | `[]` |
|
|
| `ingress.tls` | Ingress TLS configuration | `[]` |
|
|
| `resources` | CPU/Memory resource requests/limits | `{}` |
|
|
| `resources` | CPU/Memory resource requests/limits | `{}` |
|
|
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
|
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
|
| `tolerations` | Toleration labels for pod assignment | `[]` |
|
|
| `tolerations` | Toleration labels for pod assignment | `[]` |
|
|
| `affinity` | Affinity settings for pod assignment | `{}` |
|
|
| `affinity` | Affinity settings for pod assignment | `{}` |
|
|
| `extraInitContainers` | Init containers to add to the grafana pod | `{}` |
|
|
| `extraInitContainers` | Init containers to add to the grafana pod | `{}` |
|
|
-| `extraContainers` | Sidecar containers to add to the grafana pod | `{}` |
|
|
|
|
|
|
+| `extraContainers` | Sidecar containers to add to the grafana pod | `""` |
|
|
| `extraContainerVolumes` | Volumes that can be mounted in sidecar containers | `[]` |
|
|
| `extraContainerVolumes` | Volumes that can be mounted in sidecar containers | `[]` |
|
|
|
|
+| `extraLabels` | Custom labels for all manifests | `{}` |
|
|
| `schedulerName` | Name of the k8s scheduler (other than default) | `nil` |
|
|
| `schedulerName` | Name of the k8s scheduler (other than default) | `nil` |
|
|
| `persistence.enabled` | Use persistent volume to store data | `false` |
|
|
| `persistence.enabled` | Use persistent volume to store data | `false` |
|
|
| `persistence.type` | Type of persistence (`pvc` or `statefulset`) | `pvc` |
|
|
| `persistence.type` | Type of persistence (`pvc` or `statefulset`) | `pvc` |
|
|
| `persistence.size` | Size of persistent volume claim | `10Gi` |
|
|
| `persistence.size` | Size of persistent volume claim | `10Gi` |
|
|
-| `persistence.existingClaim` | Use an existing PVC to persist data | `nil` |
|
|
|
|
|
|
+| `persistence.existingClaim` | Use an existing PVC to persist data (can be templated) | `nil` |
|
|
| `persistence.storageClassName` | Type of persistent volume claim | `nil` |
|
|
| `persistence.storageClassName` | Type of persistent volume claim | `nil` |
|
|
| `persistence.accessModes` | Persistence access modes | `[ReadWriteOnce]` |
|
|
| `persistence.accessModes` | Persistence access modes | `[ReadWriteOnce]` |
|
|
| `persistence.annotations` | PersistentVolumeClaim annotations | `{}` |
|
|
| `persistence.annotations` | PersistentVolumeClaim annotations | `{}` |
|
|
| `persistence.finalizers` | PersistentVolumeClaim finalizers | `[ "kubernetes.io/pvc-protection" ]` |
|
|
| `persistence.finalizers` | PersistentVolumeClaim finalizers | `[ "kubernetes.io/pvc-protection" ]` |
|
|
-| `persistence.subPath` | Mount a sub dir of the persistent volume | `nil` |
|
|
|
|
|
|
+| `persistence.extraPvcLabels` | Extra labels to apply to a PVC. | `{}` |
|
|
|
|
+| `persistence.subPath` | Mount a sub dir of the persistent volume (can be templated) | `nil` |
|
|
|
|
+| `persistence.inMemory.enabled` | If persistence is not enabled, whether to mount the local storage in-memory to improve performance | `false` |
|
|
|
|
+| `persistence.inMemory.sizeLimit` | SizeLimit for the in-memory local storage | `nil` |
|
|
| `initChownData.enabled` | If false, don't reset data ownership at startup | true |
|
|
| `initChownData.enabled` | If false, don't reset data ownership at startup | true |
|
|
| `initChownData.image.repository` | init-chown-data container image repository | `busybox` |
|
|
| `initChownData.image.repository` | init-chown-data container image repository | `busybox` |
|
|
| `initChownData.image.tag` | init-chown-data container image tag | `1.31.1` |
|
|
| `initChownData.image.tag` | init-chown-data container image tag | `1.31.1` |
|
|
@@ -104,15 +116,20 @@ You have to add --force to your helm upgrade command as the labels of the chart
|
|
| `initChownData.resources` | init-chown-data pod resource requests & limits | `{}` |
|
|
| `initChownData.resources` | init-chown-data pod resource requests & limits | `{}` |
|
|
| `schedulerName` | Alternate scheduler name | `nil` |
|
|
| `schedulerName` | Alternate scheduler name | `nil` |
|
|
| `env` | Extra environment variables passed to pods | `{}` |
|
|
| `env` | Extra environment variables passed to pods | `{}` |
|
|
-| `envValueFrom` | Environment variables from alternate sources. See the API docs on [EnvVarSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#envvarsource-v1-core) for format details. | `{}` |
|
|
|
|
|
|
+| `envValueFrom` | Environment variables from alternate sources. See the API docs on [EnvVarSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#envvarsource-v1-core) for format details. Can be templated | `{}` |
|
|
| `envFromSecret` | Name of a Kubernetes secret (must be manually created in the same namespace) containing values to be added to the environment. Can be templated | `""` |
|
|
| `envFromSecret` | Name of a Kubernetes secret (must be manually created in the same namespace) containing values to be added to the environment. Can be templated | `""` |
|
|
|
|
+| `envFromSecrets` | List of Kubernetes secrets (must be manually created in the same namespace) containing values to be added to the environment. Can be templated | `[]` |
|
|
|
|
+| `envFromConfigMaps` | List of Kubernetes ConfigMaps (must be manually created in the same namespace) containing values to be added to the environment. Can be templated | `[]` |
|
|
| `envRenderSecret` | Sensible environment variables passed to pods and stored as secret | `{}` |
|
|
| `envRenderSecret` | Sensible environment variables passed to pods and stored as secret | `{}` |
|
|
|
|
+| `enableServiceLinks` | Inject Kubernetes services as environment variables. | `true` |
|
|
| `extraSecretMounts` | Additional grafana server secret mounts | `[]` |
|
|
| `extraSecretMounts` | Additional grafana server secret mounts | `[]` |
|
|
| `extraVolumeMounts` | Additional grafana server volume mounts | `[]` |
|
|
| `extraVolumeMounts` | Additional grafana server volume mounts | `[]` |
|
|
-| `extraConfigmapMounts` | Additional grafana server configMap volume mounts | `[]` |
|
|
|
|
|
|
+| `createConfigmap` | Enable creating the grafana configmap | `true` |
|
|
|
|
+| `extraConfigmapMounts` | Additional grafana server configMap volume mounts (values are templated) | `[]` |
|
|
| `extraEmptyDirMounts` | Additional grafana server emptyDir volume mounts | `[]` |
|
|
| `extraEmptyDirMounts` | Additional grafana server emptyDir volume mounts | `[]` |
|
|
| `plugins` | Plugins to be loaded along with Grafana | `[]` |
|
|
| `plugins` | Plugins to be loaded along with Grafana | `[]` |
|
|
| `datasources` | Configure grafana datasources (passed through tpl) | `{}` |
|
|
| `datasources` | Configure grafana datasources (passed through tpl) | `{}` |
|
|
|
|
+| `alerting` | Configure grafana alerting (passed through tpl) | `{}` |
|
|
| `notifiers` | Configure grafana notifiers | `{}` |
|
|
| `notifiers` | Configure grafana notifiers | `{}` |
|
|
| `dashboardProviders` | Configure grafana dashboard providers | `{}` |
|
|
| `dashboardProviders` | Configure grafana dashboard providers | `{}` |
|
|
| `dashboards` | Dashboards to import | `{}` |
|
|
| `dashboards` | Dashboards to import | `{}` |
|
|
@@ -126,12 +143,23 @@ You have to add --force to your helm upgrade command as the labels of the chart
|
|
| `podAnnotations` | Pod annotations | `{}` |
|
|
| `podAnnotations` | Pod annotations | `{}` |
|
|
| `podLabels` | Pod labels | `{}` |
|
|
| `podLabels` | Pod labels | `{}` |
|
|
| `podPortName` | Name of the grafana port on the pod | `grafana` |
|
|
| `podPortName` | Name of the grafana port on the pod | `grafana` |
|
|
-| `sidecar.image.repository` | Sidecar image repository | `kiwigrid/k8s-sidecar` |
|
|
|
|
-| `sidecar.image.tag` | Sidecar image tag | `0.1.151` |
|
|
|
|
|
|
+| `lifecycleHooks` | Lifecycle hooks for podStart and preStop [Example](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/#define-poststart-and-prestop-handlers) | `{}` |
|
|
|
|
+| `sidecar.image.repository` | Sidecar image repository | `quay.io/kiwigrid/k8s-sidecar` |
|
|
|
|
+| `sidecar.image.tag` | Sidecar image tag | `1.19.2` |
|
|
| `sidecar.image.sha` | Sidecar image sha (optional) | `""` |
|
|
| `sidecar.image.sha` | Sidecar image sha (optional) | `""` |
|
|
| `sidecar.imagePullPolicy` | Sidecar image pull policy | `IfNotPresent` |
|
|
| `sidecar.imagePullPolicy` | Sidecar image pull policy | `IfNotPresent` |
|
|
| `sidecar.resources` | Sidecar resources | `{}` |
|
|
| `sidecar.resources` | Sidecar resources | `{}` |
|
|
-| `sidecar.enableUniqueFilenames` | Sets the kiwigrid/k8s-sidecar UNIQUE_FILENAMES environment variable | `false` |
|
|
|
|
|
|
+| `sidecar.securityContext` | Sidecar securityContext | `{}` |
|
|
|
|
+| `sidecar.enableUniqueFilenames` | Sets the kiwigrid/k8s-sidecar UNIQUE_FILENAMES environment variable. If set to `true` the sidecar will create unique filenames where duplicate data keys exist between ConfigMaps and/or Secrets within the same or multiple Namespaces. | `false` |
|
|
|
|
+| `sidecar.alerts.enabled` | Enables the cluster wide search for alerts and adds/updates/deletes them in grafana |`false` |
|
|
|
|
+| `sidecar.alerts.label` | Label that config maps with alerts should have to be added | `grafana_alert` |
|
|
|
|
+| `sidecar.alerts.labelValue` | Label value that config maps with alerts should have to be added | `""` |
|
|
|
|
+| `sidecar.alerts.searchNamespace` | Namespaces list. If specified, the sidecar will search for alerts config-maps inside these namespaces. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces. | `nil` |
|
|
|
|
+| `sidecar.alerts.watchMethod` | Method to use to detect ConfigMap changes. With WATCH the sidecar will do a WATCH requests, with SLEEP it will list all ConfigMaps, then sleep for 60 seconds. | `WATCH` |
|
|
|
|
+| `sidecar.alerts.resource` | Should the sidecar looks into secrets, configmaps or both. | `both` |
|
|
|
|
+| `sidecar.alerts.reloadURL` | Full url of datasource configuration reload API endpoint, to invoke after a config-map change | `"http://localhost:3000/api/admin/provisioning/alerting/reload"` |
|
|
|
|
+| `sidecar.alerts.skipReload` | Enabling this omits defining the REQ_URL and REQ_METHOD environment variables | `false` |
|
|
|
|
+| `sidecar.alerts.initDatasources` | Set to true to deploy the datasource sidecar as an initContainer in addition to a container. This is needed if skipReload is true, to load any alerts defined at startup time. | `false` |
|
|
| `sidecar.dashboards.enabled` | Enables the cluster wide search for dashboards and adds/updates/deletes them in grafana | `false` |
|
|
| `sidecar.dashboards.enabled` | Enables the cluster wide search for dashboards and adds/updates/deletes them in grafana | `false` |
|
|
| `sidecar.dashboards.SCProvider` | Enables creation of sidecar provider | `true` |
|
|
| `sidecar.dashboards.SCProvider` | Enables creation of sidecar provider | `true` |
|
|
| `sidecar.dashboards.provider.name` | Unique name of the grafana provider | `sidecarProvider` |
|
|
| `sidecar.dashboards.provider.name` | Unique name of the grafana provider | `sidecarProvider` |
|
|
@@ -144,41 +172,62 @@ You have to add --force to your helm upgrade command as the labels of the chart
|
|
| `sidecar.dashboards.watchMethod` | Method to use to detect ConfigMap changes. With WATCH the sidecar will do a WATCH requests, with SLEEP it will list all ConfigMaps, then sleep for 60 seconds. | `WATCH` |
|
|
| `sidecar.dashboards.watchMethod` | Method to use to detect ConfigMap changes. With WATCH the sidecar will do a WATCH requests, with SLEEP it will list all ConfigMaps, then sleep for 60 seconds. | `WATCH` |
|
|
| `sidecar.skipTlsVerify` | Set to true to skip tls verification for kube api calls | `nil` |
|
|
| `sidecar.skipTlsVerify` | Set to true to skip tls verification for kube api calls | `nil` |
|
|
| `sidecar.dashboards.label` | Label that config maps with dashboards should have to be added | `grafana_dashboard` |
|
|
| `sidecar.dashboards.label` | Label that config maps with dashboards should have to be added | `grafana_dashboard` |
|
|
|
|
+| `sidecar.dashboards.labelValue` | Label value that config maps with dashboards should have to be added | `""` |
|
|
| `sidecar.dashboards.folder` | Folder in the pod that should hold the collected dashboards (unless `sidecar.dashboards.defaultFolderName` is set). This path will be mounted. | `/tmp/dashboards` |
|
|
| `sidecar.dashboards.folder` | Folder in the pod that should hold the collected dashboards (unless `sidecar.dashboards.defaultFolderName` is set). This path will be mounted. | `/tmp/dashboards` |
|
|
|
|
+| `sidecar.dashboards.folderAnnotation` | The annotation the sidecar will look for in configmaps to override the destination folder for files | `nil` |
|
|
| `sidecar.dashboards.defaultFolderName` | The default folder name, it will create a subfolder under the `sidecar.dashboards.folder` and put dashboards in there instead | `nil` |
|
|
| `sidecar.dashboards.defaultFolderName` | The default folder name, it will create a subfolder under the `sidecar.dashboards.folder` and put dashboards in there instead | `nil` |
|
|
-| `sidecar.dashboards.searchNamespace` | If specified, the sidecar will search for dashboard config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces | `nil` |
|
|
|
|
|
|
+| `sidecar.dashboards.searchNamespace` | Namespaces list. If specified, the sidecar will search for dashboards config-maps inside these namespaces. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces. | `nil` |
|
|
|
|
+| `sidecar.dashboards.script` | Absolute path to shell script to execute after a configmap got reloaded. | `nil` |
|
|
|
|
+| `sidecar.dashboards.resource` | Should the sidecar looks into secrets, configmaps or both. | `both` |
|
|
|
|
+| `sidecar.dashboards.extraMounts` | Additional dashboard sidecar volume mounts. | `[]` |
|
|
| `sidecar.datasources.enabled` | Enables the cluster wide search for datasources and adds/updates/deletes them in grafana |`false` |
|
|
| `sidecar.datasources.enabled` | Enables the cluster wide search for datasources and adds/updates/deletes them in grafana |`false` |
|
|
| `sidecar.datasources.label` | Label that config maps with datasources should have to be added | `grafana_datasource` |
|
|
| `sidecar.datasources.label` | Label that config maps with datasources should have to be added | `grafana_datasource` |
|
|
-| `sidecar.datasources.searchNamespace` | If specified, the sidecar will search for datasources config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces | `nil` |
|
|
|
|
-| `sidecar.notifiers.enabled` | Enables the cluster wide search for notifiers and adds/updates/deletes them in grafana |`false` |
|
|
|
|
|
|
+| `sidecar.datasources.labelValue` | Label value that config maps with datasources should have to be added | `""` |
|
|
|
|
+| `sidecar.datasources.searchNamespace` | Namespaces list. If specified, the sidecar will search for datasources config-maps inside these namespaces. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces. | `nil` |
|
|
|
|
+| `sidecar.datasources.watchMethod` | Method to use to detect ConfigMap changes. With WATCH the sidecar will do a WATCH requests, with SLEEP it will list all ConfigMaps, then sleep for 60 seconds. | `WATCH` |
|
|
|
|
+| `sidecar.datasources.resource` | Should the sidecar looks into secrets, configmaps or both. | `both` |
|
|
|
|
+| `sidecar.datasources.reloadURL` | Full url of datasource configuration reload API endpoint, to invoke after a config-map change | `"http://localhost:3000/api/admin/provisioning/datasources/reload"` |
|
|
|
|
+| `sidecar.datasources.skipReload` | Enabling this omits defining the REQ_URL and REQ_METHOD environment variables | `false` |
|
|
|
|
+| `sidecar.datasources.initDatasources` | Set to true to deploy the datasource sidecar as an initContainer in addition to a container. This is needed if skipReload is true, to load any datasources defined at startup time. | `false` |
|
|
|
|
+| `sidecar.notifiers.enabled` | Enables the cluster wide search for notifiers and adds/updates/deletes them in grafana | `false` |
|
|
| `sidecar.notifiers.label` | Label that config maps with notifiers should have to be added | `grafana_notifier` |
|
|
| `sidecar.notifiers.label` | Label that config maps with notifiers should have to be added | `grafana_notifier` |
|
|
-| `sidecar.notifiers.searchNamespace` | If specified, the sidecar will search for notifiers config-maps (or secrets) inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces | `nil` |
|
|
|
|
|
|
+| `sidecar.notifiers.labelValue` | Label value that config maps with notifiers should have to be added | `""` |
|
|
|
|
+| `sidecar.notifiers.searchNamespace` | Namespaces list. If specified, the sidecar will search for notifiers config-maps (or secrets) inside these namespaces. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces. | `nil` |
|
|
|
|
+| `sidecar.notifiers.watchMethod` | Method to use to detect ConfigMap changes. With WATCH the sidecar will do a WATCH requests, with SLEEP it will list all ConfigMaps, then sleep for 60 seconds. | `WATCH` |
|
|
|
|
+| `sidecar.notifiers.resource` | Should the sidecar looks into secrets, configmaps or both. | `both` |
|
|
|
|
+| `sidecar.notifiers.reloadURL` | Full url of notifier configuration reload API endpoint, to invoke after a config-map change | `"http://localhost:3000/api/admin/provisioning/notifications/reload"` |
|
|
|
|
+| `sidecar.notifiers.skipReload` | Enabling this omits defining the REQ_URL and REQ_METHOD environment variables | `false` |
|
|
|
|
+| `sidecar.notifiers.initNotifiers` | Set to true to deploy the notifier sidecar as an initContainer in addition to a container. This is needed if skipReload is true, to load any notifiers defined at startup time. | `false` |
|
|
| `smtp.existingSecret` | The name of an existing secret containing the SMTP credentials. | `""` |
|
|
| `smtp.existingSecret` | The name of an existing secret containing the SMTP credentials. | `""` |
|
|
| `smtp.userKey` | The key in the existing SMTP secret containing the username. | `"user"` |
|
|
| `smtp.userKey` | The key in the existing SMTP secret containing the username. | `"user"` |
|
|
| `smtp.passwordKey` | The key in the existing SMTP secret containing the password. | `"password"` |
|
|
| `smtp.passwordKey` | The key in the existing SMTP secret containing the password. | `"password"` |
|
|
-| `admin.existingSecret` | The name of an existing secret containing the admin credentials. | `""` |
|
|
|
|
|
|
+| `admin.existingSecret` | The name of an existing secret containing the admin credentials (can be templated). | `""` |
|
|
| `admin.userKey` | The key in the existing admin secret containing the username. | `"admin-user"` |
|
|
| `admin.userKey` | The key in the existing admin secret containing the username. | `"admin-user"` |
|
|
| `admin.passwordKey` | The key in the existing admin secret containing the password. | `"admin-password"` |
|
|
| `admin.passwordKey` | The key in the existing admin secret containing the password. | `"admin-password"` |
|
|
|
|
+| `serviceAccount.autoMount` | Automount the service account token in the pod| `true` |
|
|
| `serviceAccount.annotations` | ServiceAccount annotations | |
|
|
| `serviceAccount.annotations` | ServiceAccount annotations | |
|
|
| `serviceAccount.create` | Create service account | `true` |
|
|
| `serviceAccount.create` | Create service account | `true` |
|
|
|
|
+| `serviceAccount.labels` | ServiceAccount labels | `{}` |
|
|
| `serviceAccount.name` | Service account name to use, when empty will be set to created account if `serviceAccount.create` is set else to `default` | `` |
|
|
| `serviceAccount.name` | Service account name to use, when empty will be set to created account if `serviceAccount.create` is set else to `default` | `` |
|
|
| `serviceAccount.nameTest` | Service account name to use for test, when empty will be set to created account if `serviceAccount.create` is set else to `default` | `nil` |
|
|
| `serviceAccount.nameTest` | Service account name to use for test, when empty will be set to created account if `serviceAccount.create` is set else to `default` | `nil` |
|
|
| `rbac.create` | Create and use RBAC resources | `true` |
|
|
| `rbac.create` | Create and use RBAC resources | `true` |
|
|
| `rbac.namespaced` | Creates Role and Rolebinding instead of the default ClusterRole and ClusteRoleBindings for the grafana instance | `false` |
|
|
| `rbac.namespaced` | Creates Role and Rolebinding instead of the default ClusterRole and ClusteRoleBindings for the grafana instance | `false` |
|
|
|
|
+| `rbac.useExistingRole` | Set to a rolename to use existing role - skipping role creating - but still doing serviceaccount and rolebinding to the rolename set here. | `nil` |
|
|
| `rbac.pspEnabled` | Create PodSecurityPolicy (with `rbac.create`, grant roles permissions as well) | `true` |
|
|
| `rbac.pspEnabled` | Create PodSecurityPolicy (with `rbac.create`, grant roles permissions as well) | `true` |
|
|
| `rbac.pspUseAppArmor` | Enforce AppArmor in created PodSecurityPolicy (requires `rbac.pspEnabled`) | `true` |
|
|
| `rbac.pspUseAppArmor` | Enforce AppArmor in created PodSecurityPolicy (requires `rbac.pspEnabled`) | `true` |
|
|
| `rbac.extraRoleRules` | Additional rules to add to the Role | [] |
|
|
| `rbac.extraRoleRules` | Additional rules to add to the Role | [] |
|
|
| `rbac.extraClusterRoleRules` | Additional rules to add to the ClusterRole | [] |
|
|
| `rbac.extraClusterRoleRules` | Additional rules to add to the ClusterRole | [] |
|
|
| `command` | Define command to be executed by grafana container at startup | `nil` |
|
|
| `command` | Define command to be executed by grafana container at startup | `nil` |
|
|
| `testFramework.enabled` | Whether to create test-related resources | `true` |
|
|
| `testFramework.enabled` | Whether to create test-related resources | `true` |
|
|
-| `testFramework.image` | `test-framework` image repository. | `bats/bats` |
|
|
|
|
-| `testFramework.tag` | `test-framework` image tag. | `v1.1.0` |
|
|
|
|
-| `testFramework.imagePullPolicy` | `test-framework` image pull policy. | `IfNotPresent` |
|
|
|
|
|
|
+| `testFramework.image` | `test-framework` image repository. | `bats/bats` |
|
|
|
|
+| `testFramework.tag` | `test-framework` image tag. | `v1.4.1` |
|
|
|
|
+| `testFramework.imagePullPolicy` | `test-framework` image pull policy. | `IfNotPresent` |
|
|
| `testFramework.securityContext` | `test-framework` securityContext | `{}` |
|
|
| `testFramework.securityContext` | `test-framework` securityContext | `{}` |
|
|
| `downloadDashboards.env` | Environment variables to be passed to the `download-dashboards` container | `{}` |
|
|
| `downloadDashboards.env` | Environment variables to be passed to the `download-dashboards` container | `{}` |
|
|
|
|
+| `downloadDashboards.envFromSecret` | Name of a Kubernetes secret (must be manually created in the same namespace) containing values to be added to the environment. Can be templated | `""` |
|
|
| `downloadDashboards.resources` | Resources of `download-dashboards` container | `{}` |
|
|
| `downloadDashboards.resources` | Resources of `download-dashboards` container | `{}` |
|
|
| `downloadDashboardsImage.repository` | Curl docker image repo | `curlimages/curl` |
|
|
| `downloadDashboardsImage.repository` | Curl docker image repo | `curlimages/curl` |
|
|
-| `downloadDashboardsImage.tag` | Curl docker image tag | `7.70.0` |
|
|
|
|
|
|
+| `downloadDashboardsImage.tag` | Curl docker image tag | `7.73.0` |
|
|
| `downloadDashboardsImage.sha` | Curl docker image sha (optional) | `""` |
|
|
| `downloadDashboardsImage.sha` | Curl docker image sha (optional) | `""` |
|
|
| `downloadDashboardsImage.pullPolicy` | Curl docker image pull policy | `IfNotPresent` |
|
|
| `downloadDashboardsImage.pullPolicy` | Curl docker image pull policy | `IfNotPresent` |
|
|
| `namespaceOverride` | Override the deployment namespace | `""` (`Release.Namespace`) |
|
|
| `namespaceOverride` | Override the deployment namespace | `""` (`Release.Namespace`) |
|
|
@@ -186,6 +235,8 @@ You have to add --force to your helm upgrade command as the labels of the chart
|
|
| `serviceMonitor.namespace` | Namespace this servicemonitor is installed in | |
|
|
| `serviceMonitor.namespace` | Namespace this servicemonitor is installed in | |
|
|
| `serviceMonitor.interval` | How frequently Prometheus should scrape | `1m` |
|
|
| `serviceMonitor.interval` | How frequently Prometheus should scrape | `1m` |
|
|
| `serviceMonitor.path` | Path to scrape | `/metrics` |
|
|
| `serviceMonitor.path` | Path to scrape | `/metrics` |
|
|
|
|
+| `serviceMonitor.scheme` | Scheme to use for metrics scraping | `http` |
|
|
|
|
+| `serviceMonitor.tlsConfig` | TLS configuration block for the endpoint | `{}` |
|
|
| `serviceMonitor.labels` | Labels for the servicemonitor passed to Prometheus Operator | `{}` |
|
|
| `serviceMonitor.labels` | Labels for the servicemonitor passed to Prometheus Operator | `{}` |
|
|
| `serviceMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `30s` |
|
|
| `serviceMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `30s` |
|
|
| `serviceMonitor.relabelings` | MetricRelabelConfigs to apply to samples before ingestion. | `[]` |
|
|
| `serviceMonitor.relabelings` | MetricRelabelConfigs to apply to samples before ingestion. | `[]` |
|
|
@@ -196,16 +247,33 @@ You have to add --force to your helm upgrade command as the labels of the chart
|
|
| `imageRenderer.image.sha` | image-renderer Image sha (optional) | `""` |
|
|
| `imageRenderer.image.sha` | image-renderer Image sha (optional) | `""` |
|
|
| `imageRenderer.image.pullPolicy` | image-renderer ImagePullPolicy | `Always` |
|
|
| `imageRenderer.image.pullPolicy` | image-renderer ImagePullPolicy | `Always` |
|
|
| `imageRenderer.env` | extra env-vars for image-renderer | `{}` |
|
|
| `imageRenderer.env` | extra env-vars for image-renderer | `{}` |
|
|
|
|
+| `imageRenderer.serviceAccountName` | image-renderer deployment serviceAccountName | `""` |
|
|
| `imageRenderer.securityContext` | image-renderer deployment securityContext | `{}` |
|
|
| `imageRenderer.securityContext` | image-renderer deployment securityContext | `{}` |
|
|
| `imageRenderer.hostAliases` | image-renderer deployment Host Aliases | `[]` |
|
|
| `imageRenderer.hostAliases` | image-renderer deployment Host Aliases | `[]` |
|
|
| `imageRenderer.priorityClassName` | image-renderer deployment priority class | `''` |
|
|
| `imageRenderer.priorityClassName` | image-renderer deployment priority class | `''` |
|
|
-| `imageRenderer.service.portName` | image-renderer service port name | `'http'` |
|
|
|
|
-| `imageRenderer.service.port` | image-renderer service port used by both service and deployment | `8081` |
|
|
|
|
|
|
+| `imageRenderer.service.enabled` | Enable the image-renderer service | `true` |
|
|
|
|
+| `imageRenderer.service.portName` | image-renderer service port name | `http` |
|
|
|
|
+| `imageRenderer.service.port` | image-renderer port used by deployment | `8081` |
|
|
|
|
+| `imageRenderer.service.targetPort` | image-renderer service port used by service | `8081` |
|
|
|
|
+| `imageRenderer.appProtocol` | Adds the appProtocol field to the service | `` |
|
|
|
|
+| `imageRenderer.grafanaSubPath` | Grafana sub path to use for image renderer callback url | `''` |
|
|
| `imageRenderer.podPortName` | name of the image-renderer port on the pod | `http` |
|
|
| `imageRenderer.podPortName` | name of the image-renderer port on the pod | `http` |
|
|
| `imageRenderer.revisionHistoryLimit` | number of image-renderer replica sets to keep | `10` |
|
|
| `imageRenderer.revisionHistoryLimit` | number of image-renderer replica sets to keep | `10` |
|
|
-| `imageRenderer.networkPolicy.limitIngress` | Enable a NetworkPolicy to limit inbound traffic from only the created grafana pods | `true` |
|
|
|
|
-| `imageRenderer.networkPolicy.limitEgress` | Enable a NetworkPolicy to limit outbound traffic to only the created grafana pods | `false` |
|
|
|
|
|
|
+| `imageRenderer.networkPolicy.limitIngress` | Enable a NetworkPolicy to limit inbound traffic from only the created grafana pods | `true` |
|
|
|
|
+| `imageRenderer.networkPolicy.limitEgress` | Enable a NetworkPolicy to limit outbound traffic to only the created grafana pods | `false` |
|
|
| `imageRenderer.resources` | Set resource limits for image-renderer pdos | `{}` |
|
|
| `imageRenderer.resources` | Set resource limits for image-renderer pdos | `{}` |
|
|
|
|
+| `imageRenderer.nodeSelector` | Node labels for pod assignment | `{}` |
|
|
|
|
+| `imageRenderer.tolerations` | Toleration labels for pod assignment | `[]` |
|
|
|
|
+| `imageRenderer.affinity` | Affinity settings for pod assignment | `{}` |
|
|
|
|
+| `networkPolicy.enabled` | Enable creation of NetworkPolicy resources. | `false` |
|
|
|
|
+| `networkPolicy.allowExternal` | Don't require client label for connections | `true` |
|
|
|
|
+| `networkPolicy.explicitNamespacesSelector` | A Kubernetes LabelSelector to explicitly select namespaces from which traffic could be allowed | `{}` |
|
|
|
|
+| `networkPolicy.ingress` | Enable the creation of an ingress network policy | `true` |
|
|
|
|
+| `networkPolicy.egress.enabled` | Enable the creation of an egress network policy | `false` |
|
|
|
|
+| `networkPolicy.egress.ports` | An array of ports to allow for the egress | `[]` |
|
|
|
|
+| `enableKubeBackwardCompatibility` | Enable backward compatibility of kubernetes where pod's defintion version below 1.13 doesn't have the enableServiceLinks option | `false` |
|
|
|
|
+
|
|
|
|
+
|
|
|
|
|
|
### Example ingress with path
|
|
### Example ingress with path
|
|
|
|
|
|
@@ -225,6 +293,9 @@ ingress:
|
|
|
|
|
|
### Example of extraVolumeMounts
|
|
### Example of extraVolumeMounts
|
|
|
|
|
|
|
|
+Volume can be type persistentVolumeClaim or hostPath but not both at same time.
|
|
|
|
+If neither existingClaim or hostPath argument is given then type is emptyDir.
|
|
|
|
+
|
|
```yaml
|
|
```yaml
|
|
- extraVolumeMounts:
|
|
- extraVolumeMounts:
|
|
- name: plugins
|
|
- name: plugins
|
|
@@ -232,6 +303,10 @@ ingress:
|
|
subPath: configs/grafana/plugins
|
|
subPath: configs/grafana/plugins
|
|
existingClaim: existing-grafana-claim
|
|
existingClaim: existing-grafana-claim
|
|
readOnly: false
|
|
readOnly: false
|
|
|
|
+ - name: dashboards
|
|
|
|
+ mountPath: /var/lib/grafana/dashboards
|
|
|
|
+ hostPath: /usr/shared/grafana/dashboards
|
|
|
|
+ readOnly: false
|
|
```
|
|
```
|
|
|
|
|
|
## Import dashboards
|
|
## Import dashboards
|
|
@@ -262,6 +337,14 @@ dashboards:
|
|
gnetId: 2
|
|
gnetId: 2
|
|
revision: 2
|
|
revision: 2
|
|
datasource: Prometheus
|
|
datasource: Prometheus
|
|
|
|
+ loki-dashboard-quick-search:
|
|
|
|
+ gnetId: 12019
|
|
|
|
+ revision: 2
|
|
|
|
+ datasource:
|
|
|
|
+ - name: DS_PROMETHEUS
|
|
|
|
+ value: Prometheus
|
|
|
|
+ - name: DS_LOKI
|
|
|
|
+ value: Loki
|
|
local-dashboard:
|
|
local-dashboard:
|
|
url: https://raw.githubusercontent.com/user/repository/master/dashboards/dashboard.json
|
|
url: https://raw.githubusercontent.com/user/repository/master/dashboards/dashboard.json
|
|
```
|
|
```
|
|
@@ -309,35 +392,18 @@ If the parameter `sidecar.datasources.enabled` is set, an init container is depl
|
|
pod. This container lists all secrets (or configmaps, though not recommended) in the cluster and
|
|
pod. This container lists all secrets (or configmaps, though not recommended) in the cluster and
|
|
filters out the ones with a label as defined in `sidecar.datasources.label`. The files defined in
|
|
filters out the ones with a label as defined in `sidecar.datasources.label`. The files defined in
|
|
those secrets are written to a folder and accessed by grafana on startup. Using these yaml files,
|
|
those secrets are written to a folder and accessed by grafana on startup. Using these yaml files,
|
|
-the data sources in grafana can be imported. The secrets must be created before `helm install` so
|
|
|
|
-that the datasources init container can list the secrets.
|
|
|
|
|
|
+the data sources in grafana can be imported.
|
|
|
|
|
|
Secrets are recommended over configmaps for this usecase because datasources usually contain private
|
|
Secrets are recommended over configmaps for this usecase because datasources usually contain private
|
|
data like usernames and passwords. Secrets are the more appropriate cluster resource to manage those.
|
|
data like usernames and passwords. Secrets are the more appropriate cluster resource to manage those.
|
|
|
|
|
|
-Example datasource config adapted from [Grafana](http://docs.grafana.org/administration/provisioning/#example-datasource-config-file):
|
|
|
|
|
|
+Example values to add a datasource adapted from [Grafana](http://docs.grafana.org/administration/provisioning/#example-datasource-config-file):
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
-apiVersion: v1
|
|
|
|
-kind: Secret
|
|
|
|
-metadata:
|
|
|
|
- name: sample-grafana-datasource
|
|
|
|
- labels:
|
|
|
|
- grafana_datasource: "1"
|
|
|
|
-type: Opaque
|
|
|
|
-stringData:
|
|
|
|
- datasource.yaml: |-
|
|
|
|
- # config file version
|
|
|
|
- apiVersion: 1
|
|
|
|
-
|
|
|
|
- # list of datasources that should be deleted from the database
|
|
|
|
- deleteDatasources:
|
|
|
|
- - name: Graphite
|
|
|
|
- orgId: 1
|
|
|
|
-
|
|
|
|
- # list of datasources to insert/update depending
|
|
|
|
- # whats available in the database
|
|
|
|
- datasources:
|
|
|
|
|
|
+datasources:
|
|
|
|
+ datasources.yaml:
|
|
|
|
+ apiVersion: 1
|
|
|
|
+ datasources:
|
|
# <string, required> name of the datasource. Required
|
|
# <string, required> name of the datasource. Required
|
|
- name: Graphite
|
|
- name: Graphite
|
|
# <string, required> datasource type. Required
|
|
# <string, required> datasource type. Required
|
|
@@ -377,7 +443,6 @@ stringData:
|
|
version: 1
|
|
version: 1
|
|
# <bool> allow users to edit datasources from the UI.
|
|
# <bool> allow users to edit datasources from the UI.
|
|
editable: false
|
|
editable: false
|
|
-
|
|
|
|
```
|
|
```
|
|
|
|
|
|
## Sidecar for notifiers
|
|
## Sidecar for notifiers
|
|
@@ -446,7 +511,7 @@ grafana.ini:
|
|
|
|
|
|
## How to securely reference secrets in grafana.ini
|
|
## How to securely reference secrets in grafana.ini
|
|
|
|
|
|
-This example uses Grafana uses [file providers](https://grafana.com/docs/grafana/latest/administration/configuration/#file-provider) for secret values and the `extraSecretMounts` configuration flag (Additional grafana server secret mounts) to mount the secrets.
|
|
|
|
|
|
+This example uses Grafana [file providers](https://grafana.com/docs/grafana/latest/administration/configuration/#file-provider) for secret values and the `extraSecretMounts` configuration flag (Additional grafana server secret mounts) to mount the secrets.
|
|
|
|
|
|
In grafana.ini:
|
|
In grafana.ini:
|
|
|
|
|
|
@@ -477,15 +542,33 @@ Include in the `extraSecretMounts` configuration flag:
|
|
```yaml
|
|
```yaml
|
|
- extraSecretMounts:
|
|
- extraSecretMounts:
|
|
- name: auth-generic-oauth-secret-mount
|
|
- name: auth-generic-oauth-secret-mount
|
|
- secretName: auth-generic-oauth-secret
|
|
|
|
- defaultMode: 0440
|
|
|
|
- mountPath: /etc/secrets/auth_generic_oauth
|
|
|
|
- readOnly: true
|
|
|
|
|
|
+ secretName: auth-generic-oauth-secret
|
|
|
|
+ defaultMode: 0440
|
|
|
|
+ mountPath: /etc/secrets/auth_generic_oauth
|
|
|
|
+ readOnly: true
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+### extraSecretMounts using a Container Storage Interface (CSI) provider
|
|
|
|
+
|
|
|
|
+This example uses a CSI driver e.g. retrieving secrets using [Azure Key Vault Provider](https://github.com/Azure/secrets-store-csi-driver-provider-azure)
|
|
|
|
+
|
|
|
|
+```yaml
|
|
|
|
+- extraSecretMounts:
|
|
|
|
+ - name: secrets-store-inline
|
|
|
|
+ mountPath: /run/secrets
|
|
|
|
+ readOnly: true
|
|
|
|
+ csi:
|
|
|
|
+ driver: secrets-store.csi.k8s.io
|
|
|
|
+ readOnly: true
|
|
|
|
+ volumeAttributes:
|
|
|
|
+ secretProviderClass: "my-provider"
|
|
|
|
+ nodePublishSecretRef:
|
|
|
|
+ name: akv-creds
|
|
```
|
|
```
|
|
|
|
|
|
## Image Renderer Plug-In
|
|
## Image Renderer Plug-In
|
|
|
|
|
|
-This chart supports enabling [remote image rendering](https://github.com/grafana/grafana-image-renderer/blob/master/docs/remote_rendering_using_docker.md)
|
|
|
|
|
|
+This chart supports enabling [remote image rendering](https://github.com/grafana/grafana-image-renderer/blob/master/README.md#run-in-docker)
|
|
|
|
|
|
```yaml
|
|
```yaml
|
|
imageRenderer:
|
|
imageRenderer:
|
|
@@ -495,3 +578,23 @@ imageRenderer:
|
|
### Image Renderer NetworkPolicy
|
|
### Image Renderer NetworkPolicy
|
|
|
|
|
|
By default the image-renderer pods will have a network policy which only allows ingress traffic from the created grafana instance
|
|
By default the image-renderer pods will have a network policy which only allows ingress traffic from the created grafana instance
|
|
|
|
+
|
|
|
|
+### High Availability for unified alerting
|
|
|
|
+
|
|
|
|
+If you want to run Grafana in a high availability cluster you need to enable
|
|
|
|
+the headless service by setting `headlessService: true` in your `values.yaml`
|
|
|
|
+file.
|
|
|
|
+
|
|
|
|
+As next step you have to setup the `grafana.ini` in your `values.yaml` in a way
|
|
|
|
+that it will make use of the headless service to obtain all the IPs of the
|
|
|
|
+cluster. You should replace ``{{ Name }}`` with the name of your helm deployment.
|
|
|
|
+
|
|
|
|
+```yaml
|
|
|
|
+grafana.ini:
|
|
|
|
+ ...
|
|
|
|
+ unified_alerting:
|
|
|
|
+ enabled: true
|
|
|
|
+ ha_peers: {{ Name }}-headless:9094
|
|
|
|
+ alerting:
|
|
|
|
+ enabled: false
|
|
|
|
+```
|