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:

              1
2
3
4
            
              helm repo add vm https://victoriametrics.github.io/helm-charts/

helm repo update

            

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

              1
2
            
              helm search repo vm/

            

The command must display existing helm chart e.g.

              1
2
3
4
5
6
7
8
9
10
11
12
13
14
            
              NAME                             	CHART VERSION	APP VERSION	DESCRIPTION
vm/victoria-logs-single          	0.9.6        	v1.19.0    	Victoria Logs Single version - high-performance...
vm/victoria-metrics-agent        	0.18.1       	v1.115.0   	Victoria Metrics Agent - collects metrics from ...
vm/victoria-metrics-alert        	0.17.1       	v1.115.0   	Victoria Metrics Alert - executes a list of giv...
vm/victoria-metrics-anomaly      	1.9.0        	v1.21.0    	Victoria Metrics Anomaly Detection - a service ...
vm/victoria-metrics-auth         	0.12.0       	v1.115.0   	Victoria Metrics Auth - is a simple auth proxy ...
vm/victoria-metrics-cluster      	0.20.0       	v1.115.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.12.1       	v1.115.0   	A Helm chart for Running VMCluster on Multiple ...
vm/victoria-metrics-gateway      	0.10.0       	v1.115.0   	Victoria Metrics Gateway - Auth & Rate-Limittin...
vm/victoria-metrics-k8s-stack    	0.43.0       	v1.115.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.17.0       	v1.115.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

                  1
    2
                
                  helm show values vm/victoria-metrics-cluster > values.yaml
    
                
  • For OCI repository

                  1
    2
                
                  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

                  1
    2
                
                  helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE --debug --dry-run
    
                
  • For OCI repository

                  1
    2
                
                  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

                  1
    2
                
                  helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE
    
                
  • For OCI repository

                  1
    2
                
                  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:

              1
2
3
4
5
6
            
              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:

              1
2
            
              helm list -f victoria-metrics -n NAMESPACE

            

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

              1
2
            
              helm history victoria-metrics -n NAMESPACE

            

How to uninstall VictoriaMetrics #

Remove application with command.

              1
2
            
              helm uninstall victoria-metrics -n NAMESPACE

            

Kubernetes compatibility versions #

helm charts tested at kubernetes versions from 1.28 to 1.30.

List of Charts #