VictoriaMetrics Cluster #

false

[]

Add extra specs dynamically to this chart

[]

dnsDomain: cluster.local.

k8s cluster domain suffix, uses for building storage pods’ FQDN. Details are here

openshift:
    adaptSecurityContext: auto

Openshift security context compatibility configuration

""

Image registry, that can be shared across multiple helm charts

[]

Image pull secrets, that can be shared across multiple helm charts

key: ""
secret:
    key: ""
    name: ""

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Check docs here, for more information, visit site. Request a trial license here Supported starting from VictoriaMetrics v1.94.0

""

License key

key: ""
name: ""

Use existing secret with license key

""

Key in secret with license key

""

Existing secret name

true

Print information after deployment

{}

Service account annotations

true

mount API token to pod directly

true

Specifies whether a service account should be created

{}

Service account labels

null

The name of the service account to use. If not set and create is true, a name is generated using the fullname template

{}

Pod affinity

{}

VMAuth annotations

unauthorized_user: {}

VMAuth configuration object

""

VMAuth configuration secret name

""

Container workdir

false

Enable deployment of vmauth component. With vmauth enabled please set service.clusterIP: None and service.type: ClusterIP for vminsert and vmselect to use vmauth balancing benefits.

[]

Additional environment variables (ex.: secret tokens, flags). Check here for details

[]

Specify alternative source for env variables

envflag.enable: true
envflag.prefix: VM_
httpListenAddr: :8427
loggerFormat: json

Extra command line arguments for vmauth component

[]

Extra containers to run in a pod with vmauth

{}

VMAuth additional labels

[]

Extra Volume Mounts for the container

[]

Extra Volumes for the pod

""

Overrides the full name of vmauth component

{}

Behavior settings for scaling by the HPA

false

Use HPA for vmauth component

10

Maximum replicas for HPA to use to to scale the vmauth component

[]

Metric for HPA to use to scale the vmauth component

2

Minimum replicas for HPA to use to scale the vmauth component

IfNotPresent

Image pull policy

""

Image registry

victoriametrics/vmauth

Image repository

""

Image tag override Chart.AppVersion

""

Variant of the image to use. e.g. cluster, enterprise-cluster

{}

Ingress annotations

false

Enable deployment of ingress for vmauth component

{}

- name: vmauth.local
  path:
    - /insert
  port: http

Array of host objects

Prefix

pathType is only for k8s >= 1.1=

[]

Array of TLS objects

[]

Init containers for vmauth

""

Override default app label name

{}

Pod’s node selector. Details are here

{}

Pod’s annotations

enabled: false
labels: {}

See kubectl explain poddisruptionbudget.spec for more. Details are here

{}

VMAuth pod labels

enabled: false

Pod’s security context. Details are here

http

VMAuth http port name

""

Name of Priority Class

failureThreshold: 3
initialDelaySeconds: 5
periodSeconds: 15
tcpSocket: {}
timeoutSeconds: 5

VMAuth liveness probe

failureThreshold: 3
httpGet: {}
initialDelaySeconds: 5
periodSeconds: 15
timeoutSeconds: 5

VMAuth readiness probe

{}

VMAuth startup probe

2

Count of vmauth pods

{}

Resource object

enabled: false

Pod’s security context. Details are here

{}

Service annotations

""

Service ClusterIP

true

Create VMAuth service

[]

Service External IPs. Details are here

""

Service external traffic policy. Check here for details

[]

Extra service ports

""

Health check node port for a service. Check here for details

[]

List of service IP families. Check here for details.

""

Service IP family policy. Check here for details.

{}

Service labels

""

Service load balancer IP

[]

Load balancer source range

8427

Service port

http

Target port

ClusterIP

Service type

false

Enable UDP port. used if you have spec.opentsdbListenAddr specified Make sure that service is not type LoadBalancer, as it requires MixedProtocolLBService feature gate. Check here

{}

