updated charts documentation (#1487)

* updated charts documentation * fixed general doc * fixed typo
VictoriaMetrics · Sep 19, 2024 · b464706 · b464706
1 parent abc64da
commit b464706
Show file tree

Hide file tree

Showing 26 changed files with 743 additions and 1,279 deletions.
diff --git a/README.md b/README.md
@@ -5,29 +5,20 @@
 
 This repository contains helm charts for VictoriaMetrics and VictoriaLogs.
 
-## Add a chart helm repository
+## Add a chart helm repository (can be skipped for OCI repository)
 
 Access a Kubernetes cluster.
 
 Add a chart helm repository with follow commands:
 
- - From HTTPS repository
-
-   ```console
-   helm repo add vm https://victoriametrics.github.io/helm-charts/
-
-   helm repo update
-   ```
- - From OCI repository
-   
-   ```console
-   helm repo add vm oci://ghcr.io/victoriametrics/helm-charts/
+```console
+helm repo add vm https://victoriametrics.github.io/helm-charts/
 
-   helm repo update
-   ```
+helm repo update
+```
 
 List [all charts](#list-of-charts) and versions of `vm` repository available to installation:
-
+    
 ```console
 helm search repo vm/
 ```
@@ -51,25 +42,50 @@ vm/victoria-metrics-single      0.9.22          v1.101.0                Victoria
 
 ## Installing the chart
 
-Export default values of ``victoria-metrics-cluster`` chart to file ``values.yaml``:
+Export default values of `victoria-metrics-cluster` chart to file `values.yaml`:
 
-```console
-helm show values vm/victoria-metrics-cluster > values.yaml
-```
+  - For HTTPS repository
+
+    ```console
+    helm show values vm/victoria-metrics-cluster > values.yaml
+    ```
+  - For OCI repository
+
+    ```console
+    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:
 
-```console
-helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE --debug --dry-run
-```
+  - For HTTPS repository
+
+    ```console
+    helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE --debug --dry-run
+    ```
+
+  - For OCI repository
+
+    ```console
+    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:
 
-```console
-helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE
-```
+  - For HTTPS repository
+    
+    ```console
+    helm install victoria-metrics vm/victoria-metrics-cluster -f values.yaml -n NAMESPACE
+    ```
+
+  - For OCI repository
+
+    ```console
+    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:
 

diff --git a/charts/victoria-logs-single/README.md b/charts/victoria-logs-single/README.md
@@ -1,4 +1,3 @@
-
  ![Version: 0.6.3](https://img.shields.io/badge/Version-0.6.3-informational?style=flat-square)
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/victoriametrics)](https://artifacthub.io/packages/helm/victoriametrics/victoria-logs-single)
 [![Slack](https://img.shields.io/badge/join%20slack-%23victoriametrics-brightgreen.svg)](https://slack.victoriametrics.com/)
@@ -30,73 +29,90 @@ By default, fluentbit will forward logs to VictoriaLogs installation deployed by
 
 Access a Kubernetes cluster.
 
-Add a chart helm repository with follow commands:
-
- - From HTTPS repository
+### Setup chart repository (can be omitted for OCI repositories)
 
-   ```console
-   helm repo add vm https://victoriametrics.github.io/helm-charts/
-
-   helm repo update
-   ```
- - From OCI repository
-
-   ```console
-   helm repo add vm oci://ghcr.io/victoriametrics/helm-charts/
+Add a chart helm repository with follow commands:
 
-   helm repo update
-   ```
+```console
+helm repo add vm https://victoriametrics.github.io/helm-charts/
 
-List versions of ``vm/victoria-logs-single`` chart available to installation:
+helm repo update
+```
+List versions of `vm/victoria-logs-single` chart available to installation:
 
 ```console
 helm search repo vm/victoria-logs-single -l
 ```
 
-Export default values of ``victoria-logs-single`` chart to file ``values.yaml``:
+### Install `victoria-logs-single` chart
 
-```console
-helm show values vm/victoria-logs-single > values.yaml
-```
+Export default values of `victoria-logs-single` chart to file `values.yaml`:
+
+  - For HTTPS repository
+
+    ```console
+    helm show values vm/victoria-logs-single > values.yaml
+    ```
+  - For OCI repository
+
+    ```console
+    helm show values oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-single > values.yaml
+    ```
 
 Change the values according to the need of the environment in ``values.yaml`` file.
 
 Test the installation with command:
 
-```console
-helm install vlsingle vm/victoria-logs-single -f values.yaml -n NAMESPACE --debug --dry-run
-```
+  - For HTTPS repository
+
+    ```console
+    helm install vls vm/victoria-logs-single -f values.yaml -n NAMESPACE --debug --dry-run
+    ```
+
+  - For OCI repository
+
+    ```console
+    helm install vls oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-single -f values.yaml -n NAMESPACE --debug --dry-run
+    ```
 
 Install chart with command:
 
-```console
-helm install vlsingle vm/victoria-logs-single -f values.yaml -n NAMESPACE
-```
+  - For HTTPS repository
+
+    ```console
+    helm install vls vm/victoria-logs-single -f values.yaml -n NAMESPACE
+    ```
+
+  - For OCI repository
+
+    ```console
+    helm install vls oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-single -f values.yaml -n NAMESPACE
+    ```
 
 Get the pods lists by running this commands:
 
 ```console
-kubectl get pods -A | grep 'single'
+kubectl get pods -A | grep 'vls'
 ```
 
 Get the application by running this command:
 
 ```console
-helm list -f vlsingle -n NAMESPACE
+helm list -f vls -n NAMESPACE
 ```
 
-See the history of versions of ``vlsingle`` application with command.
+See the history of versions of `vls` application with command.
 
 ```console
-helm history vlsingle -n NAMESPACE
+helm history vls -n NAMESPACE
 ```
 
 ## How to uninstall
 
 Remove application with command.
 
 ```console
-helm uninstall vlsingle -n NAMESPACE
+helm uninstall vls -n NAMESPACE
 ```
 
 ## Documentation of Helm Chart

diff --git a/charts/victoria-logs-single/README.md.gotmpl b/charts/victoria-logs-single/README.md.gotmpl
@@ -25,92 +25,11 @@ fluent-bit:
 ```
 By default, fluentbit will forward logs to VictoriaLogs installation deployed by this chart.
 
-## How to install
+{{ include "chart.installSection" . }}
 
-Access a Kubernetes cluster.
+{{ include "chart.uninstallSection" . }}
 
-Add a chart helm repository with follow commands:
-
- - From HTTPS repository
-
-   ```console
-   helm repo add vm https://victoriametrics.github.io/helm-charts/
-
-   helm repo update
-   ```
- - From OCI repository
-
-   ```console
-   helm repo add vm oci://ghcr.io/victoriametrics/helm-charts/
-
-   helm repo update
-   ```
-
-List versions of ``vm/victoria-logs-single`` chart available to installation:
-
-```console
-helm search repo vm/victoria-logs-single -l
-```
-
-Export default values of ``victoria-logs-single`` chart to file ``values.yaml``:
-
-```console
-helm show values vm/victoria-logs-single > values.yaml
-```
-
-Change the values according to the need of the environment in ``values.yaml`` file.
-
-Test the installation with command:
-
-```console
-helm install vlsingle vm/victoria-logs-single -f values.yaml -n NAMESPACE --debug --dry-run
-```
-
-Install chart with command:
-
-```console
-helm install vlsingle vm/victoria-logs-single -f values.yaml -n NAMESPACE
-```
-
-Get the pods lists by running this commands:
-
-```console
-kubectl get pods -A | grep 'single'
-```
-
-Get the application by running this command:
-
-```console
-helm list -f vlsingle -n NAMESPACE
-```
-
-See the history of versions of ``vlsingle`` application with command.
-
-```console
-helm history vlsingle -n NAMESPACE
-```
-
-## How to uninstall
-
-Remove application with command.
-
-```console
-helm uninstall vlsingle -n NAMESPACE
-```
-
-## Documentation of Helm Chart
-
-Install ``helm-docs`` following the instructions on this [tutorial](../../REQUIREMENTS.md).
-
-Generate docs with ``helm-docs`` command.
-
-```bash
-cd charts/victoria-logs-single
-
-helm-docs
-```
-
-The markdown generation is entirely go template driven. The tool parses metadata from charts and generates a number of sub-templates that can be referenced in a template file (by default ``README.md.gotmpl``). If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.
+{{ include "chart.helmDocs" . }}
 
 ## Parameters
 

diff --git a/charts/victoria-metrics-agent/CHANGELOG.md b/charts/victoria-metrics-agent/CHANGELOG.md
@@ -1,6 +1,6 @@
 ## Next release
 
-- TODO
+- Fail if no remoteWriteUrls set
 
 ## 0.12.2