Grafana Mimir packaged by Bitnami¶

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 repo add bitnami "https://helm-charts.itboon.top/bitnami" --force-update
helm update bitnami

helm install my-release bitnami/grafana-mimir

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.

Learn more about the default configuration of the chart.

Looking to use Grafana Mimir in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites¶

• Kubernetes 1.19+
• Helm 3.2.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 bitnami/grafana-mimir

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

Uninstalling the Chart¶

To uninstall/delete the my-release deployment:

helm delete my-release

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

Parameters¶

Global parameters¶

Common parameters¶

Common Grafana Mimir Parameters¶

Alertmanager Deployment Parameters¶

Alertmanager Traffic Exposure Parameters¶

Compactor Deployment Parameters¶

Compactor Traffic Exposure Parameters¶

Distributor Deployment Parameters¶

Distributor Traffic Exposure Parameters¶

Gateway Deployment Parameters¶

Gateway Traffic Exposure Parameters¶

Ingester Deployment Parameters¶

Ingester Traffic Exposure Parameters¶

Overrides Exporter Traffic Exposure Parameters¶

Querier Deployment Parameters¶

Querier Traffic Exposure Parameters¶

Query Frontend Deployment Parameters¶

Query Frontend Traffic Exposure Parameters¶

Query Scheduler Traffic Exposure Parameters¶

Store Gateway Deployment Parameters¶

Store Gateway Traffic Exposure Parameters¶

Ruler Deployment Parameters¶

Ruler Persistence Parameters¶

Ruler Traffic Exposure Parameters¶

Init Container Parameters¶

Other Parameters¶

External Memcached (Chunks) Parameters¶

Memcached Sub-chart Parameters (Chunks)¶

External Memcached (Frontend) Parameters¶

Memcached Sub-chart Parameters (Frontend)¶

External Memcached (Index) Parameters¶

Memcached Sub-chart Parameters (Index)¶

External Memcached (Metadata) Parameters¶

Memcached Sub-chart Parameters (Metadata)¶

See https://github.com/bitnami-labs/readme-generator-for-helm to create the table

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

helm install my-release \
  --set mimir.image.debug=true \
  bitnami/grafana-mimir

The above command enables the debug mode in the image.

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

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

Tip: You can use the default values.yaml as starting point.

Once the chart is installed the remote write endpoints for Prometheus or Grafana Agent and the read address to be used as datasource in Grafana will be printed. Example:

    Remote write endpoints for Prometheus or Grafana Agent:
      http://grafana-mimir-gateway.default.svc.cluster.local/api/v1/push
    Read address, Grafana data source (Prometheus) URL:
      http://grafana-mimir-gateway.default.svc.cluster.local/prometheus

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.

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.

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

Troubleshooting¶

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

Upgrading¶

License¶

Copyright © 2023 VMware, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.