Service Monitor annotations

{}

Basic auth params for Service Monitor

false

Enable deployment of Service Monitor for vmauth component. This is Prometheus operator object

{}

Service Monitor labels

[]

Service Monitor metricRelabelings

""

Target namespace of ServiceMonitor manifest

[]

Service Monitor relabelings

{}

VMAuth Deployment strategy

false

Suppress rendering --storageNode FQDNs based on vmstorage.replicaCount value. If true suppress rendering --storageNodes, they can be re-defined in extraArgs

[]

Array of tolerations object. Details are here

[]

Pod topologySpreadConstraints

{}

Pod affinity

{}

StatefulSet/Deployment annotations

""

Container workdir

true

Enable deployment of vminsert component. Deployment is used

[]

Additional environment variables (ex.: secret tokens, flags). Check here for details.

[]

Specify alternative source for env variables

[]

IDs of vmstorage nodes to exclude from writing

envflag.enable: true
envflag.prefix: VM_
httpListenAddr: :8480
loggerFormat: json

Extra command line arguments for vminsert component

[]

Extra containers to run in a pod with vminsert

{}

StatefulSet/Deployment additional labels

[]

Extra Volume Mounts for the container

[]

Extra Volumes for the pod

""

Overrides the full name of vminsert component

{}

Behavior settings for scaling by the HPA

false

Use HPA for vminsert component

10

Maximum replicas for HPA to use to to scale the vminsert component

[]

Metric for HPA to use to scale the vminsert component

2

Minimum replicas for HPA to use to scale the vminsert component

IfNotPresent

Image pull policy

""

Image registry

victoriametrics/vminsert

Image repository

""

Image tag override Chart.AppVersion

cluster

Variant of the image to use. e.g. cluster, enterprise-cluster

{}

Ingress annotations

false

Enable deployment of ingress for vminsert component

{}

Ingress extra labels

- name: vminsert.local
  path:
    - /insert
  port: http

Array of host objects

""

Ingress controller class name

Prefix

Ingress path type

[]

Array of TLS objects

[]

Init containers for vminsert

""

Override default app label name

{}

Pod’s node selector. Details are here

{}

Pod’s annotations

enabled: false
labels: {}

See kubectl explain poddisruptionbudget.spec for more. Details are here

{}

Pod’s additional labels

enabled: false

Pod’s security context. Details are here

http

VMInsert http port name

""

Name of Priority Class

liveness:
    failureThreshold: 3
    initialDelaySeconds: 5
    periodSeconds: 15
    tcpSocket: {}
    timeoutSeconds: 5
readiness:
    failureThreshold: 3
    httpGet: {}
    initialDelaySeconds: 5
    periodSeconds: 15
    timeoutSeconds: 5
startup: {}

Readiness & Liveness probes

failureThreshold: 3
initialDelaySeconds: 5
periodSeconds: 15
tcpSocket: {}
timeoutSeconds: 5

VMInsert liveness probe

failureThreshold: 3
httpGet: {}
initialDelaySeconds: 5
periodSeconds: 15
timeoutSeconds: 5

VMInsert readiness probe

{}

VMInsert startup probe

2

Count of vminsert pods

{}

Resource object. Details are here

enabled: false

Pod’s security context. Details are here

{}

Service annotations

""

Service ClusterIP

true

Create VMInsert service

[]

Service external IPs. Details are here

""

Service external traffic policy. Check here for details

[]

Extra service ports

""

Health check node port for a service. Check here for details

[]

List of service IP families. Check here for details.

""

Service IP family policy. Check here for details.

{}

Service labels

""

Service load balancer IP

[]

Load balancer source range

8480

Service port

http

Target port

ClusterIP

Service type

false

Enable UDP port. used if you have spec.opentsdbListenAddr specified Make sure that service is not type LoadBalancer, as it requires MixedProtocolLBService feature gate. Check here for details

{}

Service Monitor annotations

