diff --git a/REQUIREMENTS.md b/REQUIREMENTS.md index 23c93fb53..fff19387c 100644 --- a/REQUIREMENTS.md +++ b/REQUIREMENTS.md @@ -1,5 +1,13 @@ -# Prerequisites to develop and test Helm Charts - +--- +weight: 0 +title: Requirements +menu: + docs: + weight: 1 + parent: helm +aliases: + - /helm/requirements/index.html +--- ## Kubernetes Cluster You will need to create a Kubernetes cluster locally using [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube), [microk8s](https://microk8s.io), [kind](https://kind.sigs.k8s.io), [k3s](https://k3s.io) or other tools. diff --git a/charts/victoria-logs-single/README.md b/charts/victoria-logs-single/README.md index 64ae7ce22..d0731d395 100644 --- a/charts/victoria-logs-single/README.md +++ b/charts/victoria-logs-single/README.md @@ -6,7 +6,7 @@ Victoria Logs Single version - high-performance, cost-effective and scalable log ## Prerequisites -* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md). +* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/). * PV support on underlying infrastructure. @@ -117,7 +117,7 @@ helm uninstall vls -n NAMESPACE ## Documentation of Helm Chart -Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md). +Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/). Generate docs with ``helm-docs`` command. diff --git a/charts/victoria-logs-single/README.md.gotmpl b/charts/victoria-logs-single/README.md.gotmpl index a546cf7ce..4cd5ca309 100644 --- a/charts/victoria-logs-single/README.md.gotmpl +++ b/charts/victoria-logs-single/README.md.gotmpl @@ -6,7 +6,7 @@ ## Prerequisites -* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md). +* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/). * PV support on underlying infrastructure. diff --git a/charts/victoria-metrics-agent/README.md b/charts/victoria-metrics-agent/README.md index a8016a64b..2544e2254 100644 --- a/charts/victoria-metrics-agent/README.md +++ b/charts/victoria-metrics-agent/README.md @@ -6,7 +6,7 @@ Victoria Metrics Agent - collects metrics from various sources and stores them t ## Prerequisites -* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md). +* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/). ## How to install @@ -122,7 +122,7 @@ helm uninstall vma -n NAMESPACE ## Documentation of Helm Chart -Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md). +Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/). Generate docs with ``helm-docs`` command. @@ -1445,7 +1445,7 @@ periodSeconds: 15 object
 clusterMode: false
-enabled: false
+enabled: true
 replicationFactor: 1
 updateStrategy: {}
 
diff --git a/charts/victoria-metrics-agent/README.md.gotmpl b/charts/victoria-metrics-agent/README.md.gotmpl
index 26a26b494..ddcdeccc3 100644
--- a/charts/victoria-metrics-agent/README.md.gotmpl
+++ b/charts/victoria-metrics-agent/README.md.gotmpl
@@ -6,7 +6,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 {{ include "chart.installSection" . }}
 
diff --git a/charts/victoria-metrics-agent/values.yaml b/charts/victoria-metrics-agent/values.yaml
index 9e51aa014..2957823a8 100644
--- a/charts/victoria-metrics-agent/values.yaml
+++ b/charts/victoria-metrics-agent/values.yaml
@@ -27,7 +27,7 @@ deployment:
 
 # -- [K8s StatefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) specific variables
 statefulset:
-  enabled: false
+  enabled: true
   # -- create cluster of vmagents. Check [here](https://docs.victoriametrics.com/vmagent#scraping-big-number-of-targets)
   # available since [v1.77.2](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.77.2)
   clusterMode: false
diff --git a/charts/victoria-metrics-alert/README.md b/charts/victoria-metrics-alert/README.md
index 339848074..8bd1f353e 100644
--- a/charts/victoria-metrics-alert/README.md
+++ b/charts/victoria-metrics-alert/README.md
@@ -6,7 +6,7 @@ Victoria Metrics Alert - executes a list of given MetricsQL expressions (rules)
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 ## How to install
 
