github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

Automatic update helm docs from VictoriaMetrics/helm-charts@f8fc9f3

Browse source 
Signed-off-by: Github Actions <133988544+victoriametrics-bot@users.noreply.github.com>
This commit is contained in:
zekker6 2024-10-01 19:53:31 +00:00 committed by Github Actions
parent 456aeda605
commit 73d3f5716a
No known key found for this signature in database
GPG key ID: 261D0043999236A6
12 changed files with 33 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/helm/REQUIREMENTS.md
View file

@ -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 ## 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. 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.

4
docs/helm/victoria-logs-single/README.md
View file

@ -6,7 +6,7 @@ Victoria Logs Single version - high-performance, cost-effective and scalable log
## Prerequisites ## 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. * PV support on underlying infrastructure.
@ -117,7 +117,7 @@ helm uninstall vls -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-agent/README.md
View file

@ -6,7 +6,7 @@ Victoria Metrics Agent - collects metrics from various sources and stores them t
## Prerequisites ## 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 ## How to install
@ -122,7 +122,7 @@ helm uninstall vma -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-alert/README.md
View file

@ -6,7 +6,7 @@ Victoria Metrics Alert - executes a list of given MetricsQL expressions (rules)
## Prerequisites ## 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 ## How to install
@ -107,7 +107,7 @@ helm uninstall vma -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-anomaly/README.md
View file

@ -9,7 +9,7 @@ Victoria Metrics Anomaly Detection - a service that continuously scans Victoria
## Prerequisites ## 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 * PV support on underlying infrastructure
@ -111,7 +111,7 @@ helm uninstall vma -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-auth/README.md
View file

@ -6,7 +6,7 @@ Victoria Metrics Auth - is a simple auth proxy and router for VictoriaMetrics.
## Prerequisites ## 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 ## How to install
@ -100,7 +100,7 @@ helm uninstall vma -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-cluster/README.md
View file

@ -6,7 +6,7 @@ Victoria Metrics Cluster version - high-performance, cost-effective and scalable
## Prerequisites ## 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 * PV support on underlying infrastructure
@ -106,7 +106,7 @@ helm uninstall vmc -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-distributed/README.md
View file

@ -6,7 +6,7 @@ A Helm chart for Running VMCluster on Multiple Availability Zones
## Prerequisites ## 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. * PV support on underlying infrastructure.
@ -213,7 +213,7 @@ helm uninstall vmd -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-gateway/README.md
View file

@ -15,7 +15,7 @@ Victoria Metrics Gateway - Auth & Rate-Limitting proxy for Victoria Metrics
## Prerequisites ## 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 * PV support on underlying infrastructure
## Chart Details ## Chart Details
@ -167,7 +167,7 @@ helm uninstall vmg -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

6
docs/helm/victoria-metrics-k8s-stack/README.md
View file

@ -158,7 +158,7 @@ grafana:
## Prerequisites ## 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 * Add dependency chart repositories
@ -259,7 +259,7 @@ To run VictoriaMetrics stack locally it's possible to use [Minikube](https://git
Run Minikube cluster 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 Install helm chart
@ -370,7 +370,7 @@ kubectl apply -f https://raw.githubusercontent.com/VictoriaMetrics/operator/v0.1
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-operator/README.md
View file

@ -5,7 +5,7 @@ Victoria Metrics Operator
## Prerequisites ## 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. * PV support on underlying infrastructure.
## ArgoCD issues ## ArgoCD issues
@ -175,7 +175,7 @@ helm uninstall vmo -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.

4
docs/helm/victoria-metrics-single/README.md
View file

@ -5,7 +5,7 @@ Victoria Metrics Single version - high-performance, cost-effective and scalable
## Prerequisites ## 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. * PV support on underlying infrastructure.
## Chart Details ## Chart Details
@ -106,7 +106,7 @@ helm uninstall vms -n NAMESPACE
## Documentation of Helm Chart ## 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. Generate docs with ``helm-docs`` command.