{}

Basic auth params for Service Monitor

false

Enable deployment of Service Monitor for vminsert component. This is Prometheus operator object

{}

Service Monitor labels

[]

Service Monitor metricRelabelings

""

Target namespace of ServiceMonitor manifest

[]

Service Monitor relabelings

{}

VMInsert strategy

false

Suppress rendering --storageNode FQDNs based on vmstorage.replicaCount value. If true suppress rendering --storageNodes, they can be re-defined in extraArgs

[]

Array of tolerations object. Details are here

[]

Pod topologySpreadConstraints

{}

Pod affinity

{}

StatefulSet/Deployment annotations

/cache

Cache root folder

""

Container workdir

{}

Empty dir configuration if persistence is disabled

true

Enable deployment of vmselect component. Can be deployed as Deployment(default) or StatefulSet

[]

Additional environment variables (ex.: secret tokens, flags). Check here for details.

[]

Specify alternative source for env variables

envflag.enable: true
envflag.prefix: VM_
httpListenAddr: :8481
loggerFormat: json

Extra command line arguments for vmselect component

[]

Extra containers to run in a pod with vmselect

[]

Additional hostPath mounts

{}

StatefulSet/Deployment additional labels

[]

Extra Volume Mounts for the container

[]

Extra Volumes for the pod

""

Overrides the full name of vmselect component

{}

Behavior settings for scaling by the HPA

false

Use HPA for vmselect component

10

Maximum replicas for HPA to use to to scale the vmselect component

[]

Metric for HPA to use to scale the vmselect component

2

Minimum replicas for HPA to use to scale the vmselect component

IfNotPresent

Image pull policy

""

Image registry

victoriametrics/vmselect

Image repository

""

Image tag override Chart.AppVersion

cluster

Variant of the image to use. e.g. cluster, enterprise-cluster

{}

Ingress annotations

false

Enable deployment of ingress for vmselect component

{}

Ingress extra labels

- name: vmselect.local
  path:
    - /select
  port: http

Array of host objects

""

Ingress controller class name

Prefix

Ingress path type

[]

Array of TLS objects

[]

Init containers for vmselect

""

Override default app label name

{}

Pod’s node selector. Details are here

- ReadWriteOnce

Array of access mode. Must match those of existing PV or dynamic provisioner. Details are here

{}

Persistent volume annotations

false

Create/use Persistent Volume Claim for vmselect component. Empty dir if false. If true, vmselect will create/use a Persistent Volume Claim

""

Existing Claim name. Requires vmselect.persistentVolume.enabled: true. If defined, PVC must be created manually before volume will be bound

{}

Persistent volume labels

2Gi

Size of the volume. Better to set the same as resource limit memory property

""

Mount subpath

{}

Pod’s annotations

enabled: false
labels: {}

See kubectl explain poddisruptionbudget.spec for more. Details are here

false

See kubectl explain poddisruptionbudget.spec for more. Details are here

{}

Pod’s additional labels

enabled: true

Pod’s security context. Details are here

http

VMSelect http port name

""

Name of Priority Class

liveness:
    failureThreshold: 3
    initialDelaySeconds: 5
    periodSeconds: 15
    tcpSocket: {}
    timeoutSeconds: 5
readiness:
    failureThreshold: 3
    httpGet: {}
    initialDelaySeconds: 5
    periodSeconds: 15
    timeoutSeconds: 5
startup: {}

Readiness & Liveness probes

failureThreshold: 3
initialDelaySeconds: 5
periodSeconds: 15
tcpSocket: {}
timeoutSeconds: 5

VMSelect liveness probe

failureThreshold: 3
httpGet: {}
initialDelaySeconds: 5
periodSeconds: 15
timeoutSeconds: 5

VMSelect readiness probe

{}

VMSelect startup probe

2

Count of vmselect pods

{}

Resource object. Details are here

enabled: true

Pod’s security context. Details are here

