mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-01 14:47:38 +00:00
30903d9361
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>
1030 lines
27 KiB
Markdown
1030 lines
27 KiB
Markdown
 
|
|
[](https://artifacthub.io/packages/helm/victoriametrics/victoria-metrics-auth)
|
|
[](https://slack.victoriametrics.com/)
|
|
|
|
Victoria Metrics Auth - is a simple auth proxy and router for VictoriaMetrics.
|
|
|
|
## Prerequisites
|
|
|
|
* Install the follow packages: ``git``, ``kubectl``, ``helm``, ``helm-docs``. See this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
|
|
|
|
## How to install
|
|
|
|
Access a Kubernetes cluster.
|
|
|
|
### Setup chart repository (can be omitted for OCI repositories)
|
|
|
|
Add a chart helm repository with follow commands:
|
|
|
|
```console
|
|
helm repo add vm https://victoriametrics.github.io/helm-charts/
|
|
|
|
helm repo update
|
|
```
|
|
List versions of `vm/victoria-metrics-auth` chart available to installation:
|
|
|
|
```console
|
|
helm search repo vm/victoria-metrics-auth -l
|
|
```
|
|
|
|
### Install `victoria-metrics-auth` chart
|
|
|
|
Export default values of `victoria-metrics-auth` chart to file `values.yaml`:
|
|
|
|
- For HTTPS repository
|
|
|
|
```console
|
|
helm show values vm/victoria-metrics-auth > values.yaml
|
|
```
|
|
- For OCI repository
|
|
|
|
```console
|
|
helm show values oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-auth > values.yaml
|
|
```
|
|
|
|
Change the values according to the need of the environment in ``values.yaml`` file.
|
|
|
|
Test the installation with command:
|
|
|
|
- For HTTPS repository
|
|
|
|
```console
|
|
helm install vma vm/victoria-metrics-auth -f values.yaml -n NAMESPACE --debug --dry-run
|
|
```
|
|
|
|
- For OCI repository
|
|
|
|
```console
|
|
helm install vma oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-auth -f values.yaml -n NAMESPACE --debug --dry-run
|
|
```
|
|
|
|
Install chart with command:
|
|
|
|
- For HTTPS repository
|
|
|
|
```console
|
|
helm install vma vm/victoria-metrics-auth -f values.yaml -n NAMESPACE
|
|
```
|
|
|
|
- For OCI repository
|
|
|
|
```console
|
|
helm install vma oci://ghcr.io/victoriametrics/helm-charts/victoria-metrics-auth -f values.yaml -n NAMESPACE
|
|
```
|
|
|
|
Get the pods lists by running this commands:
|
|
|
|
```console
|
|
kubectl get pods -A | grep 'vma'
|
|
```
|
|
|
|
Get the application by running this command:
|
|
|
|
```console
|
|
helm list -f vma -n NAMESPACE
|
|
```
|
|
|
|
See the history of versions of `vma` application with command.
|
|
|
|
```console
|
|
helm history vma -n NAMESPACE
|
|
```
|
|
|
|
## How to uninstall
|
|
|
|
Remove application with command.
|
|
|
|
```console
|
|
helm uninstall vma -n NAMESPACE
|
|
```
|
|
|
|
## Documentation of Helm Chart
|
|
|
|
Install ``helm-docs`` following the instructions on this [tutorial](https://docs.victoriametrics.com/helm/requirements/).
|
|
|
|
Generate docs with ``helm-docs`` command.
|
|
|
|
```bash
|
|
cd charts/victoria-metrics-auth
|
|
|
|
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.
|
|
|
|
## Parameters
|
|
|
|
The following tables lists the configurable parameters of the chart and their default values.
|
|
|
|
Change the values according to the need of the environment in ``victoria-metrics-auth/values.yaml`` file.
|
|
|
|
<table class="helm-vars">
|
|
<thead>
|
|
<th class="helm-vars-key">Key</th>
|
|
<th class="helm-vars-type">Type</th>
|
|
<th class="helm-vars-default">Default</th>
|
|
<th class="helm-vars-description">Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>affinity</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Affinity configurations</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>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>Annotations to be added to the deployment</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>config</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">null
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Config file content.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>containerWorkingDir</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">/
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>env</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Additional environment variables (ex.: secret tokens, flags). Check <a href="https://docs.victoriametrics.com/#environment-variables" target="_blank">here</a> for details</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>envFrom</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Specify alternative source for env variables</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>extraArgs</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">envflag.enable: true
|
|
envflag.prefix: VM_
|
|
httpListenAddr: :8427
|
|
loggerFormat: json
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Extra command line arguments for container of component</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>extraContainers</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Extra containers to run in a pod with vmauth</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>extraHostPathMounts</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Additional hostPath mounts</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>extraLabels</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Labels to be added to the deployment</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>extraObjects</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Add extra specs dynamically to this chart</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>extraVolumeMounts</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Extra Volume Mounts for the container</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>extraVolumes</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Extra Volumes for the pod</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>fullnameOverride</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Override resources fullname</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>global.cluster.dnsDomain</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">cluster.local.
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>K8s cluster domain suffix, uses for building storage pods’ FQDN. Details are <a href="https://kubernetes.io/docs/tasks/administer-cluster/dns-custom-nameservers/" target="_blank">here</a></p>
|
|
</td>
|
|
</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>
|
|
<td>global.image.registry</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Image registry, that can be shared across multiple helm charts</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>global.imagePullSecrets</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Image pull secrets, that can be shared across multiple helm charts</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>image.pullPolicy</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">IfNotPresent
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Pull policy of Docker image</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>image.registry</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Image registry</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>image.repository</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">victoriametrics/vmauth
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Victoria Metrics Auth Docker repository and image name</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>image.tag</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Tag of Docker image</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>image.variant</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Variant of the image to use. e.g. enterprise, scratch</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>imagePullSecrets</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Image pull secrets</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingress.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>Ingress annotations</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingress.enabled</td>
|
|
<td>bool</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">false
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Enable deployment of ingress for vmauth component</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingress.extraLabels</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Ingress extra labels</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingress.hosts</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">- name: vmauth.local
|
|
path:
|
|
- /
|
|
port: http
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Array of host objects</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingress.ingressClassName</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Ingress controller class name</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingress.pathType</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">Prefix
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Ingress path type</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingress.tls</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Array of TLS objects</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingressInternal.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>Ingress annotations</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingressInternal.enabled</td>
|
|
<td>bool</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">false
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Enable deployment of internal ingress for vmauth component</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingressInternal.extraLabels</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Ingress extra labels</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingressInternal.hosts</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">- name: vmauth.local
|
|
path:
|
|
- /
|
|
port: http
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Array of host objects</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingressInternal.ingressClassName</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Ingress controller class name</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingressInternal.pathType</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">Prefix
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Ingress path type</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ingressInternal.tls</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Array of TLS objects</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>initContainers</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Init containers for vmauth</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>license</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">key: ""
|
|
secret:
|
|
key: ""
|
|
name: ""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Check docs <a href="https://docs.victoriametrics.com/enterprise" target="_blank">here</a>, for more information, visit <a href="https://victoriametrics.com/products/enterprise/" target="_blank">site</a>. Request a trial license <a href="https://victoriametrics.com/products/enterprise/trial/" target="_blank">here</a> Supported starting from VictoriaMetrics v1.94.0</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>license.key</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>License key</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>license.secret</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">key: ""
|
|
name: ""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Use existing secret with license key</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>license.secret.key</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Key in secret with license key</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>license.secret.name</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Existing secret name</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>nameOverride</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Override chart name</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>nodeSelector</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>NodeSelector configurations. Check <a href="https://kubernetes.io/docs/user-guide/node-selection/" target="_blank">here</a> for details</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>podAnnotations</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Annotations to be added to pod</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>podDisruptionBudget</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">enabled: false
|
|
labels: {}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>See <code>kubectl explain poddisruptionbudget.spec</code> for more. Official guide is <a href="https://kubernetes.io/docs/tasks/run-application/configure-pdb/" target="_blank">here</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>podLabels</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Labels to be added to pod</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>podSecurityContext</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">enabled: true
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Pod’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>
|
|
<td>probe.liveness</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">initialDelaySeconds: 5
|
|
periodSeconds: 15
|
|
tcpSocket: {}
|
|
timeoutSeconds: 5
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Liveness probe</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>probe.readiness</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">initialDelaySeconds: 5
|
|
periodSeconds: 15
|
|
tcpSocket: {}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Readiness probe</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>probe.startup</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Startup probe</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>replicaCount</td>
|
|
<td>int</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">1
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Number of replicas of vmauth</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>resources</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. If you do want to specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after <code>resources:</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>secretName</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Use existing secret if specified otherwise .config values will be used. Check <a href="https://docs.victoriametrics.com/vmauth" target="_blank">here</a> for details. Configuration in the given secret must be stored under <code>auth.yml</code> key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>securityContext</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">enabled: true
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Container security context. Check <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" target="_blank">here</a> for details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.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>Service annotations</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.clusterIP</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service ClusterIP</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.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>Enable vmauth service</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.externalIPs</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</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>
|
|
<td>service.externalTrafficPolicy</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</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>
|
|
<td>service.extraLabels</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service labels</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.healthCheckNodePort</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</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>
|
|
<td>service.ipFamilies</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</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>
|
|
<td>service.ipFamilyPolicy</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</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>
|
|
<td>service.loadBalancerIP</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">""
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service load balacner IP</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.loadBalancerSourceRanges</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Load balancer source range</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.servicePort</td>
|
|
<td>int</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">8427
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service port</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>service.type</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">ClusterIP
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service type</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceAccount.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>Annotations to add to the service account</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceAccount.create</td>
|
|
<td>bool</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">true
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Specifies whether a service account should be created</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceAccount.name</td>
|
|
<td>string</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">null
|
|
</code>
|
|
</pre>
|
|
</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>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceMonitor.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>Service Monitor annotations</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceMonitor.basicAuth</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Basic auth params for Service Monitor</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceMonitor.enabled</td>
|
|
<td>bool</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
|
<code class="language-yaml">false
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Enable deployment of Service Monitor for server component. This is Prometheus operator object</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceMonitor.extraLabels</td>
|
|
<td>object</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">{}
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service Monitor labels</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceMonitor.metricRelabelings</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service Monitor metricRelabelings</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>serviceMonitor.relabelings</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Service Monitor relabelings</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>tolerations</td>
|
|
<td>list</td>
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
|
|
<code class="language-yaml">[]
|
|
</code>
|
|
</pre>
|
|
</td>
|
|
<td><p>Tolerations configurations. Check <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/" target="_blank">here</a> for details</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|