From 73d3f5716a11041a1b6384b5f884ca8c8585e0e9 Mon Sep 17 00:00:00 2001 From: zekker6 <1367798+zekker6@users.noreply.github.com> Date: Tue, 1 Oct 2024 19:53:31 +0000 Subject: [PATCH] Automatic update helm docs from VictoriaMetrics/helm-charts@f8fc9f3 Signed-off-by: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com> --- docs/helm/REQUIREMENTS.md | 12 ++++++++++-- docs/helm/victoria-logs-single/README.md | 4 ++-- docs/helm/victoria-metrics-agent/README.md | 4 ++-- docs/helm/victoria-metrics-alert/README.md | 4 ++-- docs/helm/victoria-metrics-anomaly/README.md | 4 ++-- docs/helm/victoria-metrics-auth/README.md | 4 ++-- docs/helm/victoria-metrics-cluster/README.md | 4 ++-- docs/helm/victoria-metrics-distributed/README.md | 4 ++-- docs/helm/victoria-metrics-gateway/README.md | 4 ++-- docs/helm/victoria-metrics-k8s-stack/README.md | 6 +++--- docs/helm/victoria-metrics-operator/README.md | 4 ++-- docs/helm/victoria-metrics-single/README.md | 4 ++-- 12 files changed, 33 insertions(+), 25 deletions(-) diff --git a/docs/helm/REQUIREMENTS.md b/docs/helm/REQUIREMENTS.md index 23c93fb53..fff19387c 100644 --- a/docs/helm/REQUIREMENTS.md +++ b/docs/helm/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/docs/helm/victoria-logs-single/README.md b/docs/helm/victoria-logs-single/README.md index 64ae7ce22..d0731d395 100644 --- a/docs/helm/victoria-logs-single/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-agent/README.md b/docs/helm/victoria-metrics-agent/README.md index a8016a64b..3eab6887b 100644 --- a/docs/helm/victoria-metrics-agent/README.md +++ b/docs/helm/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. diff --git a/docs/helm/victoria-metrics-alert/README.md b/docs/helm/victoria-metrics-alert/README.md index 339848074..8bd1f353e 100644 --- a/docs/helm/victoria-metrics-alert/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-anomaly/README.md b/docs/helm/victoria-metrics-anomaly/README.md index 6fd6a3512..ecf06d1ab 100644 --- a/docs/helm/victoria-metrics-anomaly/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-auth/README.md b/docs/helm/victoria-metrics-auth/README.md index 844662692..0feaf4fbe 100644 --- a/docs/helm/victoria-metrics-auth/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-cluster/README.md b/docs/helm/victoria-metrics-cluster/README.md index 3e1dedbb2..143bc86e1 100644 --- a/docs/helm/victoria-metrics-cluster/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-distributed/README.md b/docs/helm/victoria-metrics-distributed/README.md index 4bd2c0637..c975d0c18 100644 --- a/docs/helm/victoria-metrics-distributed/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-gateway/README.md b/docs/helm/victoria-metrics-gateway/README.md index 76b5a4863..a861034dc 100644 --- a/docs/helm/victoria-metrics-gateway/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-k8s-stack/README.md b/docs/helm/victoria-metrics-k8s-stack/README.md index 452f76dbe..ba928b44b 100644 --- a/docs/helm/victoria-metrics-k8s-stack/README.md +++ b/docs/helm/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 @@ -259,7 +259,7 @@ To run VictoriaMetrics stack locally it's possible to use [Minikube](https://git Run Minikube cluster ``` -minikube start --container-runtime=containerd --extra-config=scheduler.bind-address=0.0.0.0 --extra-config=controller-manager.bind-address=0.0.0.0 +minikube start --container-runtime=containerd --extra-config=scheduler.bind-address=0.0.0.0 --extra-config=controller-manager.bind-address=0.0.0.0 --extra-config=etcd.listen-metrics-urls=http://0.0.0.0:2381 ``` Install helm chart @@ -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/docs/helm/victoria-metrics-operator/README.md b/docs/helm/victoria-metrics-operator/README.md index 5a2bdc9ed..ad8c672be 100644 --- a/docs/helm/victoria-metrics-operator/README.md +++ b/docs/helm/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/docs/helm/victoria-metrics-single/README.md b/docs/helm/victoria-metrics-single/README.md index ec661c4b2..8f15b039c 100644 --- a/docs/helm/victoria-metrics-single/README.md +++ b/docs/helm/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.