{}

Service annotations

""

Service ClusterIP

true

Create VMSelect service

[]

Service external IPs. Details are here

""

Service external traffic policy. Check here for details

[]

Extra service ports

""

Health check node port for a service. Check here for details

[]

List of service IP families. Check here for details.

""

Service IP family policy. Check here for details.

{}

Service labels

""

Service load balancer IP

[]

Load balancer source range

8481

Service port

http

Target port

ClusterIP

Service type

{}

Service Monitor annotations

{}

Basic auth params for Service Monitor

false

Enable deployment of Service Monitor for vmselect component. This is Prometheus operator object

{}

Service Monitor labels

[]

Service Monitor metricRelabelings

""

Target namespace of ServiceMonitor manifest

[]

Service Monitor relabelings

false

Deploy StatefulSet instead of Deployment for vmselect. Useful if you want to keep cache data.

OrderedReady

Deploy order policy for StatefulSet pods

{}

VMSelect strategy

false

Suppress rendering --storageNode FQDNs based on vmstorage.replicaCount value. If true suppress rendering --storageNodes, they can be re-defined in extraArgs

[]

Array of tolerations object. Details are here

[]

Pod topologySpreadConstraints

{}

Pod affinity

{}

StatefulSet/Deployment annotations

""

Container workdir

{}

Empty dir configuration if persistence is disabled

true

Enable deployment of vmstorage component. StatefulSet is used

[]

Additional environment variables (ex.: secret tokens, flags). Check here for details

[]

Specify alternative source for env variables

envflag.enable: true
envflag.prefix: VM_
httpListenAddr: :8482
loggerFormat: json

Additional vmstorage container arguments. Extra command line arguments for vmstorage component

[]

Extra containers to run in a pod with vmstorage

[]

Additional hostPath mounts

{}

StatefulSet/Deployment additional labels

[]

Extra secret mounts for vmstorage

[]

Extra Volume Mounts for the container

[]

Extra Volumes for the pod

null

Overrides the full name of vmstorage component

scaleDown:
    selectPolicy: Disabled

Behavior settings for scaling by the HPA

false

Use HPA for vmstorage component

10

Maximum replicas for HPA to use to to scale the vmstorage component

[]

Metric for HPA to use to scale the vmstorage component

2

Minimum replicas for HPA to use to scale the vmstorage component

IfNotPresent

Image pull policy

""

Image registry

victoriametrics/vmstorage

Image repository

""

Image tag override Chart.AppVersion

cluster

Variant of the image to use. e.g. cluster, enterprise-cluster

[]

Init containers for vmstorage

""

Override default app label name

{}

Pod’s node selector. Details are here

- ReadWriteOnce

Array of access modes. Must match those of existing PV or dynamic provisioner. Details are here

{}

Persistent volume annotations

true

Create/use Persistent Volume Claim for vmstorage component. Empty dir if false. If true, vmstorage will create/use a Persistent Volume Claim

""

Existing Claim name. Requires vmstorage.persistentVolume.enabled: true. If defined, PVC must be created manually before volume will be bound

{}

Persistent volume labels

/storage

Data root path. Vmstorage data Persistent Volume mount root path

vmstorage-volume

8Gi

Size of the volume.

""

Storage class name. Will be empty if not setted

""

Mount subpath

{}

Pod’s annotations

enabled: false
labels: {}

See kubectl explain poddisruptionbudget.spec for more. Details are here

{}

Pod’s additional labels

OrderedReady

Deploy order policy for StatefulSet pods

enabled: false

Pod’s security context. Details are here

http

VMStorage http port name

""

Name of Priority Class

liveness:
    failureThreshold: 10
    initialDelaySeconds: 30
    periodSeconds: 30
    tcpSocket: {}
    timeoutSeconds: 5
readiness:
    failureThreshold: 3
    httpGet: {}
    initialDelaySeconds: 5
    periodSeconds: 15
    timeoutSeconds: 5
