ec0abe736a
Some checks are pending
publish-docs / Build (push) Waiting to run
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Signed-off-by: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> Co-authored-by: AndrewChubatiuk <3162380+AndrewChubatiuk@users.noreply.github.com> Co-authored-by: Hui Wang <haley@victoriametrics.com> |
||
---|---|---|
.. | ||
victoria-logs-single | ||
victoria-metrics-agent | ||
victoria-metrics-alert | ||
victoria-metrics-anomaly | ||
victoria-metrics-auth | ||
victoria-metrics-cluster | ||
victoria-metrics-common | ||
victoria-metrics-distributed | ||
victoria-metrics-gateway | ||
victoria-metrics-k8s-stack | ||
victoria-metrics-operator | ||
victoria-metrics-single | ||
_index.md | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
README.md | ||
REQUIREMENTS.md |
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-single 0.5.2 v0.15.0-victorialogs Victoria Logs Single version - high-performance...
vm/victoria-metrics-agent 0.10.9 v1.101.0 Victoria Metrics Agent - collects metrics from ...
vm/victoria-metrics-alert 0.9.9 v1.101.0 Victoria Metrics Alert - executes a list of giv...
vm/victoria-metrics-anomaly 1.3.0 v1.13.0 Victoria Metrics Anomaly Detection - a service ...
vm/victoria-metrics-auth 0.4.13 v1.101.0 Victoria Metrics Auth - is a simple auth proxy ...
vm/victoria-metrics-cluster 0.11.19 v1.101.0 Victoria Metrics Cluster version - high-perform...
vm/victoria-metrics-distributed 0.1.0 v1.101.0 A Helm chart for Running VMCluster on Multiple ...
vm/victoria-metrics-gateway 0.1.62 v1.101.0 Victoria Metrics Gateway - Auth & Rate-Limittin...
vm/victoria-metrics-k8s-stack 0.23.2 v1.101.0 Kubernetes monitoring on VictoriaMetrics stack....
vm/victoria-metrics-operator 0.32.2 v0.45.0 Victoria Metrics Operator
vm/victoria-metrics-single 0.9.22 v1.101.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 resorces 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.