Introducing our new CEO Don Johnson - Read More

bitnamicharts/grafana-mimir

Verified Publisher

By VMware

Updated 1 day ago

Bitnami Helm chart for Grafana Mimir

Image
Helm
Databases & Storage
Monitoring & Observability
0

100K+

Bitnami package for Grafana Mimir

Grafana Mimir is an open source, horizontally scalable, highly available, multi-tenant, long-term storage for Prometheus.

Overview of Grafana Mimir

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.

TL;DR

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.

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 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.

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.0+
  • PV provisioner support in the underlying infrastructure

Installing the Chart

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 and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_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

Configuration and installation details

Resource requests and limits

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.

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.

Prometheus metrics

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.

Mimir configuration

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.

Data

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.

Backup and restore

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.

Additional environment variables

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.

Pod affinity

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.

External cache support

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

Parameters

Global parameters
NameDescriptionValue
global.imageRegistryGlobal Docker image registry""
global.imagePullSecretsGlobal Docker registry secret names as an array[]
global.defaultStorageClassGlobal default StorageClass for Persistent Volume(s)""
global.storageClassDEPRECATED: use global.defaultStorageClass instead""
global.security.allowInsecureImagesAllows skipping image verificationfalse
global.compatibility.openshift.adaptSecurityContextAdapt 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
Common parameters
NameDescriptionValue
kubeVersionOverride Kubernetes version""
nameOverrideString to partially override common.names.name""
fullnameOverrideString to fully override common.names.fullname""
namespaceOverrideString to fully override common.names.namespace""
commonLabelsLabels to add to all deployed objects{}
commonAnnotationsAnnotations to add to all deployed objects{}
clusterDomainKubernetes cluster domain namecluster.local
extraDeployArray of extra objects to deploy with the release[]
diagnosticMode.enabledEnable diagnostic mode (all probes will be disabled and the command will be overridden)false
diagnosticMode.commandCommand to override all containers in the deployment["sleep"]
diagnosticMode.argsArgs to override all containers in the deployment["infinity"]
Common Grafana Mimir Parameters
NameDescriptionValue
mimir.image.registryGrafana Mimir image registryREGISTRY_NAME
mimir.image.repositoryGrafana Mimir image repositoryREPOSITORY_NAME/grafana-mimir
mimir.image.digestGrafana 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.pullPolicyGrafana Mimir image pull policyIfNotPresent
mimir.image.pullSecretsGrafana Mimir image pull secrets[]
mimir.dataDirpath to the Mimir data directory/bitnami/grafana-mimir
mimir.configurationMimir components configuration""
mimir.overrideConfigurationMimir components configuration override. Values defined here takes precedence over mimir.configuration{}
mimir.existingConfigmapName of a ConfigMap with the Mimir configuration""
mimir.httpPrefix.prometheusHTTP URL path under which the Prometheus api will be served./prometheus
mimir.httpPrefix.alertmanagerHTTP URL path under which the Alertmanager ui and api will be served./alertmanager
mimir.containerPorts.httpGrafana Mimir HTTP container port. This configuration is set mimir.yaml config file and is common for all Grafana Mimir components.8080
mimir.containerPorts.grpcGrafana Mimir GRPC container port. This configuration is set mimir.yaml config file and is common for all Grafana Mimircomponents.9095
mimir.containerPorts.gossipRingGrafana 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.httpGossip Ring HTTP headless service port7946
mimir.gossipRing.service.annotationsAdditional custom annotations for Gossip Ring headless service{}
mimir.blockStorage.backendBackend storage to use. NOTE: if minio.enable == true, this configuration will be ignored.s3
mimir.blockStorage.configConfigures connection to the backend store. NOTE: if minio.enable == true, this configuration will be ignored.{}
Alertmanager Deployment Parameters
NameDescriptionValue
alertmanager.enabledEnable alertmanager deploymentfalse
alertmanager.extraEnvVarsArray with extra environment variables to add to alertmanager nodes[]
alertmanager.extraEnvVarsCMName of existing ConfigMap containing extra env vars for alertmanager nodes""
alertmanager.extraEnvVarsSecretName of existing Secret containing extra env vars for alertmanager nodes""
alertmanager.commandOverride default container command (useful when using custom images)[]
alertmanager.argsOverride default container args (useful when using custom images)[]
alertmanager.extraArgsAdd additional args to the default container args (useful to override configuration)[]
alertmanager.replicaCountNumber of Alertmanager replicas to deploy1
alertmanager.podManagementPolicyStatefulset Pod management policy, it needs to be Parallel to be able to complete the cluster joinOrderedReady
alertmanager.livenessProbe.enabledEnable livenessProbe on Alertmanager nodestrue
alertmanager.livenessProbe.initialDelaySecondsInitial delay seconds for livenessProbe30
alertmanager.livenessProbe.periodSecondsPeriod seconds for livenessProbe10
alertmanager.livenessProbe.timeoutSecondsTimeout seconds for livenessProbe1
alertmanager.livenessProbe.failureThresholdFailure threshold for livenessProbe3
alertmanager.livenessProbe.successThresholdSuccess threshold for livenessProbe1
alertmanager.readinessProbe.enabledEnable readinessProbe on Alertmanager nodestrue
alertmanager.readinessProbe.initialDelaySecondsInitial 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

Docker Pull Command

docker pull bitnamicharts/grafana-mimir
Bitnami