bitnamicharts/grafana-mimir
Bitnami Helm chart for Grafana Mimir
100K+
Grafana Mimir is an open source, horizontally scalable, highly available, multi-tenant, long-term storage for Prometheus.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/grafana-mimir
Looking to use Grafana Mimir in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
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 Mimir Deployment in a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/grafana-mimir
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys grafana-mimir 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
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
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.
This chart can be integrated with Prometheus by setting metrics.enabled
to true. This will expose the Grafana Mimir native Prometheus port in both the containers and services. The services will also have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true
. Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
The mimir configuration file mimir.yaml
is shared across the different components: distributor
, compactor
, ingester
, querier
, query-frontend
and store-gateway
. This is set in the mimir.configuration
value. That value is templated, so you can use other chart values or templates in your configuration. Check the official Mimir Mimir documentation for the list of possible configurations.
The Bitnami grafana-mimir image stores the data at the /bitnami
path of the container. Persistent Volume Claims are used to keep the data across deployments.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property inside each of the subsections: distributor
, compactor
, ingester
, querier
, queryFrontend
and storeGateway
. This is very useful if you need to use enviroment variables in your config file for example to set
mimir:
blockStorage:
backend: s3
config: |
access_key_id: ${S3_ACCESS_KEY_ID}
secret_access_key: ${S3_SECRET_ACCESS_KEY}
bucket_name: mimir
endpoint: s3.us-east-1.amazonaws.com
insecure: false
storeGateway:
extraEnvVars:
- name: S3_ACCESS_KEY_ID
valueFrom:
secretKeyRef:
name: s3-credentials-secret
key: access-key-id
- name: S3_SECRET_ACCESS_KEY
valueFrom:
secretKeyRef:
name: s3-credentials-secret
key: secret-access-key
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values.
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters inside each of the subsections: distributor
, compactor
, ingester
, querier
, queryFrontend
and storeGateway
.
You may want to have Grafana Mimir connect to an external Memcached rather than installing one inside your cluster. Typical reasons for this are to use a managed cache service, or to share a common cache server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the externalMemcached*
parameters. You should also disable the Memcached installation with the enabled
option. Here is an example:
memcachedchunks.enabled=false
externalMemcachedChunks.host=myexternalhost
externalMemcachedChunks.port=11211
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.name | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
namespaceOverride | String to fully override common.names.namespace | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Kubernetes cluster domain name | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployment | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployment | ["infinity"] |
Name | Description | Value |
---|---|---|
mimir.image.registry | Grafana Mimir image registry | REGISTRY_NAME |
mimir.image.repository | Grafana Mimir image repository | REPOSITORY_NAME/grafana-mimir |
mimir.image.digest | Grafana Mimir image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag image tag (immutable tags are recommended) | "" |
mimir.image.pullPolicy | Grafana Mimir image pull policy | IfNotPresent |
mimir.image.pullSecrets | Grafana Mimir image pull secrets | [] |
mimir.dataDir | path to the Mimir data directory | /bitnami/grafana-mimir |
mimir.configuration | Mimir components configuration | "" |
mimir.overrideConfiguration | Mimir components configuration override. Values defined here takes precedence over mimir.configuration | {} |
mimir.existingConfigmap | Name of a ConfigMap with the Mimir configuration | "" |
mimir.httpPrefix.prometheus | HTTP URL path under which the Prometheus api will be served. | /prometheus |
mimir.httpPrefix.alertmanager | HTTP URL path under which the Alertmanager ui and api will be served. | /alertmanager |
mimir.containerPorts.http | Grafana Mimir HTTP container port. This configuration is set mimir.yaml config file and is common for all Grafana Mimir components. | 8080 |
mimir.containerPorts.grpc | Grafana Mimir GRPC container port. This configuration is set mimir.yaml config file and is common for all Grafana Mimircomponents. | 9095 |
mimir.containerPorts.gossipRing | Grafana Mimir memberlist container port. This configuration is set mimir.yaml config file and is common for all Grafana Mimir components. | 7946 |
mimir.gossipRing.service.ports.http | Gossip Ring HTTP headless service port | 7946 |
mimir.gossipRing.service.annotations | Additional custom annotations for Gossip Ring headless service | {} |
mimir.blockStorage.backend | Backend storage to use. NOTE: if minio.enable == true, this configuration will be ignored. | s3 |
mimir.blockStorage.config | Configures connection to the backend store. NOTE: if minio.enable == true, this configuration will be ignored. | {} |
Name | Description | Value |
---|---|---|
alertmanager.enabled | Enable alertmanager deployment | false |
alertmanager.extraEnvVars | Array with extra environment variables to add to alertmanager nodes | [] |
alertmanager.extraEnvVarsCM | Name of existing ConfigMap containing extra env vars for alertmanager nodes | "" |
alertmanager.extraEnvVarsSecret | Name of existing Secret containing extra env vars for alertmanager nodes | "" |
alertmanager.command | Override default container command (useful when using custom images) | [] |
alertmanager.args | Override default container args (useful when using custom images) | [] |
alertmanager.extraArgs | Add additional args to the default container args (useful to override configuration) | [] |
alertmanager.replicaCount | Number of Alertmanager replicas to deploy | 1 |
alertmanager.podManagementPolicy | Statefulset Pod management policy, it needs to be Parallel to be able to complete the cluster join | OrderedReady |
alertmanager.livenessProbe.enabled | Enable livenessProbe on Alertmanager nodes | true |
alertmanager.livenessProbe.initialDelaySeconds | Initial delay seconds for livenessProbe | 30 |
alertmanager.livenessProbe.periodSeconds | Period seconds for livenessProbe | 10 |
alertmanager.livenessProbe.timeoutSeconds | Timeout seconds for livenessProbe | 1 |
alertmanager.livenessProbe.failureThreshold | Failure threshold for livenessProbe | 3 |
alertmanager.livenessProbe.successThreshold | Success threshold for livenessProbe | 1 |
alertmanager.readinessProbe.enabled | Enable readinessProbe on Alertmanager nodes | true |
alertmanager.readinessProbe.initialDelaySeconds | Initial delay seconds for readinessProbe |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/grafana-mimir/README.md