@@ -107,7 +107,7 @@ helm uninstall vma -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-alert/README.md.gotmpl b/charts/victoria-metrics-alert/README.md.gotmpl
index 3bc3ca4be..63f6139f0 100644
--- a/charts/victoria-metrics-alert/README.md.gotmpl
+++ b/charts/victoria-metrics-alert/README.md.gotmpl
@@ -6,7 +6,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 {{ include "chart.installSection" . }}
 
diff --git a/charts/victoria-metrics-anomaly/README.md b/charts/victoria-metrics-anomaly/README.md
index 6fd6a3512..ecf06d1ab 100644
--- a/charts/victoria-metrics-anomaly/README.md
+++ b/charts/victoria-metrics-anomaly/README.md
@@ -9,7 +9,7 @@ Victoria Metrics Anomaly Detection - a service that continuously scans Victoria
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * PV support on underlying infrastructure
 
@@ -111,7 +111,7 @@ helm uninstall vma -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-anomaly/README.md.gotmpl b/charts/victoria-metrics-anomaly/README.md.gotmpl
index c95dbecb6..2a2df3386 100644
--- a/charts/victoria-metrics-anomaly/README.md.gotmpl
+++ b/charts/victoria-metrics-anomaly/README.md.gotmpl
@@ -9,7 +9,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * PV support on underlying infrastructure
 
diff --git a/charts/victoria-metrics-auth/README.md b/charts/victoria-metrics-auth/README.md
index 844662692..0feaf4fbe 100644
--- a/charts/victoria-metrics-auth/README.md
+++ b/charts/victoria-metrics-auth/README.md
@@ -6,7 +6,7 @@ Victoria Metrics Auth - is a simple auth proxy and router for VictoriaMetrics.
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 ## How to install
 
@@ -100,7 +100,7 @@ helm uninstall vma -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-auth/README.md.gotmpl b/charts/victoria-metrics-auth/README.md.gotmpl
index df630149e..0f76cb199 100644
--- a/charts/victoria-metrics-auth/README.md.gotmpl
+++ b/charts/victoria-metrics-auth/README.md.gotmpl
@@ -6,7 +6,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 {{ include "chart.installSection" . }}
 
diff --git a/charts/victoria-metrics-cluster/README.md b/charts/victoria-metrics-cluster/README.md
index 3e1dedbb2..143bc86e1 100644
--- a/charts/victoria-metrics-cluster/README.md
+++ b/charts/victoria-metrics-cluster/README.md
@@ -6,7 +6,7 @@ Victoria Metrics Cluster version - high-performance, cost-effective and scalable
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * PV support on underlying infrastructure
 
@@ -106,7 +106,7 @@ helm uninstall vmc -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-cluster/README.md.gotmpl b/charts/victoria-metrics-cluster/README.md.gotmpl
index c1ee51ae5..bccff6c2c 100644
--- a/charts/victoria-metrics-cluster/README.md.gotmpl
+++ b/charts/victoria-metrics-cluster/README.md.gotmpl
@@ -6,7 +6,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * PV support on underlying infrastructure
 
diff --git a/charts/victoria-metrics-distributed/README.md b/charts/victoria-metrics-distributed/README.md
index 4bd2c0637..c975d0c18 100644
--- a/charts/victoria-metrics-distributed/README.md
+++ b/charts/victoria-metrics-distributed/README.md
@@ -6,7 +6,7 @@ A Helm chart for Running VMCluster on Multiple Availability Zones
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * PV support on underlying infrastructure.
 
@@ -213,7 +213,7 @@ helm uninstall vmd -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-distributed/README.md.gotmpl b/charts/victoria-metrics-distributed/README.md.gotmpl
index 05d053eeb..fbf44fc7d 100644
--- a/charts/victoria-metrics-distributed/README.md.gotmpl
+++ b/charts/victoria-metrics-distributed/README.md.gotmpl
@@ -6,7 +6,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * PV support on underlying infrastructure.
 
diff --git a/charts/victoria-metrics-gateway/README.md b/charts/victoria-metrics-gateway/README.md
index 76b5a4863..a861034dc 100644
--- a/charts/victoria-metrics-gateway/README.md
+++ b/charts/victoria-metrics-gateway/README.md
@@ -15,7 +15,7 @@ Victoria Metrics Gateway - Auth & Rate-Limitting proxy for Victoria Metrics
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 * PV support on underlying infrastructure
 
 ## Chart Details