startup: {}

Readiness & Liveness probes

failureThreshold: 10
initialDelaySeconds: 30
periodSeconds: 30
tcpSocket: {}
timeoutSeconds: 5

VMStorage liveness probe

failureThreshold: 3
httpGet: {}
initialDelaySeconds: 5
periodSeconds: 15
timeoutSeconds: 5

VMStorage readiness probe

{}

VMStorage startup probe

2

Count of vmstorage pods

{}

Resource object. Details are here

1

Data retention period. Possible units character: h(ours), d(ays), w(eeks), y(ears), if no unit character specified - month. The minimum retention period is 24h. See these docs

""

Use an alternate scheduler, e.g. “stork”. Check here for details

enabled: false

Pod’s security context. Details are here

{}

Service annotations

None

Service ClusterIP

true

""

Service external traffic policy. Check here for details

[]

Extra service ports

""

Health check node port for a service. Check here for details

[]

List of service IP families. Check here for details.

""

Service IP family policy. Check here for details.

{}

Service labels

8482

Service port

ClusterIP

Service type

8400

Port for accepting connections from vminsert

8401

Port for accepting connections from vmselect

{}

Service Monitor annotations

{}

Basic auth params for Service Monitor

false

Enable deployment of Service Monitor for vmstorage component. This is Prometheus operator object

{}

Service Monitor labels

[]

Service Monitor metricRelabelings

""

Target namespace of ServiceMonitor manifest

[]

Service Monitor relabelings

60

Pod’s termination grace period in seconds

[]

Array of tolerations object. Node tolerations for server scheduling to nodes with taints. Details are here

[]

Pod topologySpreadConstraints

""

Backup destination at S3, GCS or local filesystem. Pod name will be included to path!

false

Disable daily backups

false

Disable hourly backups

false

Disable monthly backups

false

Disable weekly backups

false

Enable automatic creation of backup via vmbackupmanager. vmbackupmanager is part of Enterprise packages

[]

Additional environment variables (ex.: secret tokens, flags). Check here for details

envflag.enable: true
envflag.prefix: VM_
loggerFormat: json

Extra command line arguments for container of component

[]

Extra secret mounts for vmbackupmanager

""

VMBackupManager image registry

victoriametrics/vmbackupmanager

VMBackupManager image repository

""

VMBackupManager image tag override Chart.AppVersion

cluster

Variant of the image tag to use. e.g. enterprise.

liveness:
    failureThreshold: 10
    initialDelaySeconds: 30
    periodSeconds: 30
    tcpSocket:
        port: manager-http
    timeoutSeconds: 5
readiness:
    failureThreshold: 3
    httpGet:
        port: manager-http
    initialDelaySeconds: 5
    periodSeconds: 15
    timeoutSeconds: 5
startup: {}

Readiness & Liveness probes

failureThreshold: 10
initialDelaySeconds: 30
periodSeconds: 30
tcpSocket:
    port: manager-http
timeoutSeconds: 5

VMBackupManager liveness probe

failureThreshold: 3
httpGet:
    port: manager-http
initialDelaySeconds: 5
periodSeconds: 15
timeoutSeconds: 5

VMBackupManager readiness probe

{}

VMBackupManager startup probe

{}

Resource object. Details are here

onStart:
    enabled: false

Allows to enable restore options for pod. Check here for details

keepLastDaily: 2
keepLastHourly: 2
keepLastMonthly: 2
keepLastWeekly: 2

Backups’ retention settings

2

Keep last N daily backups. 0 means delete all existing daily backups. Specify -1 to turn off

2

Keep last N hourly backups. 0 means delete all existing hourly backups. Specify -1 to turn off

2

Keep last N monthly backups. 0 means delete all existing monthly backups. Specify -1 to turn off

2

Keep last N weekly backups. 0 means delete all existing weekly backups. Specify -1 to turn off