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@428cb36 (#7072)

Browse source 
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>
This commit is contained in:
Github Actions 2024-09-23 08:17:34 +03:00 committed by GitHub
parent 0ada781cf2
commit 4dc85613a2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 6116 additions and 4882 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/helm/README.md
View file

@ -123,14 +123,14 @@ helm charts tested at kubernetes versions from 1.28 to 1.30.
## List of Charts ## List of Charts
- [Victoria Logs Single-Node](./charts/victoria-logs-single) - [VictoriaLogs Single](https://docs.victoriametrics.com/helm/victorialogs-single)
- [Victoria Metrics Agent](./charts/victoria-metrics-agent) - [VictoriaMetrics Agent](https://docs.victoriametrics.com/helm/victoriametrics-agent)
- [Victoria Metrics Alert](./charts/victoria-metrics-alert) - [VictoriaMetrics Alert](https://docs.victoriametrics.com/helm/victoriametrics-alert)
- [Victoria Metrics Anomaly](./charts/victoria-metrics-anomaly) - [VictoriaMetrics Anomaly](https://docs.victoriametrics.com/helm/victoriametrics-anomaly)
- [Victoria Metrics Auth](./charts/victoria-metrics-auth) - [VictoriaMetrics Auth](https://docs.victoriametrics.com/helm/victoriametrics-auth)
- [Victoria Metrics Cluster](./charts/victoria-metrics-cluster) - [VictoriaMetrics Cluster](https://docs.victoriametrics.com/helm/victoriametrics-cluster)
- [Victoria Metrics Gateway](./charts/victoria-metrics-gateway) - [VictoriaMetrics Gateway](https://docs.victoriametrics.com/helm/victoriametrics-gateway)
- [Victoria Metrics Distributed](./charts/victoria-metrics-distributed) - [VictoriaMetrics Distributed](https://docs.victoriametrics.com/helm/victoriametrics-distributed)
- [Victoria Metrics k8s Stack](./charts/victoria-metrics-k8s-stack) - [VictoriaMetrics K8s Stack](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack)
- [Victoria Metrics Operator](./charts/victoria-metrics-operator) - [VictoriaMetrics Operator](https://docs.victoriametrics.com/helm/victoriametrics-operator)
- [Victoria Metrics Single-node](./charts/victoria-metrics-single) - [VictoriaMetrics Single](https://docs.victoriametrics.com/helm/victoriametrics-single)

3
docs/helm/_index.md
View file

@ -3,8 +3,9 @@ weight: 0
title: Helm Charts title: Helm Charts
menu: menu:
docs: docs:
weight: 0 weight: 35
identifier: helm identifier: helm
pageRef: /helm/
aliases: aliases:
- /helm - /helm
- /helm/index.html - /helm/index.html

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

File diff suppressed because it is too large Load diff

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

File diff suppressed because it is too large Load diff

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

File diff suppressed because it is too large Load diff

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

@ -131,19 +131,20 @@ For more `vmanomaly` config parameters see https://docs.victoriametrics.com/anom
Change the values according to the need of the environment in ``victoria-metrics-anomaly/values.yaml`` file. Change the values according to the need of the environment in ``victoria-metrics-anomaly/values.yaml`` file.
<table> <table class="helm-vars">
<thead> <thead>
<th>Key</th> <th class="helm-vars-key">Key</th>
<th>Type</th> <th class="helm-vars-type">Type</th>
<th>Default</th> <th class="helm-vars-default">Default</th>
<th>Description</th> <th class="helm-vars-description">Description</th>
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>affinity</td> <td>affinity</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Affinity configurations</p> <td><p>Affinity configurations</p>
@ -152,8 +153,9 @@ Change the values according to the need of the environment in ``victoria-metrics
<tr> <tr>
<td>annotations</td> <td>annotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Annotations to be added to the deployment</p> <td><p>Annotations to be added to the deployment</p>
@ -162,8 +164,8 @@ Change the values according to the need of the environment in ``victoria-metrics
<tr> <tr>
<td>config</td> <td>config</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
models: {} <code class="language-yaml">models: {}
preset: "" preset: ""
reader: reader:
class: vm class: vm
@ -176,6 +178,7 @@ writer:
class: vm class: vm
datasource_url: "" datasource_url: ""
tenant_id: "" tenant_id: ""
</code>
</pre> </pre>
</td> </td>
<td><p>Full <a href="https://docs.victoriametrics.com/anomaly-detection/components/" target="_blank">vmanomaly config section</a></p> <td><p>Full <a href="https://docs.victoriametrics.com/anomaly-detection/components/" target="_blank">vmanomaly config section</a></p>
@ -184,8 +187,9 @@ writer:
<tr> <tr>
<td>config.models</td> <td>config.models</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/models/" target="_blank">Models section</a></p> <td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/models/" target="_blank">Models section</a></p>
@ -194,8 +198,9 @@ writer:
<tr> <tr>
<td>config.preset</td> <td>config.preset</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Whether to use preset configuration. If not empty, preset name should be specified.</p> <td><p>Whether to use preset configuration. If not empty, preset name should be specified.</p>
@ -204,12 +209,13 @@ writer:
<tr> <tr>
<td>config.reader</td> <td>config.reader</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
class: vm <code class="language-yaml">class: vm
datasource_url: "" datasource_url: ""
queries: {} queries: {}
sampling_period: 1m sampling_period: 1m
tenant_id: "" tenant_id: ""
</code>
</pre> </pre>
</td> </td>
<td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/reader/" target="_blank">Reader section</a></p> <td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/reader/" target="_blank">Reader section</a></p>
@ -218,8 +224,9 @@ tenant_id: ""
<tr> <tr>
<td>config.reader.class</td> <td>config.reader.class</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
vm <code class="language-yaml">vm
</code>
</pre> </pre>
</td> </td>
<td><p>Name of the class needed to enable reading from VictoriaMetrics or Prometheus. VmReader is the default option, if not specified.</p> <td><p>Name of the class needed to enable reading from VictoriaMetrics or Prometheus. VmReader is the default option, if not specified.</p>
@ -228,8 +235,9 @@ vm
<tr> <tr>
<td>config.reader.datasource_url</td> <td>config.reader.datasource_url</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Datasource URL address. Required for example <code>http://single-victoria-metrics-single-server.default.svc.cluster.local:8428</code> or <code>http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480</code></p> <td><p>Datasource URL address. Required for example <code>http://single-victoria-metrics-single-server.default.svc.cluster.local:8428</code> or <code>http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480</code></p>
@ -238,18 +246,20 @@ vm
<tr> <tr>
<td>config.reader.queries</td> <td>config.reader.queries</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Required. PromQL/MetricsQL query to select data in format: QUERY_ALIAS: &ldquo;QUERY&rdquo;. As accepted by &ldquo;/query_range?query=%s&rdquo;. See <a href="https://docs.victoriametrics.com/anomaly-detection/components/reader/#per-query-parameters" target="_blank">https://docs.victoriametrics.com/anomaly-detection/components/reader/#per-query-parameters</a> for more details.</p> <td><p>Required. PromQL/MetricsQL query to select data in format: QUERY_ALIAS: &ldquo;QUERY&rdquo;. As accepted by &ldquo;/query_range?query=%s&rdquo;. See <a href="https://docs.victoriametrics.com/anomaly-detection/components/reader/#per-query-parameters" target="_blank">here</a> for more details.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>config.reader.sampling_period</td> <td>config.reader.sampling_period</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
1m <code class="language-yaml">1m
</code>
</pre> </pre>
</td> </td>
<td><p>Frequency of the points returned. Will be converted to <code>/query_range?step=%s</code> param (in seconds). <strong>Required</strong> since 1.9.0.</p> <td><p>Frequency of the points returned. Will be converted to <code>/query_range?step=%s</code> param (in seconds). <strong>Required</strong> since 1.9.0.</p>
@ -258,8 +268,9 @@ vm
<tr> <tr>
<td>config.reader.tenant_id</td> <td>config.reader.tenant_id</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs</p> <td><p>For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs</p>
@ -268,8 +279,9 @@ vm
<tr> <tr>
<td>config.schedulers</td> <td>config.schedulers</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/scheduler/" target="_blank">Scheduler section</a></p> <td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/scheduler/" target="_blank">Scheduler section</a></p>
@ -278,10 +290,11 @@ vm
<tr> <tr>
<td>config.writer</td> <td>config.writer</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
class: vm <code class="language-yaml">class: vm
datasource_url: "" datasource_url: ""
tenant_id: "" tenant_id: ""
</code>
</pre> </pre>
</td> </td>
<td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/writer/" target="_blank">Writer section</a></p> <td><p><a href="https://docs.victoriametrics.com/anomaly-detection/components/writer/" target="_blank">Writer section</a></p>
@ -290,8 +303,9 @@ tenant_id: ""
<tr> <tr>
<td>config.writer.class</td> <td>config.writer.class</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
vm <code class="language-yaml">vm
</code>
</pre> </pre>
</td> </td>
<td><p>Name of the class needed to enable writing to VictoriaMetrics or Prometheus. VmWriter is the default option, if not specified.</p> <td><p>Name of the class needed to enable writing to VictoriaMetrics or Prometheus. VmWriter is the default option, if not specified.</p>
@ -300,8 +314,9 @@ vm
<tr> <tr>
<td>config.writer.datasource_url</td> <td>config.writer.datasource_url</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Datasource URL address. Required for example <code>http://single-victoria-metrics-single-server.default.svc.cluster.local:8428</code> or <code>http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480</code></p> <td><p>Datasource URL address. Required for example <code>http://single-victoria-metrics-single-server.default.svc.cluster.local:8428</code> or <code>http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480</code></p>
@ -310,8 +325,9 @@ vm
<tr> <tr>
<td>config.writer.tenant_id</td> <td>config.writer.tenant_id</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs</p> <td><p>For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs</p>
@ -320,8 +336,9 @@ vm
<tr> <tr>
<td>configMapAnnotations</td> <td>configMapAnnotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Annotations to be added to configMap</p> <td><p>Annotations to be added to configMap</p>
@ -330,26 +347,31 @@ vm
<tr> <tr>
<td>containerWorkingDir</td> <td>containerWorkingDir</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
/vmanomaly <code class="language-yaml">/vmanomaly
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Container working directory</p>
</td>
</tr> </tr>
<tr> <tr>
<td>emptyDir</td> <td>emptyDir</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Empty dir configuration when persistence is disabled</p>
</td>
</tr> </tr>
<tr> <tr>
<td>env</td> <td>env</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Additional environment variables (ex.: secret tokens, flags)</p> <td><p>Additional environment variables (ex.: secret tokens, flags)</p>
@ -358,35 +380,42 @@ vm
<tr> <tr>
<td>envFrom</td> <td>envFrom</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Specify alternative source for env variables</p>
</td>
</tr> </tr>
<tr> <tr>
<td>extraArgs</td> <td>extraArgs</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Extra command line arguments for container of component</p>
</td>
</tr> </tr>
<tr> <tr>
<td>extraContainers</td> <td>extraContainers</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Extra containers to run in a pod with anomaly container</p>
</td>
</tr> </tr>
<tr> <tr>
<td>extraHostPathMounts</td> <td>extraHostPathMounts</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Additional hostPath mounts</p> <td><p>Additional hostPath mounts</p>
@ -395,8 +424,9 @@ vm
<tr> <tr>
<td>extraVolumeMounts</td> <td>extraVolumeMounts</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Extra Volume Mounts for the container</p> <td><p>Extra Volume Mounts for the container</p>
@ -405,8 +435,9 @@ vm
<tr> <tr>
<td>extraVolumes</td> <td>extraVolumes</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Extra Volumes for the pod</p> <td><p>Extra Volumes for the pod</p>
@ -415,44 +446,54 @@ vm
<tr> <tr>
<td>fullnameOverride</td> <td>fullnameOverride</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Full name prefix override</p>
</td>
</tr> </tr>
<tr> <tr>
<td>global.compatibility.openshift.adaptSecurityContext</td> <td>global.compatibility</td>
<td>string</td> <td>object</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
auto <code class="language-yaml">openshift:
adaptSecurityContext: auto
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Openshift security context compatibility configuration</p>
</td>
</tr> </tr>
<tr> <tr>
<td>global.image.registry</td> <td>global.image.registry</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Image registry, that can be shared across multiple helm charts</p>
</td>
</tr> </tr>
<tr> <tr>
<td>global.imagePullSecrets</td> <td>global.imagePullSecrets</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Image pull secrets, that can be shared across multiple helm charts</p>
</td>
</tr> </tr>
<tr> <tr>
<td>image.pullPolicy</td> <td>image.pullPolicy</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
IfNotPresent <code class="language-yaml">IfNotPresent
</code>
</pre> </pre>
</td> </td>
<td><p>Pull policy of Docker image</p> <td><p>Pull policy of Docker image</p>
@ -461,8 +502,9 @@ IfNotPresent
<tr> <tr>
<td>image.registry</td> <td>image.registry</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Victoria Metrics anomaly Docker registry</p> <td><p>Victoria Metrics anomaly Docker registry</p>
@ -471,8 +513,9 @@ IfNotPresent
<tr> <tr>
<td>image.repository</td> <td>image.repository</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
victoriametrics/vmanomaly <code class="language-yaml">victoriametrics/vmanomaly
</code>
</pre> </pre>
</td> </td>
<td><p>Victoria Metrics anomaly Docker repository and image name</p> <td><p>Victoria Metrics anomaly Docker repository and image name</p>
@ -481,8 +524,9 @@ victoriametrics/vmanomaly
<tr> <tr>
<td>image.tag</td> <td>image.tag</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
v1.15.9 <code class="language-yaml">v1.15.9
</code>
</pre> </pre>
</td> </td>
<td><p>Tag of Docker image</p> <td><p>Tag of Docker image</p>
@ -491,20 +535,23 @@ v1.15.9
<tr> <tr>
<td>imagePullSecrets</td> <td>imagePullSecrets</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Image pull secrets</p>
</td>
</tr> </tr>
<tr> <tr>
<td>license</td> <td>license</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
key: "" <code class="language-yaml">key: ""
secret: secret:
key: "" key: ""
name: "" name: ""
</code>
</pre> </pre>
</td> </td>
<td><p>License key configuration for vmanomaly. See <a href="https://docs.victoriametrics.com/vmanomaly#licensing" target="_blank">docs</a> Required starting from v1.5.0.</p> <td><p>License key configuration for vmanomaly. See <a href="https://docs.victoriametrics.com/vmanomaly#licensing" target="_blank">docs</a> Required starting from v1.5.0.</p>
@ -513,8 +560,9 @@ secret:
<tr> <tr>
<td>license.key</td> <td>license.key</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>License key for vmanomaly</p> <td><p>License key for vmanomaly</p>
@ -523,9 +571,10 @@ secret:
<tr> <tr>
<td>license.secret</td> <td>license.secret</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
key: "" <code class="language-yaml">key: ""
name: "" name: ""
</code>
</pre> </pre>
</td> </td>
<td><p>Use existing secret with license key for vmanomaly</p> <td><p>Use existing secret with license key for vmanomaly</p>
@ -534,8 +583,9 @@ name: ""
<tr> <tr>
<td>license.secret.key</td> <td>license.secret.key</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Key in secret with license key</p> <td><p>Key in secret with license key</p>
@ -544,8 +594,9 @@ name: ""
<tr> <tr>
<td>license.secret.name</td> <td>license.secret.name</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Existing secret name</p> <td><p>Existing secret name</p>
@ -554,17 +605,20 @@ name: ""
<tr> <tr>
<td>nameOverride</td> <td>nameOverride</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Full name suffix override</p>
</td>
</tr> </tr>
<tr> <tr>
<td>nodeSelector</td> <td>nodeSelector</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>NodeSelector configurations. Details are <a href="https://kubernetes.io/docs/user-guide/node-selection/" target="_blank">here</a></p> <td><p>NodeSelector configurations. Details are <a href="https://kubernetes.io/docs/user-guide/node-selection/" target="_blank">here</a></p>
@ -573,8 +627,8 @@ name: ""
<tr> <tr>
<td>persistentVolume</td> <td>persistentVolume</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
accessModes: <code class="language-yaml">accessModes:
- ReadWriteOnce - ReadWriteOnce
annotations: {} annotations: {}
enabled: false enabled: false
@ -582,6 +636,7 @@ existingClaim: ""
matchLabels: {} matchLabels: {}
size: 1Gi size: 1Gi
storageClassName: "" storageClassName: ""
</code>
</pre> </pre>
</td> </td>
<td><p>Persistence to store models on disk. Available starting from v1.13.0</p> <td><p>Persistence to store models on disk. Available starting from v1.13.0</p>
@ -590,8 +645,9 @@ storageClassName: ""
<tr> <tr>
<td>persistentVolume.accessModes</td> <td>persistentVolume.accessModes</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
- ReadWriteOnce <code class="language-yaml">- ReadWriteOnce
</code>
</pre> </pre>
</td> </td>
<td><p>Array of access modes. Must match those of existing PV or dynamic provisioner. Details are <a href="http://kubernetes.io/docs/user-guide/persistent-volumes/" target="_blank">here</a></p> <td><p>Array of access modes. Must match those of existing PV or dynamic provisioner. Details are <a href="http://kubernetes.io/docs/user-guide/persistent-volumes/" target="_blank">here</a></p>
@ -600,8 +656,9 @@ storageClassName: ""
<tr> <tr>
<td>persistentVolume.annotations</td> <td>persistentVolume.annotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Persistant volume annotations</p> <td><p>Persistant volume annotations</p>
@ -610,8 +667,9 @@ storageClassName: ""
<tr> <tr>
<td>persistentVolume.enabled</td> <td>persistentVolume.enabled</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>Create/use Persistent Volume Claim for models dump.</p> <td><p>Create/use Persistent Volume Claim for models dump.</p>
@ -620,8 +678,9 @@ false
<tr> <tr>
<td>persistentVolume.existingClaim</td> <td>persistentVolume.existingClaim</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Existing Claim name. If defined, PVC must be created manually before volume will be bound</p> <td><p>Existing Claim name. If defined, PVC must be created manually before volume will be bound</p>
@ -630,8 +689,9 @@ false
<tr> <tr>
<td>persistentVolume.matchLabels</td> <td>persistentVolume.matchLabels</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Bind Persistent Volume by labels. Must match all labels of targeted PV.</p> <td><p>Bind Persistent Volume by labels. Must match all labels of targeted PV.</p>
@ -640,8 +700,9 @@ false
<tr> <tr>
<td>persistentVolume.size</td> <td>persistentVolume.size</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
1Gi <code class="language-yaml">1Gi
</code>
</pre> </pre>
</td> </td>
<td><p>Size of the volume. Should be calculated based on the metrics you send and retention policy you set.</p> <td><p>Size of the volume. Should be calculated based on the metrics you send and retention policy you set.</p>
@ -650,8 +711,9 @@ false
<tr> <tr>
<td>persistentVolume.storageClassName</td> <td>persistentVolume.storageClassName</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>StorageClass to use for persistent volume. Requires server.persistentVolume.enabled: true. If defined, PVC created automatically</p> <td><p>StorageClass to use for persistent volume. Requires server.persistentVolume.enabled: true. If defined, PVC created automatically</p>
@ -660,8 +722,9 @@ false
<tr> <tr>
<td>podAnnotations</td> <td>podAnnotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Annotations to be added to pod</p> <td><p>Annotations to be added to pod</p>
@ -670,10 +733,11 @@ false
<tr> <tr>
<td>podDisruptionBudget</td> <td>podDisruptionBudget</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
enabled: false <code class="language-yaml">enabled: false
labels: {} labels: {}
minAvailable: 1 minAvailable: 1
</code>
</pre> </pre>
</td> </td>
<td><p>See <code>kubectl explain poddisruptionbudget.spec</code> for more. Details are <a href="https://kubernetes.io/docs/tasks/run-application/configure-pdb/" target="_blank">here</a></p> <td><p>See <code>kubectl explain poddisruptionbudget.spec</code> for more. Details are <a href="https://kubernetes.io/docs/tasks/run-application/configure-pdb/" target="_blank">here</a></p>
@ -682,66 +746,78 @@ minAvailable: 1
<tr> <tr>
<td>podMonitor.annotations</td> <td>podMonitor.annotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>PodMonitor annotations</p>
</td>
</tr> </tr>
<tr> <tr>
<td>podMonitor.enabled</td> <td>podMonitor.enabled</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Enable PodMonitor</p>
</td>
</tr> </tr>
<tr> <tr>
<td>podMonitor.extraLabels</td> <td>podMonitor.extraLabels</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>PodMonitor labels</p>
</td>
</tr> </tr>
<tr> <tr>
<td>podSecurityContext.enabled</td> <td>podSecurityContext</td>
<td>bool</td> <td>object</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
true <code class="language-yaml">enabled: true
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Pod&rsquo;s security context. Details are <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" target="_blank">here</a></p>
</td>
</tr> </tr>
<tr> <tr>
<td>resources</td> <td>resources</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Resource object. Details are <a href="http://kubernetes.io/docs/user-guide/compute-resources/" target="_blank">here</a></p>
</td>
</tr> </tr>
<tr> <tr>
<td>securityContext</td> <td>securityContext</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
enabled: true <code class="language-yaml">enabled: true
runAsGroup: 1000 runAsGroup: 1000
runAsNonRoot: true runAsNonRoot: true
runAsUser: 1000 runAsUser: 1000
</code>
</pre> </pre>
</td> </td>
<td><p>Ref: <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" target="_blank">https://kubernetes.io/docs/tasks/configure-pod-container/security-context/</a></p> <td><p>Check <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" target="_blank">here</a> for details.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>serviceAccount.annotations</td> <td>serviceAccount.annotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Annotations to add to the service account</p> <td><p>Annotations to add to the service account</p>
@ -750,8 +826,9 @@ runAsUser: 1000
<tr> <tr>
<td>serviceAccount.create</td> <td>serviceAccount.create</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>Specifies whether a service account should be created</p> <td><p>Specifies whether a service account should be created</p>
@ -760,8 +837,9 @@ true
<tr> <tr>
<td>serviceAccount.name</td> <td>serviceAccount.name</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
null <code class="language-yaml">null
</code>
</pre> </pre>
</td> </td>
<td><p>The name of the service account to use. If not set and create is true, a name is generated using the fullname template</p> <td><p>The name of the service account to use. If not set and create is true, a name is generated using the fullname template</p>
@ -770,8 +848,9 @@ null
<tr> <tr>
<td>tolerations</td> <td>tolerations</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Tolerations configurations. Details are <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/" target="_blank">here</a></p> <td><p>Tolerations configurations. Details are <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/" target="_blank">here</a></p>

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

File diff suppressed because it is too large Load diff

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

File diff suppressed because it is too large Load diff

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

@ -18,7 +18,7 @@ This chart sets up multiple VictoriaMetrics cluster instances on multiple [avail
The default setup is as shown below: The default setup is as shown below:
![victoriametrics-distributed-topology](./victoriametrics-distributed-topology.png) ![victoriametrics-distributed-topology](./img/victoriametrics-distributed-topology.webp)
For write: For write:
1. extra-vmagent(optional): scrapes external targets and all the components installed by this chart, sends data to global write entrypoint. 1. extra-vmagent(optional): scrapes external targets and all the components installed by this chart, sends data to global write entrypoint.
@ -231,223 +231,256 @@ The following tables lists the configurable parameters of the chart and their de
Change the values according to the need of the environment in ``victoria-metrics-distributed`/values.yaml`` file. Change the values according to the need of the environment in ``victoria-metrics-distributed`/values.yaml`` file.
<table> <table class="helm-vars">
<thead> <thead>
<th>Key</th> <th class="helm-vars-key">Key</th>
<th>Type</th> <th class="helm-vars-type">Type</th>
<th>Default</th> <th class="helm-vars-default">Default</th>
<th>Description</th> <th class="helm-vars-description">Description</th>
</thead> </thead>
<tbody> <tbody>
<tr>
<td>availabilityZones</td>
<td>list</td>
<td><pre lang="plaintext">
- allowIngest: true
allowQuery: true
extraAffinity: {}
name: zone-eu-1
nodeSelector:
topology.kubernetes.io/zone: zone-eu-1
topologySpreadConstraints:
- maxSkew: 1
topologyKey: kubernetes.io/hostname
whenUnsatisfiable: ScheduleAnyway
vmagent:
annotations: {}
enabled: true
name: ""
spec: {}
vmauthCrossAZQuery:
enabled: true
name: ""
spec: {}
vmauthIngest:
enabled: true
name: ""
spec:
extraArgs:
discoverBackendIPs: "true"
vmauthQueryPerZone:
enabled: true
name: ""
spec:
extraArgs:
discoverBackendIPs: "true"
vmcluster:
enabled: true
name: ""
spec:
replicationFactor: 2
retentionPeriod: "14"
vminsert:
extraArgs: {}
replicaCount: 2
resources: {}
vmselect:
extraArgs: {}
replicaCount: 2
resources: {}
vmstorage:
replicaCount: 2
resources: {}
storageDataPath: /vm-data
- allowIngest: true
allowQuery: true
extraAffinity: {}
name: zone-us-1
nodeSelector:
topology.kubernetes.io/zone: zone-us-1
topologySpreadConstraints:
- maxSkew: 1
topologyKey: kubernetes.io/hostname
whenUnsatisfiable: ScheduleAnyway
vmagent:
annotations: {}
enabled: true
name: ""
spec: {}
vmauthCrossAZQuery:
enabled: true
name: ""
spec: {}
vmauthIngest:
enabled: true
name: ""
spec:
extraArgs:
discoverBackendIPs: "true"
vmauthQueryPerZone:
enabled: true
name: ""
spec:
extraArgs:
discoverBackendIPs: "true"
vmcluster:
enabled: true
name: ""
spec:
replicationFactor: 2
retentionPeriod: "14"
vminsert:
extraArgs: {}
replicaCount: 2
resources: {}
vmselect:
extraArgs: {}
replicaCount: 2
resources: {}
vmstorage:
replicaCount: 2
resources: {}
storageDataPath: /vm-data
</pre>
</td>
<td><p>config per availability zone components, including vmagent, vmcluster, vmauth etc</p>
</td>
</tr>
<tr> <tr>
<td>availabilityZones[0].allowIngest</td> <td>availabilityZones[0].allowIngest</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>allow data ingestion to this zone</p> <td><p>Allow data ingestion to this zone</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].allowQuery</td> <td>availabilityZones[0].allowQuery</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>allow data query from this zone through global query endpoint</p> <td><p>Allow data query from this zone through global query endpoint</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].extraAffinity</td> <td>availabilityZones[0].extraAffinity</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>extraAffinity adds user defined custom affinity rules</p> <td><p>Extra affinity adds user defined custom affinity rules</p>
</td>
</tr>
<tr>
<td>availabilityZones[0].name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">zone-eu-1
</code>
</pre>
</td>
<td><p>Availability zone name</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].nodeSelector</td> <td>availabilityZones[0].nodeSelector</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
topology.kubernetes.io/zone: zone-eu-1 <code class="language-yaml">topology.kubernetes.io/zone: zone-eu-1
</code>
</pre> </pre>
</td> </td>
<td><p>nodeselector to restrict where pods of this zone can be placed. usually provided by cloud providers.</p> <td><p>Node selector to restrict where pods of this zone can be placed. usually provided by cloud providers.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].topologySpreadConstraints</td> <td>availabilityZones[0].topologySpreadConstraints</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
- maxSkew: 1 <code class="language-yaml">- maxSkew: 1
topologyKey: kubernetes.io/hostname topologyKey: kubernetes.io/hostname
whenUnsatisfiable: ScheduleAnyway whenUnsatisfiable: ScheduleAnyway
</code>
</pre> </pre>
</td> </td>
<td><p>topologySpreadConstraints allows to customize the default topologySpreadConstraints.</p> <td><p>Topology spread constraints allows to customize the default topologySpreadConstraints.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].vmagent</td> <td>availabilityZones[0].vmagent</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
annotations: {} <code class="language-yaml">annotations: {}
enabled: true enabled: true
name: "" name: ""
spec: {} spec: {}
</code>
</pre> </pre>
</td> </td>
<td><p>vmagent here only meant to proxy write requests to each az, doesn&rsquo;t support customized other remote write address.</p> <td><p>VMAgent here only meant to proxy write requests to each az, doesn&rsquo;t support customized other remote write address.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].vmauthCrossAZQuery</td> <td>availabilityZones[0].vmagent.annotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
enabled: true <code class="language-yaml">{}
name: "" </code>
spec: {}
</pre> </pre>
</td> </td>
<td><p>set up a vmauth with all the zone with <code>allowQuery: true</code> as query backends</p> <td><p>VMAgent annotations</p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmagent.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmagent object</p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmagent.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
</td>
<td><p>VMAgent spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmagentspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmauthCrossAZQuery.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td><p>Create a vmauth with all the zone with <code>allowQuery: true</code> as query backends</p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmauthCrossAZQuery.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmauth object</p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmauthCrossAZQuery.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmauthIngest.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td><p>Create vmauth as a local write endpoint</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].vmauthIngest.name</td> <td>availabilityZones[0].vmauthIngest.name</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>override the name of the vmauth object</p> <td><p>Override the name of the vmauth object</p>
</td> </td>
</tr> </tr>
<tr>
<td>availabilityZones[0].vmauthIngest.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">extraArgs:
discoverBackendIPs: "true"
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmauthQueryPerZone.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td><p>Create vmauth as a local read endpoint</p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmauthQueryPerZone.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmauth object</p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmauthQueryPerZone.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">extraArgs:
discoverBackendIPs: "true"
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[0].vmcluster.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td></td>
</tr>
<tr> <tr>
<td>availabilityZones[0].vmcluster.name</td> <td>availabilityZones[0].vmcluster.name</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>override the name of the vmcluster, by default is vmcluster-<zoneName></p> <td><p>Override the name of the vmcluster, by default is vmcluster-<zoneName></p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[0].vmcluster.spec</td> <td>availabilityZones[0].vmcluster.spec</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
replicationFactor: 2 <code class="language-yaml">replicationFactor: 2
retentionPeriod: "14" retentionPeriod: "14"
vminsert: vminsert:
extraArgs: {} extraArgs: {}
@ -461,91 +494,254 @@ vmstorage:
replicaCount: 2 replicaCount: 2
resources: {} resources: {}
storageDataPath: /vm-data storageDataPath: /vm-data
</code>
</pre> </pre>
</td> </td>
<td><p>spec for VMCluster crd, see <a href="https://docs.victoriametrics.com/operator/api#vmclusterspec" target="_blank">https://docs.victoriametrics.com/operator/api#vmclusterspec</a></p> <td><p>Spec for VMCluster CRD, see <a href="https://docs.victoriametrics.com/operator/api#vmclusterspec" target="_blank">here</a></p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[1].allowIngest</td> <td>availabilityZones[1].allowIngest</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>allow data ingestion to this zone</p> <td><p>Allow data ingestion to this zone</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[1].allowQuery</td> <td>availabilityZones[1].allowQuery</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>allow data query from this zone through global query endpoint</p> <td><p>Allow data query from this zone through global query endpoint</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[1].extraAffinity</td> <td>availabilityZones[1].extraAffinity</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>extraAffinity adds user defined custom affinity rules</p> <td><p>Extra affinity adds user defined custom affinity rules</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">zone-us-1
</code>
</pre>
</td>
<td><p>Availability zone name</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[1].nodeSelector</td> <td>availabilityZones[1].nodeSelector</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
topology.kubernetes.io/zone: zone-us-1 <code class="language-yaml">topology.kubernetes.io/zone: zone-us-1
</code>
</pre> </pre>
</td> </td>
<td><p>nodeselector to restrict where pods of this zone can be placed. usually provided by cloud providers.</p> <td><p>Node selector to restrict where pods of this zone can be placed. usually provided by cloud providers.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[1].topologySpreadConstraints</td> <td>availabilityZones[1].topologySpreadConstraints</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
- maxSkew: 1 <code class="language-yaml">- maxSkew: 1
topologyKey: kubernetes.io/hostname topologyKey: kubernetes.io/hostname
whenUnsatisfiable: ScheduleAnyway whenUnsatisfiable: ScheduleAnyway
</code>
</pre> </pre>
</td> </td>
<td><p>topologySpreadConstraints allows to customize the default topologySpreadConstraints.</p> <td><p>Topology spread constraints allows to customize the default topologySpreadConstraints.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[1].vmagent</td> <td>availabilityZones[1].vmagent</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
annotations: {} <code class="language-yaml">annotations: {}
enabled: true enabled: true
name: "" name: ""
spec: {} spec: {}
</code>
</pre> </pre>
</td> </td>
<td><p>vmagent only meant to proxy write requests to each az, doesn&rsquo;t support customized remote write address</p> <td><p>VMAgent only meant to proxy write requests to each az, doesn&rsquo;t support customized remote write address</p>
</td> </td>
</tr> </tr>
<tr>
<td>availabilityZones[1].vmagent.annotations</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
</td>
<td><p>VMAgent annotations</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmagent.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmagent object</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmagent.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
</td>
<td><p>VMAgent spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmagentspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthCrossAZQuery.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td><p>Create a vmauth with all the zone with <code>allowQuery: true</code> as query backends</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthCrossAZQuery.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmauth object</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthCrossAZQuery.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthIngest.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td><p>Create vmauth as a local write endpoint</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthIngest.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmauth object</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthIngest.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">extraArgs:
discoverBackendIPs: "true"
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthQueryPerZone.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td><p>Create vmauth as a local read endpoint</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthQueryPerZone.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmauth object</p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmauthQueryPerZone.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">extraArgs:
discoverBackendIPs: "true"
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>availabilityZones[1].vmcluster.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td></td>
</tr>
<tr> <tr>
<td>availabilityZones[1].vmcluster.name</td> <td>availabilityZones[1].vmcluster.name</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>override the name of the vmcluster, by default is vmcluster-<zoneName></p> <td><p>Override the name of the vmcluster, by default is vmcluster-<zoneName></p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>availabilityZones[1].vmcluster.spec</td> <td>availabilityZones[1].vmcluster.spec</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
replicationFactor: 2 <code class="language-yaml">replicationFactor: 2
retentionPeriod: "14" retentionPeriod: "14"
vminsert: vminsert:
extraArgs: {} extraArgs: {}
@ -559,59 +755,64 @@ vmstorage:
replicaCount: 2 replicaCount: 2
resources: {} resources: {}
storageDataPath: /vm-data storageDataPath: /vm-data
</code>
</pre> </pre>
</td> </td>
<td><p>spec for VMCluster crd, see <a href="https://docs.victoriametrics.com/operator/api#vmclusterspec" target="_blank">https://docs.victoriametrics.com/operator/api#vmclusterspec</a></p> <td><p>Spec for VMCluster CRD, see <a href="https://docs.victoriametrics.com/operator/api#vmclusterspec" target="_blank">here</a></p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>enableMultitenancy</td> <td>enableMultitenancy</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>enable multitenancy mode see <a href="https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-distributed#how-to-use-multitenancy" target="_blank">https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-distributed#how-to-use-multitenancy</a></p> <td><p>Enable multitenancy mode see <a href="https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-distributed#how-to-use-multitenancy" target="_blank">here</a></p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>extraVMAgent</td> <td>extraVMAgent</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
enabled: true <code class="language-yaml">enabled: true
name: test-vmagent name: test-vmagent
spec: spec:
selectAllByDefault: true selectAllByDefault: true
</code>
</pre> </pre>
</td> </td>
<td><p>set up an extra vmagent to scrape all the scrape objects by default, and write data to above vmauth-global-ingest endpoint.</p> <td><p>Set up an extra vmagent to scrape all the scrape objects by default, and write data to above vmauth-global-ingest endpoint.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>fullnameOverride</td> <td>fullnameOverride</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>overrides the chart&rsquo;s computed fullname.</p> <td><p>Overrides the chart&rsquo;s computed fullname.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>nameOverride</td> <td>nameOverride</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
vm-distributed <code class="language-yaml">vm-distributed
</code>
</pre> </pre>
</td> </td>
<td><p>overrides the chart&rsquo;s name</p> <td><p>Overrides the chart&rsquo;s name</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>victoria-metrics-k8s-stack</td> <td>victoria-metrics-k8s-stack</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
alertmanager: <code class="language-yaml">alertmanager:
enabled: false enabled: false
crds: crds:
enabled: true enabled: true
@ -631,33 +832,76 @@ vmcluster:
enabled: false enabled: false
vmsingle: vmsingle:
enabled: false enabled: false
</code>
</pre> </pre>
</td> </td>
<td><p>set up vm operator and other resources like vmalert, grafana if needed</p> <td><p>Set up vm operator and other resources like vmalert, grafana if needed</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>vmauthIngestGlobal</td> <td>vmauthIngestGlobal.enabled</td>
<td>object</td> <td>bool</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="">
enabled: true <code class="language-yaml">true
name: "" </code>
spec: {}
</pre> </pre>
</td> </td>
<td><p>set up a vmauth as the global write entrypoint</p> <td><p>Create a vmauth as the global write entrypoint</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>vmauthQueryGlobal</td> <td>vmauthIngestGlobal.name</td>
<td>object</td> <td>string</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="">
enabled: true <code class="language-yaml">""
name: "" </code>
spec: {}
</pre> </pre>
</td> </td>
<td><p>set up a vmauth as the global read entrypoint</p> <td><p>Override the name of the vmauth object</p>
</td>
</tr>
<tr>
<td>vmauthIngestGlobal.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>vmauthQueryGlobal.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">true
</code>
</pre>
</td>
<td><p>Create vmauth as the global read entrypoint</p>
</td>
</tr>
<tr>
<td>vmauthQueryGlobal.name</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Override the name of the vmauth object</p>
</td>
</tr>
<tr>
<td>vmauthQueryGlobal.spec</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
</td>
<td><p>VMAuth spec. More options can be found <a href="https://docs.victoriametrics.com/operator/api/#vmauthspec" target="_blank">here</a></p>
</td> </td>
</tr> </tr>
</tbody> </tbody>

BIN
docs/helm/victoria-metrics-distributed/img/victoriametrics-distributed-topology.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 72 KiB

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

File diff suppressed because it is too large Load diff

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

File diff suppressed because it is too large Load diff

BIN
docs/helm/victoria-metrics-k8s-stack/img/k8s-stack-overview.webp Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 93 KiB

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

@ -193,19 +193,19 @@ The following tables lists the configurable parameters of the chart and their de
Change the values according to the need of the environment in ``victoria-metrics-operator/values.yaml`` file. Change the values according to the need of the environment in ``victoria-metrics-operator/values.yaml`` file.
<table> <table class="helm-vars">
<thead> <thead>
<th>Key</th> <th class="helm-vars-key">Key</th>
<th>Type</th> <th class="helm-vars-type">Type</th>
<th>Default</th> <th class="helm-vars-default">Default</th>
<th>Description</th> <th class="helm-vars-description">Description</th>
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>admissionWebhooks</td> <td>admissionWebhooks</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
certManager: <code class="language-yaml">certManager:
enabled: false enabled: false
issuer: {} issuer: {}
enabled: true enabled: true
@ -226,6 +226,7 @@ tls:
caCert: null caCert: null
cert: null cert: null
key: null key: null
</code>
</pre> </pre>
</td> </td>
<td><p>Configures resource validation</p> <td><p>Configures resource validation</p>
@ -234,19 +235,21 @@ tls:
<tr> <tr>
<td>admissionWebhooks.certManager</td> <td>admissionWebhooks.certManager</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
enabled: false <code class="language-yaml">enabled: false
issuer: {} issuer: {}
</code>
</pre> </pre>
</td> </td>
<td><p>with keys: tls.key, tls.crt, ca.crt</p> <td><p>Enables custom ca bundle, if you are not using cert-manager. In case of custom ca, you have to create secret - {chart-name}-validation with keys: tls.key, tls.crt, ca.crt</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>admissionWebhooks.certManager.enabled</td> <td>admissionWebhooks.certManager.enabled</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>Enables cert creation and injection by cert-manager.</p> <td><p>Enables cert creation and injection by cert-manager.</p>
@ -255,8 +258,9 @@ false
<tr> <tr>
<td>admissionWebhooks.certManager.issuer</td> <td>admissionWebhooks.certManager.issuer</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>If needed, provide own issuer. Operator will create self-signed if empty.</p> <td><p>If needed, provide own issuer. Operator will create self-signed if empty.</p>
@ -265,8 +269,9 @@ false
<tr> <tr>
<td>admissionWebhooks.enabled</td> <td>admissionWebhooks.enabled</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>Enables validation webhook.</p> <td><p>Enables validation webhook.</p>
@ -275,8 +280,9 @@ true
<tr> <tr>
<td>admissionWebhooks.policy</td> <td>admissionWebhooks.policy</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
Fail <code class="language-yaml">Fail
</code>
</pre> </pre>
</td> </td>
<td><p>What to do in case, when operator not available to validate request.</p> <td><p>What to do in case, when operator not available to validate request.</p>
@ -285,8 +291,9 @@ Fail
<tr> <tr>
<td>affinity</td> <td>affinity</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Pod affinity</p> <td><p>Pod affinity</p>
@ -295,8 +302,9 @@ Fail
<tr> <tr>
<td>annotations</td> <td>annotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Annotations to be added to the all resources</p> <td><p>Annotations to be added to the all resources</p>
@ -305,8 +313,9 @@ Fail
<tr> <tr>
<td>crd.cleanup.enabled</td> <td>crd.cleanup.enabled</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>Tells helm to clean up all the vm resources under this release&rsquo;s namespace when uninstalling</p> <td><p>Tells helm to clean up all the vm resources under this release&rsquo;s namespace when uninstalling</p>
@ -315,10 +324,11 @@ false
<tr> <tr>
<td>crd.cleanup.image</td> <td>crd.cleanup.image</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
pullPolicy: IfNotPresent <code class="language-yaml">pullPolicy: IfNotPresent
repository: bitnami/kubectl repository: bitnami/kubectl
tag: "" tag: ""
</code>
</pre> </pre>
</td> </td>
<td><p>Image configuration for CRD cleanup Job</p> <td><p>Image configuration for CRD cleanup Job</p>
@ -327,56 +337,64 @@ tag: ""
<tr> <tr>
<td>crd.create</td> <td>crd.create</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>with this option, if you remove this chart, all crd resources will be deleted with it.</p> <td><p>Enables CRD creation and management. With this option, if you remove this chart, all CRD resources will be deleted with it.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>env</td> <td>env</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>extra settings for the operator deployment. Full list <a href="https://docs.victoriametrics.com/operator/vars" target="_blank">here</a></p> <td><p>Extra settings for the operator deployment. Full list <a href="https://docs.victoriametrics.com/operator/vars" target="_blank">here</a></p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>envFrom</td> <td>envFrom</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Specify alternative source for env variables</p>
</td>
</tr> </tr>
<tr> <tr>
<td>extraArgs</td> <td>extraArgs</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>operator container additional commandline arguments</p> <td><p>Operator container additional commandline arguments</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>extraContainers</td> <td>extraContainers</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Extra containers to run in a pod with operator</p>
</td>
</tr> </tr>
<tr> <tr>
<td>extraHostPathMounts</td> <td>extraHostPathMounts</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Additional hostPath mounts</p> <td><p>Additional hostPath mounts</p>
@ -385,8 +403,9 @@ true
<tr> <tr>
<td>extraLabels</td> <td>extraLabels</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Labels to be added to the all resources</p> <td><p>Labels to be added to the all resources</p>
@ -395,8 +414,9 @@ true
<tr> <tr>
<td>extraObjects</td> <td>extraObjects</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Add extra specs dynamically to this chart</p> <td><p>Add extra specs dynamically to this chart</p>
@ -405,8 +425,9 @@ true
<tr> <tr>
<td>extraVolumeMounts</td> <td>extraVolumeMounts</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Extra Volume Mounts for the container</p> <td><p>Extra Volume Mounts for the container</p>
@ -415,8 +436,9 @@ true
<tr> <tr>
<td>extraVolumes</td> <td>extraVolumes</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Extra Volumes for the pod</p> <td><p>Extra Volumes for the pod</p>
@ -425,8 +447,9 @@ true
<tr> <tr>
<td>fullnameOverride</td> <td>fullnameOverride</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Overrides the full name of server component</p> <td><p>Overrides the full name of server component</p>
@ -435,39 +458,57 @@ true
<tr> <tr>
<td>global.cluster.dnsDomain</td> <td>global.cluster.dnsDomain</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
cluster.local <code class="language-yaml">cluster.local
</code>
</pre> </pre>
</td> </td>
<td></td> <td></td>
</tr> </tr>
<tr>
<td>global.compatibility</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">openshift:
adaptSecurityContext: auto
</code>
</pre>
</td>
<td><p>Openshift security context compatibility configuration</p>
</td>
</tr>
<tr> <tr>
<td>global.image.registry</td> <td>global.image.registry</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Image registry, that can be shared across multiple helm charts</p>
</td>
</tr> </tr>
<tr> <tr>
<td>global.imagePullSecrets</td> <td>global.imagePullSecrets</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Image pull secrets, that can be shared across multiple helm charts</p>
</td>
</tr> </tr>
<tr> <tr>
<td>image</td> <td>image</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
pullPolicy: IfNotPresent <code class="language-yaml">pullPolicy: IfNotPresent
registry: "" registry: ""
repository: victoriametrics/operator repository: victoriametrics/operator
tag: "" tag: ""
variant: "" variant: ""
</code>
</pre> </pre>
</td> </td>
<td><p>operator image configuration</p> <td><p>operator image configuration</p>
@ -476,8 +517,9 @@ variant: ""
<tr> <tr>
<td>image.pullPolicy</td> <td>image.pullPolicy</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
IfNotPresent <code class="language-yaml">IfNotPresent
</code>
</pre> </pre>
</td> </td>
<td><p>Image pull policy</p> <td><p>Image pull policy</p>
@ -486,8 +528,9 @@ IfNotPresent
<tr> <tr>
<td>image.registry</td> <td>image.registry</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Image registry</p> <td><p>Image registry</p>
@ -496,8 +539,9 @@ IfNotPresent
<tr> <tr>
<td>image.repository</td> <td>image.repository</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
victoriametrics/operator <code class="language-yaml">victoriametrics/operator
</code>
</pre> </pre>
</td> </td>
<td><p>Image repository</p> <td><p>Image repository</p>
@ -506,8 +550,9 @@ victoriametrics/operator
<tr> <tr>
<td>image.tag</td> <td>image.tag</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>Image tag override Chart.AppVersion</p> <td><p>Image tag override Chart.AppVersion</p>
@ -516,8 +561,9 @@ victoriametrics/operator
<tr> <tr>
<td>imagePullSecrets</td> <td>imagePullSecrets</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Secret to pull images</p> <td><p>Secret to pull images</p>
@ -526,18 +572,20 @@ victoriametrics/operator
<tr> <tr>
<td>logLevel</td> <td>logLevel</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
info <code class="language-yaml">info
</code>
</pre> </pre>
</td> </td>
<td><p>possible values: info and error.</p> <td><p>VM operator log level. Possible values: info and error.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>nameOverride</td> <td>nameOverride</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>VM operatror deployment name override</p> <td><p>VM operatror deployment name override</p>
@ -546,8 +594,9 @@ info
<tr> <tr>
<td>nodeSelector</td> <td>nodeSelector</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Pod&rsquo;s node selector. Details are <a href="https://kubernetes.io/docs/user-guide/node-selection/" target="_blank">here</a></p> <td><p>Pod&rsquo;s node selector. Details are <a href="https://kubernetes.io/docs/user-guide/node-selection/" target="_blank">here</a></p>
@ -556,8 +605,9 @@ info
<tr> <tr>
<td>operator.disable_prometheus_converter</td> <td>operator.disable_prometheus_converter</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>By default, operator converts prometheus-operator objects.</p> <td><p>By default, operator converts prometheus-operator objects.</p>
@ -566,8 +616,9 @@ false
<tr> <tr>
<td>operator.enable_converter_ownership</td> <td>operator.enable_converter_ownership</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>Enables ownership reference for converted prometheus-operator objects, it will remove corresponding victoria-metrics objects in case of deletion prometheus one.</p> <td><p>Enables ownership reference for converted prometheus-operator objects, it will remove corresponding victoria-metrics objects in case of deletion prometheus one.</p>
@ -576,8 +627,9 @@ false
<tr> <tr>
<td>operator.prometheus_converter_add_argocd_ignore_annotations</td> <td>operator.prometheus_converter_add_argocd_ignore_annotations</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>Compare-options and sync-options for prometheus objects converted by operator for properly use with ArgoCD</p> <td><p>Compare-options and sync-options for prometheus objects converted by operator for properly use with ArgoCD</p>
@ -586,8 +638,9 @@ false
<tr> <tr>
<td>operator.useCustomConfigReloader</td> <td>operator.useCustomConfigReloader</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
false <code class="language-yaml">false
</code>
</pre> </pre>
</td> </td>
<td><p>Enables custom config-reloader, bundled with operator. It should reduce vmagent and vmauth config sync-time and make it predictable.</p> <td><p>Enables custom config-reloader, bundled with operator. It should reduce vmagent and vmauth config sync-time and make it predictable.</p>
@ -596,9 +649,10 @@ false
<tr> <tr>
<td>podDisruptionBudget</td> <td>podDisruptionBudget</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
enabled: false <code class="language-yaml">enabled: false
labels: {} labels: {}
</code>
</pre> </pre>
</td> </td>
<td><p>See <code>kubectl explain poddisruptionbudget.spec</code> for more or check <a href="https://kubernetes.io/docs/tasks/run-application/configure-pdb/" target="_blank">these docs</a></p> <td><p>See <code>kubectl explain poddisruptionbudget.spec</code> for more or check <a href="https://kubernetes.io/docs/tasks/run-application/configure-pdb/" target="_blank">these docs</a></p>
@ -607,31 +661,36 @@ labels: {}
<tr> <tr>
<td>podLabels</td> <td>podLabels</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>extra Labels for Pods only</p>
</td>
</tr> </tr>
<tr> <tr>
<td>podSecurityContext</td> <td>podSecurityContext</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Pod&rsquo;s security context. Details are <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" target="_blank">here</a></p>
</td>
</tr> </tr>
<tr> <tr>
<td>probe.liveness</td> <td>probe.liveness</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
failureThreshold: 3 <code class="language-yaml">failureThreshold: 3
initialDelaySeconds: 5 initialDelaySeconds: 5
periodSeconds: 15 periodSeconds: 15
tcpSocket: tcpSocket:
port: probe port: probe
timeoutSeconds: 5 timeoutSeconds: 5
</code>
</pre> </pre>
</td> </td>
<td><p>Liveness probe</p> <td><p>Liveness probe</p>
@ -640,13 +699,14 @@ timeoutSeconds: 5
<tr> <tr>
<td>probe.readiness</td> <td>probe.readiness</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
failureThreshold: 3 <code class="language-yaml">failureThreshold: 3
httpGet: httpGet:
port: probe port: probe
initialDelaySeconds: 5 initialDelaySeconds: 5
periodSeconds: 15 periodSeconds: 15
timeoutSeconds: 5 timeoutSeconds: 5
</code>
</pre> </pre>
</td> </td>
<td><p>Readiness probe</p> <td><p>Readiness probe</p>
@ -655,8 +715,9 @@ timeoutSeconds: 5
<tr> <tr>
<td>probe.startup</td> <td>probe.startup</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Startup probe</p> <td><p>Startup probe</p>
@ -665,36 +726,39 @@ timeoutSeconds: 5
<tr> <tr>
<td>rbac.aggregatedClusterRoles</td> <td>rbac.aggregatedClusterRoles</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
enabled: true <code class="language-yaml">enabled: true
labels: labels:
admin: admin:
rbac.authorization.k8s.io/aggregate-to-admin: "true" rbac.authorization.k8s.io/aggregate-to-admin: "true"
view: view:
rbac.authorization.k8s.io/aggregate-to-view: "true" rbac.authorization.k8s.io/aggregate-to-view: "true"
</code>
</pre> </pre>
</td> </td>
<td><p>create aggregated clusterRoles for CRD readonly and admin permissions</p> <td><p>Create aggregated clusterRoles for CRD readonly and admin permissions</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>rbac.aggregatedClusterRoles.labels</td> <td>rbac.aggregatedClusterRoles.labels</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
admin: <code class="language-yaml">admin:
rbac.authorization.k8s.io/aggregate-to-admin: "true" rbac.authorization.k8s.io/aggregate-to-admin: "true"
view: view:
rbac.authorization.k8s.io/aggregate-to-view: "true" rbac.authorization.k8s.io/aggregate-to-view: "true"
</code>
</pre> </pre>
</td> </td>
<td><p>labels attached to according clusterRole</p> <td><p>Labels attached to according clusterRole</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>rbac.create</td> <td>rbac.create</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>Specifies whether the RBAC resources should be created</p> <td><p>Specifies whether the RBAC resources should be created</p>
@ -703,17 +767,20 @@ true
<tr> <tr>
<td>replicaCount</td> <td>replicaCount</td>
<td>int</td> <td>int</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
1 <code class="language-yaml">1
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Number of operator replicas</p>
</td>
</tr> </tr>
<tr> <tr>
<td>resources</td> <td>resources</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td><p>Resource object</p> <td><p>Resource object</p>
@ -722,134 +789,163 @@ true
<tr> <tr>
<td>securityContext</td> <td>securityContext</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Security context to be added to server pods</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.annotations</td> <td>service.annotations</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service annotations</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.clusterIP</td> <td>service.clusterIP</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service ClusterIP</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.externalIPs</td> <td>service.externalIPs</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service external IPs. Check <a href="https://kubernetes.io/docs/user-guide/services/#external-ips" target="_blank">here</a> for details</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.externalTrafficPolicy</td> <td>service.externalTrafficPolicy</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service external traffic policy. Check <a href="https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip" target="_blank">here</a> for details</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.healthCheckNodePort</td> <td>service.healthCheckNodePort</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Health check node port for a service. Check <a href="https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip" target="_blank">here</a> for details</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.ipFamilies</td> <td>service.ipFamilies</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>List of service IP families. Check <a href="https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services" target="_blank">here</a> for details.</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.ipFamilyPolicy</td> <td>service.ipFamilyPolicy</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service IP family policy. Check <a href="https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services" target="_blank">here</a> for details.</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.labels</td> <td>service.labels</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
{} <code class="language-yaml">{}
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service labels</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.loadBalancerIP</td> <td>service.loadBalancerIP</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service load balacner IP</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.loadBalancerSourceRanges</td> <td>service.loadBalancerSourceRanges</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Load balancer source range</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.servicePort</td> <td>service.servicePort</td>
<td>int</td> <td>int</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
8080 <code class="language-yaml">8080
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service port</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.type</td> <td>service.type</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
ClusterIP <code class="language-yaml">ClusterIP
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service type</p>
</td>
</tr> </tr>
<tr> <tr>
<td>service.webhookPort</td> <td>service.webhookPort</td>
<td>int</td> <td>int</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
9443 <code class="language-yaml">9443
</code>
</pre> </pre>
</td> </td>
<td></td> <td><p>Service webhook port</p>
</td>
</tr> </tr>
<tr> <tr>
<td>serviceAccount.create</td> <td>serviceAccount.create</td>
<td>bool</td> <td>bool</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
true <code class="language-yaml">true
</code>
</pre> </pre>
</td> </td>
<td><p>Specifies whether a service account should be created</p> <td><p>Specifies whether a service account should be created</p>
@ -858,8 +954,9 @@ true
<tr> <tr>
<td>serviceAccount.name</td> <td>serviceAccount.name</td>
<td>string</td> <td>string</td>
<td><pre lang=""> <td><pre class="helm-vars-default-value" language-yaml" lang="">
"" <code class="language-yaml">""
</code>
</pre> </pre>
</td> </td>
<td><p>The name of the service account to use. If not set and create is true, a name is generated using the fullname template</p> <td><p>The name of the service account to use. If not set and create is true, a name is generated using the fullname template</p>
@ -868,8 +965,8 @@ true
<tr> <tr>
<td>serviceMonitor</td> <td>serviceMonitor</td>
<td>object</td> <td>object</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
annotations: {} <code class="language-yaml">annotations: {}
basicAuth: {} basicAuth: {}
enabled: false enabled: false
extraLabels: {} extraLabels: {}
@ -878,16 +975,18 @@ relabelings: []
scheme: "" scheme: ""
scrapeTimeout: "" scrapeTimeout: ""
tlsConfig: {} tlsConfig: {}
</code>
</pre> </pre>
</td> </td>
<td><p>configures monitoring with serviceScrape. VMServiceScrape must be pre-installed</p> <td><p>Configures monitoring with serviceScrape. VMServiceScrape must be pre-installed</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td>tolerations</td> <td>tolerations</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Array of tolerations object. Spec is <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/" target="_blank">here</a></p> <td><p>Array of tolerations object. Spec is <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/" target="_blank">here</a></p>
@ -896,8 +995,9 @@ tlsConfig: {}
<tr> <tr>
<td>topologySpreadConstraints</td> <td>topologySpreadConstraints</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>Pod Topology Spread Constraints. Spec is <a href="https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/" target="_blank">here</a></p> <td><p>Pod Topology Spread Constraints. Spec is <a href="https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/" target="_blank">here</a></p>
@ -906,8 +1006,9 @@ tlsConfig: {}
<tr> <tr>
<td>watchNamespaces</td> <td>watchNamespaces</td>
<td>list</td> <td>list</td>
<td><pre lang="plaintext"> <td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
[] <code class="language-yaml">[]
</code>
</pre> </pre>
</td> </td>
<td><p>By default, the operator will watch all the namespaces If you want to override this behavior, specify the namespace. Operator supports multiple namespaces for watching.</p> <td><p>By default, the operator will watch all the namespaces If you want to override this behavior, specify the namespace. Operator supports multiple namespaces for watching.</p>

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

File diff suppressed because it is too large Load diff