@@ -167,7 +167,7 @@ helm uninstall vmg -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-gateway/README.md.gotmpl b/charts/victoria-metrics-gateway/README.md.gotmpl
index 29bd5357f..9c74f30d9 100644
--- a/charts/victoria-metrics-gateway/README.md.gotmpl
+++ b/charts/victoria-metrics-gateway/README.md.gotmpl
@@ -15,7 +15,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 * PV support on underlying infrastructure
 
 ## Chart Details
diff --git a/charts/victoria-metrics-k8s-stack/README.md b/charts/victoria-metrics-k8s-stack/README.md
index 4832a1e35..ba928b44b 100644
--- a/charts/victoria-metrics-k8s-stack/README.md
+++ b/charts/victoria-metrics-k8s-stack/README.md
@@ -158,7 +158,7 @@ grafana:
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * Add dependency chart repositories
 
@@ -370,7 +370,7 @@ kubectl apply -f https://raw.githubusercontent.com/VictoriaMetrics/operator/v0.1
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-k8s-stack/README.md.gotmpl b/charts/victoria-metrics-k8s-stack/README.md.gotmpl
index 865b25030..3d42aa31c 100644
--- a/charts/victoria-metrics-k8s-stack/README.md.gotmpl
+++ b/charts/victoria-metrics-k8s-stack/README.md.gotmpl
@@ -160,7 +160,7 @@ grafana:
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 * Add dependency chart repositories
 
diff --git a/charts/victoria-metrics-operator/README.md b/charts/victoria-metrics-operator/README.md
index 5a2bdc9ed..ad8c672be 100644
--- a/charts/victoria-metrics-operator/README.md
+++ b/charts/victoria-metrics-operator/README.md
@@ -5,7 +5,7 @@ Victoria Metrics Operator
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 * PV support on underlying infrastructure.
 
 ## ArgoCD issues
@@ -175,7 +175,7 @@ helm uninstall vmo -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-operator/README.md.gotmpl b/charts/victoria-metrics-operator/README.md.gotmpl
index a4e21fce0..6c35359f5 100644
--- a/charts/victoria-metrics-operator/README.md.gotmpl
+++ b/charts/victoria-metrics-operator/README.md.gotmpl
@@ -5,7 +5,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 * PV support on underlying infrastructure.
 
 ## ArgoCD issues
diff --git a/charts/victoria-metrics-single/README.md b/charts/victoria-metrics-single/README.md
index ec661c4b2..8f15b039c 100644
--- a/charts/victoria-metrics-single/README.md
+++ b/charts/victoria-metrics-single/README.md
@@ -5,7 +5,7 @@ Victoria Metrics Single version - high-performance, cost-effective and scalable
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 * PV support on underlying infrastructure.
 
 ## Chart Details
@@ -106,7 +106,7 @@ helm uninstall vms -n NAMESPACE
 
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.
 
diff --git a/charts/victoria-metrics-single/README.md.gotmpl b/charts/victoria-metrics-single/README.md.gotmpl
index f8cdaa2ef..66686c00b 100644
--- a/charts/victoria-metrics-single/README.md.gotmpl
+++ b/charts/victoria-metrics-single/README.md.gotmpl
@@ -5,7 +5,7 @@
 
 ## Prerequisites
 
-* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](../../REQUIREMENTS.md).
+* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 * PV support on underlying infrastructure.
 
 ## Chart Details
diff --git a/hack/docs/template.tmpl b/hack/docs/template.tmpl
index d6d55ba4a..502a3fcb5 100644
--- a/hack/docs/template.tmpl
+++ b/hack/docs/template.tmpl
@@ -126,7 +126,7 @@ helm uninstall {{ $release }} -n NAMESPACE
 {{- define "chart.helmDocs" -}}
 ## Documentation of Helm Chart
 
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
+Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
 
 Generate docs with ``helm-docs`` command.