Helm Charts

Artifact Hub Helm: v3 License Slack X Reddit

This repository contains helm charts for VictoriaMetrics and VictoriaLogs.

Add a chart helm repository (can be skipped for OCI repository) #

Access a Kubernetes cluster.

Add a chart helm repository with follow commands:

      helm repo add vm https://victoriametrics.github.io/helm-charts/

helm repo update

List all charts and versions of vm repository available to installation:

      helm search repo vm/

The command must display existing helm chart e.g.

      NAME                             	CHART VERSION	APP VERSION         	DESCRIPTION
vm/victoria-logs-cluster                0.2.9           v1.53.0                 VictoriaLogs cluster version - high-performance...
vm/victoria-logs-single                 0.13.10         v1.53.0                 Victoria Logs Single version - high-performance...
vm/victoria-metrics-agent               0.19.0          v1.116.0                Victoria Metrics Agent - collects metrics from ...
vm/victoria-metrics-alert               0.18.0          v1.116.0                Victoria Metrics Alert - executes a list of giv...
vm/victoria-metrics-anomaly             1.9.1           v1.22.0-experimental    Victoria Metrics Anomaly Detection - a service ...
vm/victoria-metrics-auth                0.13.0          v1.116.0                Victoria Metrics Auth - is a simple auth proxy ...
vm/victoria-metrics-cluster             0.21.0          v1.116.0                Victoria Metrics Cluster version - high-perform...
vm/victoria-metrics-common              0.0.42                                  Victoria Metrics Common - contains shared templ...
vm/victoria-metrics-distributed         0.14.0          v1.116.0                A Helm chart for Running VMCluster on Multiple ...
vm/victoria-metrics-gateway             0.11.0          v1.116.0                Victoria Metrics Gateway - Auth & Rate-Limittin...
vm/victoria-metrics-k8s-stack           0.45.0          v1.116.0                Kubernetes monitoring on VictoriaMetrics stack....
vm/victoria-metrics-operator            0.45.0          v0.56.0                 Victoria Metrics Operator                         
vm/victoria-metrics-operator-crds       0.1.0           v0.56.0                 Victoria Metrics Operator CRDs                    
vm/victoria-metrics-single              0.18.0          v1.116.0                Victoria Metrics Single version - high-performa...

Installing the chart #

Export default values of victoria-metrics-cluster chart to file values.yaml:

  • For HTTPS repository

          helm show values vm/victoria-metrics-cluster > values.yaml

  • For OCI repository

          helm show values oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-agent > values.yaml

Change the values according to the need of the environment in values.yaml file.

Test the installation with command:

  • For HTTPS repository

          helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE --debug --dry-run

  • For OCI repository

          helm install victoria-metrics oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-cluster -f values.yaml -n NAMESPACE --debug --dry-run

Install chart with command:

  • For HTTPS repository

          helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE

  • For OCI repository

          helm install victoria-metrics oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-cluster -f values.yaml -n NAMESPACE

Validate installation #

Get the pods lists by running these commands:

      kubectl get pods -A | grep 'victoria-metrics'

# or list all resources of victoria-metrics

kubectl get all -n NAMESPACE | grep victoria

Get the application by running this commands:

      helm list -f victoria-metrics -n NAMESPACE

See the history of versions of victoria-metrics application with command.

      helm history victoria-metrics -n NAMESPACE

How to uninstall VictoriaMetrics #

Remove application with command.

      helm uninstall victoria-metrics -n NAMESPACE

Kubernetes compatibility versions #

helm charts tested at kubernetes versions from 1.28 to 1.30.

List of Charts #

Operator-based charts #

Most charts render Kubernetes workloads (Deployments, StatefulSets, DaemonSets, Services) directly, so their workload settings are configured through chart values. The following charts render VictoriaMetrics operator custom resources instead, and the operator creates the workloads from them:

  • VictoriaMetrics K8s Stack installs the operator by default (victoria-metrics-operator.enabled);
  • VictoriaMetrics Distributed installs the operator by default through its victoria-metrics-k8s-stack dependency; if that dependency or its victoria-metrics-operator subchart is disabled, the operator must already be installed.

For VictoriaMetrics, VictoriaLogs and VictoriaTraces components of these charts, workloads can be configured only through the fields of the custom resource spec, see the operator API reference . Bundled third-party subcharts, such as grafana and kube-state-metrics, are still configured with their chart values. If you need full control over Kubernetes resources, use the standalone charts for each component instead.