diff --git a/docs/helm/README.md b/docs/helm/README.md index b01b9069c3..d62e10fbdc 100644 --- a/docs/helm/README.md +++ b/docs/helm/README.md @@ -123,14 +123,14 @@ helm charts tested at kubernetes versions from 1.28 to 1.30. ## List of Charts -- [Victoria Logs Single-Node](./charts/victoria-logs-single) -- [Victoria Metrics Agent](./charts/victoria-metrics-agent) -- [Victoria Metrics Alert](./charts/victoria-metrics-alert) -- [Victoria Metrics Anomaly](./charts/victoria-metrics-anomaly) -- [Victoria Metrics Auth](./charts/victoria-metrics-auth) -- [Victoria Metrics Cluster](./charts/victoria-metrics-cluster) -- [Victoria Metrics Gateway](./charts/victoria-metrics-gateway) -- [Victoria Metrics Distributed](./charts/victoria-metrics-distributed) -- [Victoria Metrics k8s Stack](./charts/victoria-metrics-k8s-stack) -- [Victoria Metrics Operator](./charts/victoria-metrics-operator) -- [Victoria Metrics Single-node](./charts/victoria-metrics-single) +- [VictoriaLogs Single](https://docs.victoriametrics.com/helm/victorialogs-single) +- [VictoriaMetrics Agent](https://docs.victoriametrics.com/helm/victoriametrics-agent) +- [VictoriaMetrics Alert](https://docs.victoriametrics.com/helm/victoriametrics-alert) +- [VictoriaMetrics Anomaly](https://docs.victoriametrics.com/helm/victoriametrics-anomaly) +- [VictoriaMetrics Auth](https://docs.victoriametrics.com/helm/victoriametrics-auth) +- [VictoriaMetrics Cluster](https://docs.victoriametrics.com/helm/victoriametrics-cluster) +- [VictoriaMetrics Gateway](https://docs.victoriametrics.com/helm/victoriametrics-gateway) +- [VictoriaMetrics Distributed](https://docs.victoriametrics.com/helm/victoriametrics-distributed) +- [VictoriaMetrics K8s Stack](https://docs.victoriametrics.com/helm/victoriametrics-k8s-stack) +- [VictoriaMetrics Operator](https://docs.victoriametrics.com/helm/victoriametrics-operator) +- [VictoriaMetrics Single](https://docs.victoriametrics.com/helm/victoriametrics-single) diff --git a/docs/helm/_index.md b/docs/helm/_index.md index d3de7b0f53..e08635ea53 100644 --- a/docs/helm/_index.md +++ b/docs/helm/_index.md @@ -3,8 +3,9 @@ weight: 0 title: Helm Charts menu: docs: - weight: 0 + weight: 35 identifier: helm + pageRef: /helm/ aliases: - /helm - /helm/index.html diff --git a/docs/helm/victoria-logs-single/README.md b/docs/helm/victoria-logs-single/README.md index af0c308d38..a70af8d9b9 100644 --- a/docs/helm/victoria-logs-single/README.md +++ b/docs/helm/victoria-logs-single/README.md @@ -135,29 +135,83 @@ 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-logs-single/values.yaml`` file. - +
- - - - + + + + - + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - + - - + - - + - - - - - + + - - + - - - - - - - - - - + - - - - - - - - - - - - - + - - - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + - - + - - + - - - - - - - - - - - - - - - + + + + + + diff --git a/docs/helm/victoria-metrics-agent/README.md b/docs/helm/victoria-metrics-agent/README.md index 0e06b28611..3d71e22f17 100644 --- a/docs/helm/victoria-metrics-agent/README.md +++ b/docs/helm/victoria-metrics-agent/README.md @@ -118,374 +118,396 @@ 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-agent/values.yaml`` file. -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
extraObjects list
-[]
+      
+[]
+

Add extra specs dynamically to this chart

+
fluent-bitobject
+config:
+    filters: |
+        [FILTER]
+            Name kubernetes
+            Match kube.*
+            Merge_Log On
+            Keep_Log On
+            K8S-Logging.Parser On
+            K8S-Logging.Exclude On
+        [FILTER]
+            Name                nest
+            Match               *
+            Wildcard            pod_name
+            Operation lift
+            Nested_under kubernetes
+            Add_prefix   kubernetes_
+    outputs: |
+        [OUTPUT]
+            Name http
+            Match kube.*
+            Host '{{ include "victoria-logs.server.fullname" . }}'
+            port 9428
+            compress gzip
+            uri /insert/jsonline?_stream_fields=stream,kubernetes_pod_name,kubernetes_container_name,kubernetes_namespace_name&_msg_field=log&_time_field=date
+            format json_lines
+            json_date_format iso8601
+            header AccountID 0
+            header ProjectID 0
+daemonSetVolumeMounts:
+    - mountPath: /var/log
+      name: varlog
+    - mountPath: /var/lib/docker/containers
+      name: varlibdockercontainers
+      readOnly: true
+daemonSetVolumes:
+    - hostPath:
+        path: /var/log
+      name: varlog
+    - hostPath:
+        path: /var/lib/docker/containers
+      name: varlibdockercontainers
+enabled: false
+resources: {}
+
+
+

Values for fluent-bit helm chart
fluent-bit.config.filters tpl
-fluent-bit.config.filters: |
+      
+fluent-bit.config.filters: |
   [FILTER]
       Name kubernetes
       Match kube.*
@@ -173,6 +227,7 @@ fluent-bit.config.filters: |
       Nested_under kubernetes
       Add_prefix   kubernetes_
  
+

FluentBit configuration filters

@@ -181,8 +236,8 @@ fluent-bit.config.filters: |
fluent-bit.config.outputs tpl
-fluent-bit.config.outputs: |
+      
+fluent-bit.config.outputs: |
   [OUTPUT]
       Name http
       Match kube.*
@@ -195,152 +250,74 @@ fluent-bit.config.outputs: |
       header AccountID 0
       header ProjectID 0
  
+

Note that Host must be replaced to match your VictoriaLogs service name Default format points to VictoriaLogs service.
fluent-bit.daemonSetVolumeMounts[0].mountPathstring
-/var/log
-
-
fluent-bit.daemonSetVolumeMounts[0].namestring
-varlog
-
-
fluent-bit.daemonSetVolumeMounts[1].mountPathstring
-/var/lib/docker/containers
-
-
fluent-bit.daemonSetVolumeMounts[1].namestring
-varlibdockercontainers
-
-
fluent-bit.daemonSetVolumeMounts[1].readOnlybool
-true
-
-
fluent-bit.daemonSetVolumes[0].hostPath.pathstring
-/var/log
-
-
fluent-bit.daemonSetVolumes[0].namestring
-varlog
-
-
fluent-bit.daemonSetVolumes[1].hostPath.pathstring
-/var/lib/docker/containers
-
-
fluent-bit.daemonSetVolumes[1].namestring
-varlibdockercontainers
-
-
fluent-bit.enabled bool
-false
+      
+false
+

Enable deployment of fluent-bit
fluent-bit.resourcesglobal.compatibility object
-{}
+      
+openshift:
+    adaptSecurityContext: auto
+
global.compatibility.openshift.adaptSecurityContextstring
-auto
-
+

Openshift security context compatibility configuration
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
global.nameOverride string
-""
+      
+""
+

Global name override

+
global.victoriaLogs.server.fullnameOverride string
-null
+      
+null
+

Overrides the full name of server component

@@ -349,18 +326,21 @@ null
global.victoriaLogs.server.name string
-server
+      
+server
+

Server container name
podDisruptionBudget.enabledbool
-false
+
podDisruptionBudgetobject
+enabled: false
+extraLabels: {}
+

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

@@ -369,17 +349,20 @@ false
podDisruptionBudget.extraLabels object
-{}
+      
+{}
+

PodDisruptionBudget extra labels

+
printNotes bool
-true
+      
+true
+

Print chart notes

@@ -388,8 +371,9 @@ true
server.affinity object
-{}
+      
+{}
+

Pod affinity

@@ -398,8 +382,9 @@ true
server.containerWorkingDir string
-""
+      
+""
+

Container workdir

@@ -408,18 +393,20 @@ true
server.emptyDir object
-{}
+      
+{}
+

Use an alternate scheduler, e.g. “stork”. ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/ schedulerName:

+

Use an alternate scheduler, e.g. “stork”. Check details here schedulerName:
server.enabled bool
-true
+      
+true
+

Enable deployment of server component. Deployed as StatefulSet

@@ -428,29 +415,33 @@ true
server.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://github.com/VictoriaMetrics/VictoriaMetrics#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Details are here
server.envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
server.extraArgs object
-envflag.enable: "true"
+      
+envflag.enable: "true"
 envflag.prefix: VM_
 loggerFormat: json
+

Extra command line arguments for container of component

@@ -459,8 +450,9 @@ loggerFormat: json
server.extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with Victoria Logs container

@@ -469,8 +461,9 @@ loggerFormat: json
server.extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -479,18 +472,20 @@ loggerFormat: json
server.extraLabels object
-{}
+      
+{}
+

Sts/Deploy additional labels

+

StatefulSet/Deployment additional labels
server.extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -499,8 +494,9 @@ loggerFormat: json
server.extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -509,8 +505,9 @@ loggerFormat: json
server.image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Image pull policy

@@ -519,8 +516,9 @@ IfNotPresent
server.image.registry string
-""
+      
+""
+

Image registry

@@ -529,8 +527,9 @@ IfNotPresent
server.image.repository string
-victoriametrics/victoria-logs
+      
+victoriametrics/victoria-logs
+

Image repository

@@ -539,8 +538,9 @@ victoriametrics/victoria-logs
server.image.tag string
-""
+      
+""
+

Image tag

@@ -549,17 +549,20 @@ victoriametrics/victoria-logs
server.image.variant string
-victorialogs
+      
+victorialogs
+

Image tag suffix, which is appended to Chart.AppVersion if no server.image.tag is defined

+
server.imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

@@ -568,8 +571,9 @@ victorialogs
server.ingress.annotations string
-null
+      
+null
+

Ingress annotations

@@ -578,8 +582,9 @@ null
server.ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for server component

@@ -588,8 +593,9 @@ false
server.ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

@@ -598,27 +604,42 @@ false
server.ingress.hosts list
-[]
+      
+[]
+

Array of host objects

+
server.ingress.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
server.ingress.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

+

Ingress path type
server.ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

@@ -627,8 +648,9 @@ Prefix
server.initContainers list
-[]
+      
+[]
+

Init containers for Victoria Logs Pod

@@ -637,8 +659,9 @@ Prefix
server.nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

@@ -647,8 +670,9 @@ Prefix
server.persistentVolume.accessModes list
-- ReadWriteOnce
+      
+- ReadWriteOnce
+

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

@@ -657,8 +681,9 @@ Prefix
server.persistentVolume.annotations object
-{}
+      
+{}
+

Persistant volume annotations

@@ -667,8 +692,9 @@ Prefix
server.persistentVolume.enabled bool
-false
+      
+false
+

Create/use Persistent Volume Claim for server component. Empty dir if false

@@ -677,8 +703,9 @@ false
server.persistentVolume.existingClaim string
-""
+      
+""
+

Existing Claim name. If defined, PVC must be created manually before volume will be bound

@@ -687,8 +714,9 @@ false
server.persistentVolume.matchLabels object
-{}
+      
+{}
+

Bind Persistent Volume by labels. Must match all labels of targeted PV.

@@ -697,8 +725,9 @@ false
server.persistentVolume.mountPath string
-/storage
+      
+/storage
+

Mount path. Server data Persistent Volume mount root path.

@@ -707,8 +736,9 @@ false
server.persistentVolume.size string
-3Gi
+      
+3Gi
+

Size of the volume. Should be calculated based on the logs you send and retention policy you set.

@@ -717,8 +747,9 @@ false
server.persistentVolume.storageClassName string
-""
+      
+""
+

StorageClass to use for persistent volume. Requires server.persistentVolume.enabled: true. If defined, PVC created automatically

@@ -727,8 +758,9 @@ false
server.persistentVolume.subPath string
-""
+      
+""
+

Mount subpath

@@ -737,8 +769,9 @@ false
server.podAnnotations object
-{}
+      
+{}
+

Pod’s annotations

@@ -747,8 +780,9 @@ false
server.podLabels object
-{}
+      
+{}
+

Pod’s additional labels

@@ -757,8 +791,9 @@ false
server.podManagementPolicy string
-OrderedReady
+      
+OrderedReady
+

Pod’s management policy

@@ -767,11 +802,12 @@ OrderedReady
server.podSecurityContext object
-enabled: true
+      
+enabled: true
 fsGroup: 2000
 runAsNonRoot: true
 runAsUser: 1000
+

Pod’s security context. Details are here

@@ -780,8 +816,9 @@ runAsUser: 1000
server.priorityClassName string
-""
+      
+""
+

Name of Priority Class

@@ -790,12 +827,13 @@ runAsUser: 1000
server.probe.liveness object
-failureThreshold: 10
+      
+failureThreshold: 10
 initialDelaySeconds: 30
 periodSeconds: 30
 tcpSocket: {}
 timeoutSeconds: 5
+

Indicates whether the Container is running. If the liveness probe fails, the kubelet kills the Container, and the Container is subjected to its restart policy. If a Container does not provide a liveness probe, the default state is Success.

@@ -804,12 +842,13 @@ timeoutSeconds: 5
server.probe.readiness object
-failureThreshold: 3
+      
+failureThreshold: 3
 httpGet: {}
 initialDelaySeconds: 5
 periodSeconds: 15
 timeoutSeconds: 5
+

Indicates whether the Container is ready to service requests. If the readiness probe fails, the endpoints controller removes the Pod’s IP address from the endpoints of all Services that match the Pod. The default state of readiness before the initial delay is Failure. If a Container does not provide a readiness probe, the default state is Success.

@@ -818,8 +857,9 @@ timeoutSeconds: 5
server.probe.startup object
-{}
+      
+{}
+

Indicates whether the Container is done with potentially costly initialization. If set it is executed first. If it fails Container is restarted. If it succeeds liveness and readiness probes takes over.

@@ -828,8 +868,9 @@ timeoutSeconds: 5
server.replicaCount int
-1
+      
+1
+

Replica count

@@ -838,8 +879,9 @@ timeoutSeconds: 5
server.resources object
-{}
+      
+{}
+

Resource object. Details are here

@@ -848,8 +890,9 @@ timeoutSeconds: 5
server.retentionPeriod int
-1
+      
+1
+

Data retention period in month

@@ -858,13 +901,14 @@ timeoutSeconds: 5
server.securityContext object
-allowPrivilegeEscalation: false
+      
+allowPrivilegeEscalation: false
 capabilities:
     drop:
         - ALL
 enabled: true
 readOnlyRootFilesystem: true
+

Security context to be added to server pods

@@ -873,8 +917,9 @@ readOnlyRootFilesystem: true
server.service.annotations object
-{}
+      
+{}
+

Service annotations

@@ -883,8 +928,9 @@ readOnlyRootFilesystem: true
server.service.clusterIP string
-""
+      
+""
+

Service ClusterIP

@@ -893,54 +939,64 @@ readOnlyRootFilesystem: true
server.service.externalIPs list
-[]
+      
+[]
+

Service External IPs. Details are here

+

Service external IPs. Details are here
server.service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
server.service.healthCheckNodePort string
-""
+      
+""
+

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

+
server.service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
server.service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
server.service.labels object
-{}
+      
+{}
+

Service labels

@@ -949,8 +1005,9 @@ readOnlyRootFilesystem: true
server.service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

@@ -959,8 +1016,9 @@ readOnlyRootFilesystem: true
server.service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

@@ -969,8 +1027,9 @@ readOnlyRootFilesystem: true
server.service.servicePort int
-9428
+      
+9428
+

Service port

@@ -979,8 +1038,9 @@ readOnlyRootFilesystem: true
server.service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

@@ -989,8 +1049,9 @@ ClusterIP
server.serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -999,8 +1060,9 @@ ClusterIP
server.serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -1009,8 +1071,9 @@ ClusterIP
server.serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -1019,8 +1082,9 @@ false
server.serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -1029,8 +1093,9 @@ false
server.serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -1039,8 +1104,9 @@ false
server.serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -1049,8 +1115,9 @@ false
server.statefulSet.enabled bool
-true
+      
+true
+

Creates statefulset instead of deployment, useful when you want to keep the cache

@@ -1059,8 +1126,9 @@ true
server.statefulSet.podManagementPolicy string
-OrderedReady
+      
+OrderedReady
+

Deploy order policy for StatefulSet pods

@@ -1069,8 +1137,9 @@ OrderedReady
server.terminationGracePeriodSeconds int
-60
+      
+60
+

Pod’s termination grace period in seconds

@@ -1079,11 +1148,23 @@ OrderedReady
server.tolerations list
-[]
+      
+[]
+

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

+
server.topologySpreadConstraintslist
+[]
+
+
+

Pod topologySpreadConstraints
+
- - - - + + + + - - + - - - - + + - - - - - - - - - - - + - - + + + + + + - - + - - - - + - - - - + - - - - - - - - - + - - - + + - + - - + - - + - - - - - - - - + - - - - - - + - - + - - + - - + - - + + + + + + + - - - - + - - + - - - - - - - - + - - + - - + - - - + + - + - - + - - + - - + - - + - - - + + + + + + + - - - - - - - - + + - + - - - - - - - - - - + - - + - - + - - - - - + - - + - - - + + - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - - - - - - - - - - - - - - - + + - + + + + + + + - - +
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
affinity object
-{}
+      
+{}
+

Pod affinity

+
annotations object
-{}
+      
+{}
+

Annotations to be added to the deployment
config.global.scrape_intervalstring
-10s
+
configobject
+global:
+    scrape_interval: 10s
+scrape_configs:
+    - job_name: vmagent
+      static_configs:
+        - targets:
+            - localhost:8429
+    - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
+      job_name: kubernetes-apiservers
+      kubernetes_sd_configs:
+        - role: endpoints
+      relabel_configs:
+        - action: keep
+          regex: default;kubernetes;https
+          source_labels:
+            - __meta_kubernetes_namespace
+            - __meta_kubernetes_service_name
+            - __meta_kubernetes_endpoint_port_name
+      scheme: https
+      tls_config:
+        ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
+        insecure_skip_verify: true
+    - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
+      job_name: kubernetes-nodes
+      kubernetes_sd_configs:
+        - role: node
+      relabel_configs:
+        - action: labelmap
+          regex: __meta_kubernetes_node_label_(.+)
+        - replacement: kubernetes.default.svc:443
+          target_label: __address__
+        - regex: (.+)
+          replacement: /api/v1/nodes/$1/proxy/metrics
+          source_labels:
+            - __meta_kubernetes_node_name
+          target_label: __metrics_path__
+      scheme: https
+      tls_config:
+        ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
+        insecure_skip_verify: true
+    - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
+      honor_timestamps: false
+      job_name: kubernetes-nodes-cadvisor
+      kubernetes_sd_configs:
+        - role: node
+      relabel_configs:
+        - action: labelmap
+          regex: __meta_kubernetes_node_label_(.+)
+        - replacement: kubernetes.default.svc:443
+          target_label: __address__
+        - regex: (.+)
+          replacement: /api/v1/nodes/$1/proxy/metrics/cadvisor
+          source_labels:
+            - __meta_kubernetes_node_name
+          target_label: __metrics_path__
+      scheme: https
+      tls_config:
+        ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
+        insecure_skip_verify: true
+    - job_name: kubernetes-service-endpoints
+      kubernetes_sd_configs:
+        - role: endpointslices
+      relabel_configs:
+        - action: drop
+          regex: true
+          source_labels:
+            - __meta_kubernetes_pod_container_init
+        - action: keep_if_equal
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_port
+            - __meta_kubernetes_pod_container_port_number
+        - action: keep
+          regex: true
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_scrape
+        - action: replace
+          regex: (https?)
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_scheme
+          target_label: __scheme__
+        - action: replace
+          regex: (.+)
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_path
+          target_label: __metrics_path__
+        - action: replace
+          regex: ([^:]+)(?::\d+)?;(\d+)
+          replacement: $1:$2
+          source_labels:
+            - __address__
+            - __meta_kubernetes_service_annotation_prometheus_io_port
+          target_label: __address__
+        - action: labelmap
+          regex: __meta_kubernetes_service_label_(.+)
+        - source_labels:
+            - __meta_kubernetes_pod_name
+          target_label: pod
+        - source_labels:
+            - __meta_kubernetes_pod_container_name
+          target_label: container
+        - source_labels:
+            - __meta_kubernetes_namespace
+          target_label: namespace
+        - source_labels:
+            - __meta_kubernetes_service_name
+          target_label: service
+        - replacement: ${1}
+          source_labels:
+            - __meta_kubernetes_service_name
+          target_label: job
+        - action: replace
+          source_labels:
+            - __meta_kubernetes_pod_node_name
+          target_label: node
+    - job_name: kubernetes-service-endpoints-slow
+      kubernetes_sd_configs:
+        - role: endpointslices
+      relabel_configs:
+        - action: drop
+          regex: true
+          source_labels:
+            - __meta_kubernetes_pod_container_init
+        - action: keep_if_equal
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_port
+            - __meta_kubernetes_pod_container_port_number
+        - action: keep
+          regex: true
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_scrape_slow
+        - action: replace
+          regex: (https?)
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_scheme
+          target_label: __scheme__
+        - action: replace
+          regex: (.+)
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_path
+          target_label: __metrics_path__
+        - action: replace
+          regex: ([^:]+)(?::\d+)?;(\d+)
+          replacement: $1:$2
+          source_labels:
+            - __address__
+            - __meta_kubernetes_service_annotation_prometheus_io_port
+          target_label: __address__
+        - action: labelmap
+          regex: __meta_kubernetes_service_label_(.+)
+        - source_labels:
+            - __meta_kubernetes_pod_name
+          target_label: pod
+        - source_labels:
+            - __meta_kubernetes_pod_container_name
+          target_label: container
+        - source_labels:
+            - __meta_kubernetes_namespace
+          target_label: namespace
+        - source_labels:
+            - __meta_kubernetes_service_name
+          target_label: service
+        - replacement: ${1}
+          source_labels:
+            - __meta_kubernetes_service_name
+          target_label: job
+        - action: replace
+          source_labels:
+            - __meta_kubernetes_pod_node_name
+          target_label: node
+      scrape_interval: 5m
+      scrape_timeout: 30s
+    - job_name: kubernetes-services
+      kubernetes_sd_configs:
+        - role: service
+      metrics_path: /probe
+      params:
+        module:
+            - http_2xx
+      relabel_configs:
+        - action: keep
+          regex: true
+          source_labels:
+            - __meta_kubernetes_service_annotation_prometheus_io_probe
+        - source_labels:
+            - __address__
+          target_label: __param_target
+        - replacement: blackbox
+          target_label: __address__
+        - source_labels:
+            - __param_target
+          target_label: instance
+        - action: labelmap
+          regex: __meta_kubernetes_service_label_(.+)
+        - source_labels:
+            - __meta_kubernetes_namespace
+          target_label: namespace
+        - source_labels:
+            - __meta_kubernetes_service_name
+          target_label: service
+    - job_name: kubernetes-pods
+      kubernetes_sd_configs:
+        - role: pod
+      relabel_configs:
+        - action: drop
+          regex: true
+          source_labels:
+            - __meta_kubernetes_pod_container_init
+        - action: keep_if_equal
+          source_labels:
+            - __meta_kubernetes_pod_annotation_prometheus_io_port
+            - __meta_kubernetes_pod_container_port_number
+        - action: keep
+          regex: true
+          source_labels:
+            - __meta_kubernetes_pod_annotation_prometheus_io_scrape
+        - action: replace
+          regex: (.+)
+          source_labels:
+            - __meta_kubernetes_pod_annotation_prometheus_io_path
+          target_label: __metrics_path__
+        - action: replace
+          regex: ([^:]+)(?::\d+)?;(\d+)
+          replacement: $1:$2
+          source_labels:
+            - __address__
+            - __meta_kubernetes_pod_annotation_prometheus_io_port
+          target_label: __address__
+        - action: labelmap
+          regex: __meta_kubernetes_pod_label_(.+)
+        - source_labels:
+            - __meta_kubernetes_pod_name
+          target_label: pod
+        - source_labels:
+            - __meta_kubernetes_pod_container_name
+          target_label: container
+        - source_labels:
+            - __meta_kubernetes_namespace
+          target_label: namespace
+        - action: replace
+          source_labels:
+            - __meta_kubernetes_pod_node_name
+          target_label: node
+
config.scrape_configslist
-- job_name: vmagent
-  static_configs:
-    - targets:
-        - localhost:8429
-- bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-  job_name: kubernetes-apiservers
-  kubernetes_sd_configs:
-    - role: endpoints
-  relabel_configs:
-    - action: keep
-      regex: default;kubernetes;https
-      source_labels:
-        - __meta_kubernetes_namespace
-        - __meta_kubernetes_service_name
-        - __meta_kubernetes_endpoint_port_name
-  scheme: https
-  tls_config:
-    ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-    insecure_skip_verify: true
-- bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-  job_name: kubernetes-nodes
-  kubernetes_sd_configs:
-    - role: node
-  relabel_configs:
-    - action: labelmap
-      regex: __meta_kubernetes_node_label_(.+)
-    - replacement: kubernetes.default.svc:443
-      target_label: __address__
-    - regex: (.+)
-      replacement: /api/v1/nodes/$1/proxy/metrics
-      source_labels:
-        - __meta_kubernetes_node_name
-      target_label: __metrics_path__
-  scheme: https
-  tls_config:
-    ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-    insecure_skip_verify: true
-- bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-  honor_timestamps: false
-  job_name: kubernetes-nodes-cadvisor
-  kubernetes_sd_configs:
-    - role: node
-  relabel_configs:
-    - action: labelmap
-      regex: __meta_kubernetes_node_label_(.+)
-    - replacement: kubernetes.default.svc:443
-      target_label: __address__
-    - regex: (.+)
-      replacement: /api/v1/nodes/$1/proxy/metrics/cadvisor
-      source_labels:
-        - __meta_kubernetes_node_name
-      target_label: __metrics_path__
-  scheme: https
-  tls_config:
-    ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-    insecure_skip_verify: true
-- job_name: kubernetes-service-endpoints
-  kubernetes_sd_configs:
-    - role: endpointslices
-  relabel_configs:
-    - action: drop
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_container_init
-    - action: keep_if_equal
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-        - __meta_kubernetes_pod_container_port_number
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scrape
-    - action: replace
-      regex: (https?)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scheme
-      target_label: __scheme__
-    - action: replace
-      regex: (.+)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_path
-      target_label: __metrics_path__
-    - action: replace
-      regex: ([^:]+)(?::\d+)?;(\d+)
-      replacement: $1:$2
-      source_labels:
-        - __address__
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-      target_label: __address__
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - source_labels:
-        - __meta_kubernetes_pod_name
-      target_label: pod
-    - source_labels:
-        - __meta_kubernetes_pod_container_name
-      target_label: container
-    - source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-    - replacement: ${1}
-      source_labels:
-        - __meta_kubernetes_service_name
-      target_label: job
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_pod_node_name
-      target_label: node
-- job_name: kubernetes-service-endpoints-slow
-  kubernetes_sd_configs:
-    - role: endpointslices
-  relabel_configs:
-    - action: drop
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_container_init
-    - action: keep_if_equal
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-        - __meta_kubernetes_pod_container_port_number
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scrape_slow
-    - action: replace
-      regex: (https?)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scheme
-      target_label: __scheme__
-    - action: replace
-      regex: (.+)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_path
-      target_label: __metrics_path__
-    - action: replace
-      regex: ([^:]+)(?::\d+)?;(\d+)
-      replacement: $1:$2
-      source_labels:
-        - __address__
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-      target_label: __address__
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - source_labels:
-        - __meta_kubernetes_pod_name
-      target_label: pod
-    - source_labels:
-        - __meta_kubernetes_pod_container_name
-      target_label: container
-    - source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-    - replacement: ${1}
-      source_labels:
-        - __meta_kubernetes_service_name
-      target_label: job
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_pod_node_name
-      target_label: node
-  scrape_interval: 5m
-  scrape_timeout: 30s
-- job_name: kubernetes-services
-  kubernetes_sd_configs:
-    - role: service
-  metrics_path: /probe
-  params:
-    module:
-        - http_2xx
-  relabel_configs:
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_probe
-    - source_labels:
-        - __address__
-      target_label: __param_target
-    - replacement: blackbox
-      target_label: __address__
-    - source_labels:
-        - __param_target
-      target_label: instance
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-- job_name: kubernetes-pods
-  kubernetes_sd_configs:
-    - role: pod
-  relabel_configs:
-    - action: drop
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_container_init
-    - action: keep_if_equal
-      source_labels:
-        - __meta_kubernetes_pod_annotation_prometheus_io_port
-        - __meta_kubernetes_pod_container_port_number
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_annotation_prometheus_io_scrape
-    - action: replace
-      regex: (.+)
-      source_labels:
-        - __meta_kubernetes_pod_annotation_prometheus_io_path
-      target_label: __metrics_path__
-    - action: replace
-      regex: ([^:]+)(?::\d+)?;(\d+)
-      replacement: $1:$2
-      source_labels:
-        - __address__
-        - __meta_kubernetes_pod_annotation_prometheus_io_port
-      target_label: __address__
-    - action: labelmap
-      regex: __meta_kubernetes_pod_label_(.+)
-    - source_labels:
-        - __meta_kubernetes_pod_name
-      target_label: pod
-    - source_labels:
-        - __meta_kubernetes_pod_container_name
-      target_label: container
-    - source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_pod_node_name
-      target_label: node
-
-

scrape configuration. scrape self by default

+

VMAgent scrape configuration
configMap string
-""
+      
+""
+

vmagent scraping configuration: https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/vmagent.md#how-to-collect-metrics-in-prometheus-format use existing configmap if specified otherwise .config values will be used

+

VMAgent scraping configuration use existing configmap if specified otherwise .config values will be used
containerWorkingDir string
-/
+      
+/
+

Container working directory

+
deployment object
-enabled: true
+      
+enabled: true
 strategy: {}
+

ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/

+

K8s Deployment specific variables

+
deployment.strategyobject
+{}
+
+
+

Deployment stragegy. Check here for details
emptyDir object
-{}
+      
+{}
+

Empty dir configuration for a case, when persistence is disabled

+
env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for more details.
envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
extraArgs object
-envflag.enable: "true"
+      
+envflag.enable: "true"
 envflag.prefix: VM_
 loggerFormat: json
+

vmagent extra command line arguments

+

VMAgent extra command line arguments
extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with vmagent

+
extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -494,18 +516,20 @@ loggerFormat: json
extraLabels object
-{}
+      
+{}
+

extra Labels for Pods, Deployment and Statefulset

+

Extra labels for Pods, Deployment and Statefulset
extraObjects list
-[]
+      
+[]
+

Add extra specs dynamically to this chart

@@ -514,8 +538,9 @@ loggerFormat: json
extraScrapeConfigs list
-[]
+      
+[]
+

Extra scrape configs that will be appended to config

@@ -524,8 +549,9 @@ loggerFormat: json
extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -534,8 +560,9 @@ loggerFormat: json
extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -544,57 +571,68 @@ loggerFormat: json
fullnameOverride string
-""
+      
+""
+

Overrides the fullname prefix

+
global.compatibility.openshift.adaptSecurityContextstring
-auto
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
horizontalPodAutoscaling object
-enabled: false
+      
+enabled: false
 maxReplicas: 10
 metrics: []
 minReplicas: 1
+

Horizontal Pod Autoscaling. Note that it is not intended to be used for vmagents which perform scraping. In order to scale scraping vmagents see: https://docs.victoriametrics.com/vmagent/#scraping-big-number-of-targets

+

Horizontal Pod Autoscaling. Note that it is not intended to be used for vmagents which perform scraping. In order to scale scraping vmagents check here
horizontalPodAutoscaling.enabled bool
-false
+      
+false
+

Use HPA for vmagent

@@ -603,8 +641,9 @@ false
horizontalPodAutoscaling.maxReplicas int
-10
+      
+10
+

Maximum replicas for HPA to use to to scale vmagent

@@ -613,8 +652,9 @@ false
horizontalPodAutoscaling.metrics list
-[]
+      
+[]
+

Metric for HPA to use to scale vmagent

@@ -623,8 +663,9 @@ false
horizontalPodAutoscaling.minReplicas int
-1
+      
+1
+

Minimum replicas for HPA to use to scale vmagent

@@ -633,17 +674,20 @@ false
image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Image pull policy

+
image.registry string
-""
+      
+""
+

Image registry

@@ -652,8 +696,9 @@ IfNotPresent
image.repository string
-victoriametrics/vmagent
+      
+victoriametrics/vmagent
+

Image repository

@@ -662,8 +707,9 @@ victoriametrics/vmagent
image.tag string
-""
+      
+""
+

Image tag, set to Chart.AppVersion by default

@@ -672,8 +718,9 @@ victoriametrics/vmagent
image.variant string
-""
+      
+""
+

Variant of the image to use. e.g. enterprise, scratch

@@ -682,94 +729,122 @@ victoriametrics/vmagent
imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

+
ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

+
ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for agent

+
ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
ingress.hosts list
-[]
+      
+[]
+

Array of host objects

+
ingress.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
ingress.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

+

Ingress path type
ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

+
initContainers list
-[]
+      
+[]
+

Init containers for vmagent

+
license object
-key: ""
+      
+key: ""
 secret:
     key: ""
     name: ""
+

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Documentation - https://docs.victoriametrics.com/enterprise, for more information, visit https://victoriametrics.com/products/enterprise/ . To request a trial license, go to https://victoriametrics.com/products/enterprise/trial/ Supported starting from VictoriaMetrics v1.94.0

+

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 string
-""
+      
+""
+

License key

@@ -778,9 +853,10 @@ secret:
license.secret object
-key: ""
+      
+key: ""
 name: ""
+

Use existing secret with license key

@@ -789,8 +865,9 @@ name: ""
license.secret.key string
-""
+      
+""
+

Key in secret with license key

@@ -799,8 +876,9 @@ name: ""
license.secret.name string
-""
+      
+""
+

Existing secret name

@@ -809,80 +887,97 @@ name: ""
multiTenantUrls list
-[]
+      
+[]
+

Destination multitenant endpoint for scraped/received metrics

+
nameOverride string
-""
+      
+""
+

Overrides fullname suffix

+
nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

+
persistence.accessModes[0]string
-ReadWriteOnce
+
persistence.accessModeslist
+- ReadWriteOnce
+

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

+
persistence.annotations object
-{}
+      
+{}
+

Persistant volume annotations

+
persistence.enabled bool
-false
+      
+false
+

Create/use Persistent Volume Claim for server component. Empty dir if false

+
persistence.existingClaim string
-""
+      
+""
+

Existing Claim name. If defined, PVC must be created manually before volume will be bound

+
persistence.extraLabels object
-{}
+      
+{}
+

Persistant volume additional labels

+
persistence.matchLabels object
-{}
+      
+{}
+

Bind Persistent Volume by labels. Must match all labels of targeted PV.

@@ -891,17 +986,31 @@ false
persistence.size string
-10Gi
+      
+10Gi
+

Size of the volume. Should be calculated based on the logs you send and retention policy you set.

+
persistence.storageClassNamestring
+""
+
+
+

StorageClass to use for persistent volume. Requires server.persistentVolume.enabled: true. If defined, PVC created automatically

+
podAnnotations object
-{}
+      
+{}
+

Annotations to be added to pod

@@ -910,120 +1019,136 @@ false
podDisruptionBudget object
-enabled: false
+      
+enabled: false
 labels: {}
+

See kubectl explain poddisruptionbudget.spec for more ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/

+

See kubectl explain poddisruptionbudget.spec for more or check official documentation
podLabels object
-{}
+      
+{}
+

extra Labels for Pods only

+

Extra labels for Pods only
podSecurityContext.enabledbool
-true
+
podSecurityContextobject
+enabled: true
+

Security context to be added to pod

+
priorityClassName string
-""
+      
+""
+

priority class to be assigned to the pod(s)

+

Priority class to be assigned to the pod(s)
probe.liveness object
-initialDelaySeconds: 5
+      
+initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket: {}
 timeoutSeconds: 5
+

liveness probe

+

Liveness probe
probe.readiness object
-httpGet: {}
+      
+httpGet: {}
 initialDelaySeconds: 5
 periodSeconds: 15
+

readiness probe

+

Readiness probe
probe.startup object
-{}
+      
+{}
+

startup probe

+

Startup probe
rbac.annotations object
-{}
+      
+{}
+

Role/RoleBinding annotations

+
rbac.create bool
-true
+      
+true
+

Enables Role/RoleBinding creation

+
rbac.extraLabels object
-{}
+      
+{}
+

Role/RoleBinding labels

+
rbac.namespaced bool
-false
+      
+false
+

if true and rbac.enabled, will deploy a Role/Rolebinding instead of a ClusterRole/ClusterRoleBinding

+

If true and rbac.enabled, will deploy a Role/RoleBinding instead of a ClusterRole/ClusterRoleBinding
remoteWriteUrls list
-[]
+      
+[]
+

WARN: need to specify at least one remote write url or one multi tenant url

@@ -1032,152 +1157,185 @@ false
replicaCount int
-1
+      
+1
+

Replica count

+
resources object
-{}
+      
+{}
+

Resource object. Details are here

+
securityContext.enabledbool
-true
+
securityContextobject
+enabled: true
+

Security context to be added to pod’s containers

+
service.annotations object
-{}
+      
+{}
+

Service annotations

+
service.clusterIP string
-""
+      
+""
+

Service ClusterIP

+
service.enabled bool
-false
+      
+false
+

Enable agent service

+
service.externalIPs list
-[]
+      
+[]
+

Service external IPs. Check here for details

+
service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
service.extraLabels object
-{}
+      
+{}
+

Service labels

+
service.healthCheckNodePort string
-""
+      
+""
+

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

+
service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

+
service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

+
service.servicePort int
-8429
+      
+8429
+

Service port

+
service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

+
serviceAccount.annotations object
-{}
+      
+{}
+

Annotations to add to the service account

@@ -1186,8 +1344,9 @@ ClusterIP
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

@@ -1196,8 +1355,9 @@ true
serviceAccount.name string
-null
+      
+null
+

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

@@ -1206,8 +1366,9 @@ null
serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -1216,8 +1377,9 @@ null
serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -1226,8 +1388,9 @@ null
serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -1236,8 +1399,9 @@ false
serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -1246,8 +1410,9 @@ false
serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -1256,8 +1421,9 @@ false
serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -1266,53 +1432,71 @@ false
statefulset object
-clusterMode: false
+      
+clusterMode: false
 enabled: false
 replicationFactor: 1
 updateStrategy: {}
+

ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/

+

K8s StatefulSet specific variables
statefulset.clusterMode bool
-false
+      
+false
+

create cluster of vmagents. See https://docs.victoriametrics.com/vmagent#scraping-big-number-of-targets available since 1.77.2 version https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.77.2

+

create cluster of vmagents. Check here available since v1.77.2
statefulset.replicationFactor int
-1
+      
+1
+

replication factor for vmagent in cluster mode
tolerationslist
-[]
+
statefulset.updateStrategyobject
+{}
+

StatefulSet update strategy. Check here for details.

+
tolerationslist
+[]
+
+
+

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

+
topologySpreadConstraints list
-[]
+      
+[]
+

Pod topologySpreadConstraints

+
diff --git a/docs/helm/victoria-metrics-alert/README.md b/docs/helm/victoria-metrics-alert/README.md index 517d598cb2..3398480741 100644 --- a/docs/helm/victoria-metrics-alert/README.md +++ b/docs/helm/victoria-metrics-alert/README.md @@ -125,157 +125,129 @@ 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-alert/values.yaml`` file. - +
- - - - + + + + - - - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + - - + - - + - - + - - - - - - - + - - + - - + - - + - - + + + + + + + - - - - + - - - + - - + - - - - - - - - - + - - + - + - - - - - - - - - - + - - - - - - - - + - - + - - - + + - + - - + - - + - - - - - - + - - + - - + - - + - - + - - - - - - - - - - - - - - - - + - - + - - + - - + - - - - + + - + - - + - - + - - - - - - - - + - - + - - + - - + - - + - - - - + + - + - - - - - - - - - + - - - - + - - - + + - - - - - - - - - - - - - - - - - - - + - - - - + - - + - - + - - + - - + + + + + + + - - - - + - - - - - - - + - - + - - + - - - - - - - - - + - - - + + - + - - + - - - - - - - + + + + + + - - - - + - - - - - - + - - + - - + - - - + + - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - - + - - - - - - - - - - - - -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
alertmanager.baseURL string
-""
+      
+""
+

external URL, that alertmanager will expose to receivers

+

External URL, that alertmanager will expose to receivers
alertmanager.baseURLPrefix string
-""
+      
+""
+

external URL Prefix, Prefix for the internal routes of web endpoints

+

External URL Prefix, Prefix for the internal routes of web endpoints
alertmanager.config.global.resolve_timeoutstring
-5m
+
alertmanager.configobject
+global:
+    resolve_timeout: 5m
+receivers:
+    - name: devnull
+route:
+    group_by:
+        - alertname
+    group_interval: 10s
+    group_wait: 30s
+    receiver: devnull
+    repeat_interval: 24h
+
alertmanager.config.receivers[0].namestring
-devnull
-
+

Alertmanager configuration

alertmanager.config.route.group_by[0]string
-alertname
-
-
alertmanager.config.route.group_intervalstring
-10s
-
-
alertmanager.config.route.group_waitstring
-30s
-
-
alertmanager.config.route.receiverstring
-devnull
-
-
alertmanager.config.route.repeat_intervalstring
-24h
-
-
alertmanager.configMap string
-""
+      
+""
+

use existing configmap if specified otherwise .config values will be used

+

Use existing configmap if specified otherwise .config values will be used
alertmanager.emptyDir object
-{}
+      
+{}
+

Empty dir configuration if persistence is disabled for Alertmanager

+
alertmanager.enabled bool
-false
+      
+false
+

Create alertmanager resources

+
alertmanager.envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
alertmanager.extraArgs object
-{}
+      
+{}
+

Extra command line arguments for container of component

+
alertmanager.extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with alertmanager

+
alertmanager.extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -284,8 +256,9 @@ false
alertmanager.extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -294,8 +267,9 @@ false
alertmanager.extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -304,84 +278,110 @@ false
alertmanager.image object
-registry: ""
+      
+registry: ""
 repository: prom/alertmanager
 tag: v0.25.0
+

alertmanager image configuration

+

Alertmanager image configuration
alertmanager.imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

+
alertmanager.ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

+
alertmanager.ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for alertmanager component

+
alertmanager.ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
alertmanager.ingress.hosts list
-[]
+      
+[]
+

Array of host objects

+
alertmanager.ingress.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
alertmanager.ingress.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

+

Ingress path type
alertmanager.ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

+
alertmanager.initContainers list
-[]
+      
+[]
+

Additional initContainers to initialize the pod

@@ -390,26 +390,31 @@ Prefix
alertmanager.listenAddress string
-0.0.0.0:9093
+      
+0.0.0.0:9093
+

Alertmanager listen address

+
alertmanager.nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

+
alertmanager.persistentVolume.accessModes list
-- ReadWriteOnce
+      
+- ReadWriteOnce
+

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

@@ -418,8 +423,9 @@ Prefix
alertmanager.persistentVolume.annotations object
-{}
+      
+{}
+

Persistant volume annotations

@@ -428,8 +434,9 @@ Prefix
alertmanager.persistentVolume.enabled bool
-false
+      
+false
+

Create/use Persistent Volume Claim for alertmanager component. Empty dir if false

@@ -438,8 +445,9 @@ false
alertmanager.persistentVolume.existingClaim string
-""
+      
+""
+

Existing Claim name. If defined, PVC must be created manually before volume will be bound

@@ -448,8 +456,9 @@ false
alertmanager.persistentVolume.mountPath string
-/data
+      
+/data
+

Mount path. Alertmanager data Persistent Volume mount root path.

@@ -458,8 +467,9 @@ false
alertmanager.persistentVolume.size string
-50Mi
+      
+50Mi
+

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

@@ -468,8 +478,9 @@ false
alertmanager.persistentVolume.storageClassName string
-""
+      
+""
+

StorageClass to use for persistent volume. Requires alertmanager.persistentVolume.enabled: true. If defined, PVC created automatically

@@ -478,314 +489,339 @@ false
alertmanager.persistentVolume.subPath string
-""
+      
+""
+

Mount subpath
alertmanager.podMetadata.annotationsalertmanager.podMetadata object
-{}
+      
+annotations: {}
+labels: {}
+

Alertmanager Pod metadata

+
alertmanager.podMetadata.labelsalertmanager.podSecurityContext object
-{}
+      
+enabled: false
+
alertmanager.podSecurityContext.enabledbool
-false
-
+

Pod’s security context. Details are here
alertmanager.priorityClassName string
-""
+      
+""
+

Name of Priority Class

+
alertmanager.probe.liveness object
-httpGet:
+      
+httpGet:
     path: '{{ ternary "" .baseURLPrefix (empty .baseURLPrefix) }}/-/healthy'
     port: web
+

liveness probe

+

Liveness probe
alertmanager.probe.readiness object
-httpGet:
+      
+httpGet:
     path: '{{ ternary "" .baseURLPrefix (empty .baseURLPrefix) }}/-/ready'
     port: web
+

readiness probe

+

Readiness probe
alertmanager.probe.startup object
-httpGet:
+      
+httpGet:
     path: '{{ ternary "" .baseURLPrefix (empty .baseURLPrefix) }}/-/ready'
     port: web
+

startup probe

+

Startup probe
alertmanager.resources object
-{}
+      
+{}
+

Resource object. Details are here

+
alertmanager.retention string
-120h
+      
+120h
+

Alertmanager retention

+
alertmanager.securityContext.enabledbool
-false
+
alertmanager.securityContextobject
+enabled: false
+

Security context to be added to server pods

+
alertmanager.service.annotations object
-{}
+      
+{}
+

Service annotations

+
alertmanager.service.clusterIP string
-""
+      
+""
+

Service ClusterIP

+
alertmanager.service.externalIPs list
-[]
+      
+[]
+

Ref: https://kubernetes.io/docs/user-guide/services/#external-ips

+

Service external IPs. Check here for details
alertmanager.service.externalTrafficPolicy string
-""
+      
+""
+

Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip

+

Service external traffic policy. Check here for details
alertmanager.service.healthCheckNodePort string
-""
+      
+""
+

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

+
alertmanager.service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
alertmanager.service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
alertmanager.service.labels object
-{}
+      
+{}
+

Service labels

+
alertmanager.service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

+
alertmanager.service.loadBalancerSourceRanges list
-[]
+      
+[]
+
alertmanager.service.nodePortstring
-""
-
+

Load balancer source range

if you want to force a specific nodePort. Must be use with service.type=NodePort

-
alertmanager.service.portint
-9093
-
-
alertmanager.service.servicePort int
-8880
+      
+8880
+

Service port

+
alertmanager.service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

+
alertmanager.templates object
-{}
+      
+{}
+

Alertmanager extra templates

+
alertmanager.tolerations list
-[]
+      
+[]
+

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

+
extraObjects list
-[]
+      
+[]
+

Add extra specs dynamically to this chart
global.compatibility.openshift.adaptSecurityContextstring
-auto
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
license object
-key: ""
+      
+key: ""
 secret:
     key: ""
     name: ""
+

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Documentation - https://docs.victoriametrics.com/enterprise, for more information, visit https://victoriametrics.com/products/enterprise/ . To request a trial license, go to https://victoriametrics.com/products/enterprise/trial/ Supported starting from VictoriaMetrics v1.94.0

+

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 string
-""
+      
+""
+

License key

@@ -794,9 +830,10 @@ secret:
license.secret object
-key: ""
+      
+key: ""
 name: ""
+

Use existing secret with license key

@@ -805,8 +842,9 @@ name: ""
license.secret.key string
-""
+      
+""
+

Key in secret with license key

@@ -815,8 +853,9 @@ name: ""
license.secret.name string
-""
+      
+""
+

Existing secret name

@@ -825,99 +864,116 @@ name: ""
rbac.annotations object
-{}
+      
+{}
+

Role/RoleBinding annotations

+
rbac.create bool
-true
+      
+true
+

Enables Role/RoleBinding creation

+
rbac.extraLabels object
-{}
+      
+{}
+

Role/RoleBinding labels

+
rbac.namespaced bool
-false
+      
+false
+

If true and rbac.enabled, will deploy a Role/RoleBinding instead of a ClusterRole/ClusterRoleBinding

+
server.affinity object
-{}
+      
+{}
+

Pod affinity

+
server.annotations object
-{}
+      
+{}
+

Annotations to be added to the deployment
server.config.alerts.groupslist
-[]
+
server.configobject
+alerts:
+    groups: []
+

VMAlert configuration

+
server.configMap string
-""
+      
+""
+

vmalert alert rules configuration configuration: use existing configmap if specified otherwise .config values will be used

+

VMAlert alert rules configuration configuration. Use existing configmap if specified
server.datasource object
-basicAuth:
+      
+basicAuth:
     password: ""
     username: ""
 bearer:
     token: ""
     tokenFile: ""
 url: ""
+

vmalert reads metrics from source, next section represents its configuration. It can be any service which supports MetricsQL or PromQL.

+

VMAlert reads metrics from source, next section represents its configuration. It can be any service which supports MetricsQL or PromQL.
server.datasource.basicAuth object
-password: ""
+      
+password: ""
 username: ""
+

Basic auth for datasource

@@ -926,8 +982,9 @@ username: ""
server.datasource.bearer.token string
-""
+      
+""
+

Token with Bearer token. You can use one of token or tokenFile. You don’t need to add “Bearer” prefix string

@@ -936,8 +993,9 @@ username: ""
server.datasource.bearer.tokenFile string
-""
+      
+""
+

Token Auth file with Bearer token. You can use one of token or tokenFile

@@ -946,63 +1004,55 @@ username: ""
server.enabled bool
-true
+      
+true
+

Create vmalert component

+
server.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for details.
server.envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
server.extraArgs."envflag.enable"string
-"true"
+
server.extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
server.extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for container of component

server.extraArgs.loggerFormatstring
-json
-
-
server.extraContainers list
-[]
+      
+[]
+

Additional containers to run in the same pod

@@ -1011,8 +1061,9 @@ json
server.extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -1021,8 +1072,9 @@ json
server.extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -1031,8 +1083,9 @@ json
server.extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -1041,95 +1094,123 @@ json
server.fullnameOverride string
-""
+      
+""
+

Full name prefix override

+
server.image object
-pullPolicy: IfNotPresent
+      
+pullPolicy: IfNotPresent
 registry: ""
 repository: victoriametrics/vmalert
 tag: ""
 variant: ""
+

vmalert image configuration

+

VMAlert image configuration
server.imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

+
server.ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

+
server.ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for vmalert component

+
server.ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
server.ingress.hosts list
-[]
+      
+[]
+

Array of host objects

+
server.ingress.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
server.ingress.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

+

Ingress path type
server.ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

+
server.initContainers list
-[]
+      
+[]
+

Additional initContainers to initialize the pod

@@ -1138,55 +1219,63 @@ Prefix
server.labels object
-{}
+      
+{}
+

labels to be added to the deployment

+

Labels to be added to the deployment
server.minReadySeconds int
-0
+      
+0
+

specifies the minimum number of seconds for which a newly created Pod should be ready without any of its containers crashing/terminating 0 is the standard k8s default

+

Specifies the minimum number of seconds for which a newly created Pod should be ready without any of its containers crashing/terminating 0 is the standard k8s default
server.name string
-server
+      
+server
+

Override fullname suffix

+
server.nameOverride string
-""
+      
+""
+

Full name suffix override

+
server.nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

+
server.notifier object
-alertmanager:
+      
+alertmanager:
     basicAuth:
         password: ""
         username: ""
@@ -1194,6 +1283,7 @@ alertmanager:
         token: ""
         tokenFile: ""
     url: ""
+

Notifier to use for alerts. Multiple notifiers can be enabled by using notifiers section

@@ -1202,9 +1292,10 @@ alertmanager:
server.notifier.alertmanager.basicAuth object
-password: ""
+      
+password: ""
 username: ""
+

Basic auth for alertmanager

@@ -1213,8 +1304,9 @@ username: ""
server.notifier.alertmanager.bearer.token string
-""
+      
+""
+

Token with Bearer token. You can use one of token or tokenFile. You don’t need to add “Bearer” prefix string

@@ -1223,8 +1315,9 @@ username: ""
server.notifier.alertmanager.bearer.tokenFile string
-""
+      
+""
+

Token Auth file with Bearer token. You can use one of token or tokenFile

@@ -1233,8 +1326,9 @@ username: ""
server.notifiers list
-[]
+      
+[]
+

Additional notifiers to use for alerts

@@ -1243,8 +1337,9 @@ username: ""
server.podAnnotations object
-{}
+      
+{}
+

Annotations to be added to pod

@@ -1253,9 +1348,10 @@ username: ""
server.podDisruptionBudget object
-enabled: false
+      
+enabled: false
 labels: {}
+

See kubectl explain poddisruptionbudget.spec for more. Or check docs

@@ -1264,84 +1360,107 @@ labels: {}
server.podLabels object
-{}
+      
+{}
+

Pod’s additional labels

+
server.podSecurityContext.enabledbool
-true
+
server.podSecurityContextobject
+enabled: true
+

Pod’s security context. Details are here

+
server.priorityClassName string
-""
+      
+""
+

Name of Priority Class

+
server.probe.liveness object
-failureThreshold: 3
+      
+failureThreshold: 3
 initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket: {}
 timeoutSeconds: 5
+

liveness probe

+

Liveness probe
server.probe.readiness object
-failureThreshold: 3
+      
+failureThreshold: 3
 httpGet: {}
 initialDelaySeconds: 5
 periodSeconds: 15
 timeoutSeconds: 5
+

readiness probe

+

Readiness probe
server.probe.startup object
-{}
+      
+{}
+

startup probe

+

Startup probe
server.remote.read.basicAuth object
-password: ""
+      
+password: ""
 username: ""
+

Basic auth for remote read

+
server.remote.read.bearerobject
+token: ""
+tokenFile: ""
+
+
+

Auth based on Bearer token for remote read
server.remote.read.bearer.token string
-""
+      
+""
+

Token with Bearer token. You can use one of token or tokenFile. You don’t need to add “Bearer” prefix string

@@ -1350,8 +1469,9 @@ username: ""
server.remote.read.bearer.tokenFile string
-""
+      
+""
+

Token Auth file with Bearer token. You can use one of token or tokenFile

@@ -1360,18 +1480,21 @@ username: ""
server.remote.read.url string
-""
+      
+""
+

VMAlert remote read URL

+
server.remote.write.basicAuth object
-password: ""
+      
+password: ""
 username: ""
+

Basic auth for remote write

@@ -1380,9 +1503,10 @@ username: ""
server.remote.write.bearer object
-token: ""
+      
+token: ""
 tokenFile: ""
+

Auth based on Bearer token for remote write

@@ -1391,8 +1515,9 @@ tokenFile: ""
server.remote.write.bearer.token string
-""
+      
+""
+

Token with Bearer token. You can use one of token or tokenFile. You don’t need to add “Bearer” prefix string

@@ -1401,8 +1526,9 @@ tokenFile: ""
server.remote.write.bearer.tokenFile string
-""
+      
+""
+

Token Auth file with Bearer token. You can use one of token or tokenFile

@@ -1411,174 +1537,210 @@ tokenFile: ""
server.remote.write.url string
-""
+      
+""
+

VMAlert remote write URL

+
server.replicaCount int
-1
+      
+1
+

Replica count

+
server.resources object
-{}
+      
+{}
+

Resource object. Details are here

+
server.securityContext.enabledbool
-true
+
server.securityContextobject
+enabled: true
+

Security context to be added to server pods

+
server.service.annotations object
-{}
+      
+{}
+

Service annotations

+
server.service.clusterIP string
-""
+      
+""
+

Service ClusterIP

+
server.service.externalIPs list
-[]
+      
+[]
+

Service external IPs. Check here for details

+
server.service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
server.service.healthCheckNodePort string
-""
+      
+""
+

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

+
server.service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
server.service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
server.service.labels object
-{}
+      
+{}
+

Service labels

+
server.service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

+
server.service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

+
server.service.servicePort int
-8880
+      
+8880
+

Service port

+
server.service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

+
server.strategy object
-rollingUpdate:
+      
+rollingUpdate:
     maxSurge: 25%
     maxUnavailable: 25%
 type: RollingUpdate
+

deployment strategy, set to standard k8s default

+

Deployment strategy, set to standard k8s default
server.tolerations list
-[]
+      
+[]
+

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

+
server.verticalPodAutoscaler object
-enabled: false
+      
+enabled: false
+

Vertical Pod Autoscaler

@@ -1587,8 +1749,9 @@ enabled: false
server.verticalPodAutoscaler.enabled bool
-false
+      
+false
+

Use VPA for vmalert

@@ -1597,8 +1760,9 @@ false
serviceAccount.annotations object
-{}
+      
+{}
+

Annotations to add to the service account

@@ -1607,18 +1771,20 @@ false
serviceAccount.automountToken bool
-true
+      
+true
+

mount API token to pod directly

+

Mount API token to pod directly
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

@@ -1627,8 +1793,9 @@ true
serviceAccount.name string
-null
+      
+null
+

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

@@ -1637,8 +1804,9 @@ null
serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -1647,8 +1815,9 @@ null
serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -1657,8 +1826,9 @@ null
serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -1667,8 +1837,9 @@ false
serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -1677,8 +1848,9 @@ false
serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -1687,8 +1859,9 @@ false
serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

diff --git a/docs/helm/victoria-metrics-anomaly/README.md b/docs/helm/victoria-metrics-anomaly/README.md index 286554f3aa..6fd6a35121 100644 --- a/docs/helm/victoria-metrics-anomaly/README.md +++ b/docs/helm/victoria-metrics-anomaly/README.md @@ -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. - +
- - - - + + + + - - - - - - - - - - - - - - - - - - - - + - - + - - - + - - + - - + - - - - - + - - - + + - + - - + - - + - - - - - - + - - - - - - - + - - - - - - - - - - - - - + - - + - - + - - - + + - + - - + - - - - - -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
affinity object
-{}
+      
+{}
+

Affinity configurations

@@ -152,8 +153,9 @@ Change the values according to the need of the environment in ``victoria-metrics
annotations object
-{}
+      
+{}
+

Annotations to be added to the deployment

@@ -162,8 +164,8 @@ Change the values according to the need of the environment in ``victoria-metrics
config object
-models: {}
+      
+models: {}
 preset: ""
 reader:
     class: vm
@@ -176,6 +178,7 @@ writer:
     class: vm
     datasource_url: ""
     tenant_id: ""
+

Full vmanomaly config section

@@ -184,8 +187,9 @@ writer:
config.models object
-{}
+      
+{}
+

Models section

@@ -194,8 +198,9 @@ writer:
config.preset string
-""
+      
+""
+

Whether to use preset configuration. If not empty, preset name should be specified.

@@ -204,12 +209,13 @@ writer:
config.reader object
-class: vm
+      
+class: vm
 datasource_url: ""
 queries: {}
 sampling_period: 1m
 tenant_id: ""
+

Reader section

@@ -218,8 +224,9 @@ tenant_id: ""
config.reader.class string
-vm
+      
+vm
+

Name of the class needed to enable reading from VictoriaMetrics or Prometheus. VmReader is the default option, if not specified.

@@ -228,8 +235,9 @@ vm
config.reader.datasource_url string
-""
+      
+""
+

Datasource URL address. Required for example http://single-victoria-metrics-single-server.default.svc.cluster.local:8428 or http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480

@@ -238,18 +246,20 @@ vm
config.reader.queries object
-{}
+      
+{}
+

Required. PromQL/MetricsQL query to select data in format: QUERY_ALIAS: “QUERY”. As accepted by “/query_range?query=%s”. See https://docs.victoriametrics.com/anomaly-detection/components/reader/#per-query-parameters for more details.

+

Required. PromQL/MetricsQL query to select data in format: QUERY_ALIAS: “QUERY”. As accepted by “/query_range?query=%s”. See here for more details.
config.reader.sampling_period string
-1m
+      
+1m
+

Frequency of the points returned. Will be converted to /query_range?step=%s param (in seconds). Required since 1.9.0.

@@ -258,8 +268,9 @@ vm
config.reader.tenant_id string
-""
+      
+""
+

For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs

@@ -268,8 +279,9 @@ vm
config.schedulers object
-{}
+      
+{}
+

Scheduler section

@@ -278,10 +290,11 @@ vm
config.writer object
-class: vm
+      
+class: vm
 datasource_url: ""
 tenant_id: ""
+

Writer section

@@ -290,8 +303,9 @@ tenant_id: ""
config.writer.class string
-vm
+      
+vm
+

Name of the class needed to enable writing to VictoriaMetrics or Prometheus. VmWriter is the default option, if not specified.

@@ -300,8 +314,9 @@ vm
config.writer.datasource_url string
-""
+      
+""
+

Datasource URL address. Required for example http://single-victoria-metrics-single-server.default.svc.cluster.local:8428 or http://cluster-victoria-metrics-cluster-vminsert.default.svc.cluster.local:8480

@@ -310,8 +325,9 @@ vm
config.writer.tenant_id string
-""
+      
+""
+

For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs

@@ -320,8 +336,9 @@ vm
configMapAnnotations object
-{}
+      
+{}
+

Annotations to be added to configMap

@@ -330,26 +347,31 @@ vm
containerWorkingDir string
-/vmanomaly
+      
+/vmanomaly
+

Container working directory

+
emptyDir object
-{}
+      
+{}
+

Empty dir configuration when persistence is disabled

+
env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags)

@@ -358,35 +380,42 @@ vm
envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
extraArgs object
-{}
+      
+{}
+

Extra command line arguments for container of component

+
extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with anomaly container

+
extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -395,8 +424,9 @@ vm
extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -405,8 +435,9 @@ vm
extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -415,44 +446,54 @@ vm
fullnameOverride string
-""
+      
+""
+

Full name prefix override

+
global.compatibility.openshift.adaptSecurityContextstring
-auto
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Pull policy of Docker image

@@ -461,8 +502,9 @@ IfNotPresent
image.registry string
-""
+      
+""
+

Victoria Metrics anomaly Docker registry

@@ -471,8 +513,9 @@ IfNotPresent
image.repository string
-victoriametrics/vmanomaly
+      
+victoriametrics/vmanomaly
+

Victoria Metrics anomaly Docker repository and image name

@@ -481,8 +524,9 @@ victoriametrics/vmanomaly
image.tag string
-v1.15.9
+      
+v1.15.9
+

Tag of Docker image

@@ -491,20 +535,23 @@ v1.15.9
imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

+
license object
-key: ""
+      
+key: ""
 secret:
     key: ""
     name: ""
+

License key configuration for vmanomaly. See docs Required starting from v1.5.0.

@@ -513,8 +560,9 @@ secret:
license.key string
-""
+      
+""
+

License key for vmanomaly

@@ -523,9 +571,10 @@ secret:
license.secret object
-key: ""
+      
+key: ""
 name: ""
+

Use existing secret with license key for vmanomaly

@@ -534,8 +583,9 @@ name: ""
license.secret.key string
-""
+      
+""
+

Key in secret with license key

@@ -544,8 +594,9 @@ name: ""
license.secret.name string
-""
+      
+""
+

Existing secret name

@@ -554,17 +605,20 @@ name: ""
nameOverride string
-""
+      
+""
+

Full name suffix override

+
nodeSelector object
-{}
+      
+{}
+

NodeSelector configurations. Details are here

@@ -573,8 +627,8 @@ name: ""
persistentVolume object
-accessModes:
+      
+accessModes:
     - ReadWriteOnce
 annotations: {}
 enabled: false
@@ -582,6 +636,7 @@ existingClaim: ""
 matchLabels: {}
 size: 1Gi
 storageClassName: ""
+

Persistence to store models on disk. Available starting from v1.13.0

@@ -590,8 +645,9 @@ storageClassName: ""
persistentVolume.accessModes list
-- ReadWriteOnce
+      
+- ReadWriteOnce
+

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

@@ -600,8 +656,9 @@ storageClassName: ""
persistentVolume.annotations object
-{}
+      
+{}
+

Persistant volume annotations

@@ -610,8 +667,9 @@ storageClassName: ""
persistentVolume.enabled bool
-false
+      
+false
+

Create/use Persistent Volume Claim for models dump.

@@ -620,8 +678,9 @@ false
persistentVolume.existingClaim string
-""
+      
+""
+

Existing Claim name. If defined, PVC must be created manually before volume will be bound

@@ -630,8 +689,9 @@ false
persistentVolume.matchLabels object
-{}
+      
+{}
+

Bind Persistent Volume by labels. Must match all labels of targeted PV.

@@ -640,8 +700,9 @@ false
persistentVolume.size string
-1Gi
+      
+1Gi
+

Size of the volume. Should be calculated based on the metrics you send and retention policy you set.

@@ -650,8 +711,9 @@ false
persistentVolume.storageClassName string
-""
+      
+""
+

StorageClass to use for persistent volume. Requires server.persistentVolume.enabled: true. If defined, PVC created automatically

@@ -660,8 +722,9 @@ false
podAnnotations object
-{}
+      
+{}
+

Annotations to be added to pod

@@ -670,10 +733,11 @@ false
podDisruptionBudget object
-enabled: false
+      
+enabled: false
 labels: {}
 minAvailable: 1
+

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

@@ -682,66 +746,78 @@ minAvailable: 1
podMonitor.annotations object
-{}
+      
+{}
+

PodMonitor annotations

+
podMonitor.enabled bool
-false
+      
+false
+

Enable PodMonitor

+
podMonitor.extraLabels object
-{}
+      
+{}
+

PodMonitor labels

+
podSecurityContext.enabledbool
-true
+
podSecurityContextobject
+enabled: true
+

Pod’s security context. Details are here

+
resources object
-{}
+      
+{}
+

Resource object. Details are here

+
securityContext object
-enabled: true
+      
+enabled: true
 runAsGroup: 1000
 runAsNonRoot: true
 runAsUser: 1000
+

Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

Check here for details.
serviceAccount.annotations object
-{}
+      
+{}
+

Annotations to add to the service account

@@ -750,8 +826,9 @@ runAsUser: 1000
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

@@ -760,8 +837,9 @@ true
serviceAccount.name string
-null
+      
+null
+

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

@@ -770,8 +848,9 @@ null
tolerations list
-[]
+      
+[]
+

Tolerations configurations. Details are here

diff --git a/docs/helm/victoria-metrics-auth/README.md b/docs/helm/victoria-metrics-auth/README.md index e03f44a932..844662692b 100644 --- a/docs/helm/victoria-metrics-auth/README.md +++ b/docs/helm/victoria-metrics-auth/README.md @@ -118,19 +118,20 @@ 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-auth/values.yaml`` file. - +
- - - - + + + + - - - - @@ -168,63 +172,55 @@ null - - - - + - - - + + - - - - - - - - - - - - - - - + - - - - - - - + - - - + + - + - - + - - + - - - - - - + - - + - - + - - + - - + - - + + + + + + + - - - - + - - + - - + - - + - - + + + + + + + - - - - + - - - - - - - - + - - - - - - - - + + - + - - - - - - - - - - - - - - - - - - - - - - - - - + + - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - - - - - - - - - diff --git a/docs/helm/victoria-metrics-cluster/README.md b/docs/helm/victoria-metrics-cluster/README.md index 7f29cb5916..3e1dedbb28 100644 --- a/docs/helm/victoria-metrics-cluster/README.md +++ b/docs/helm/victoria-metrics-cluster/README.md @@ -124,29 +124,31 @@ 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-cluster/values.yaml`` file. -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
affinity object
-{}
+      
+{}
+

Affinity configurations

@@ -139,8 +140,9 @@ Change the values according to the need of the environment in ``victoria-metrics
annotations object
-{}
+      
+{}
+

Annotations to be added to the deployment

@@ -149,8 +151,9 @@ Change the values according to the need of the environment in ``victoria-metrics
config string
-null
+      
+null
+

Config file content.

@@ -159,8 +162,9 @@ null
containerWorkingDir string
-/
+      
+/
+
env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for details
envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
extraArgs."envflag.enable"string
-"true"
+
extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for container of component

extraArgs.loggerFormatstring
-json
-
-
extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with vmauth

+
extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -233,8 +229,9 @@ json
extraLabels object
-{}
+      
+{}
+

Labels to be added to the deployment and pods

@@ -243,8 +240,9 @@ json
extraObjects list
-[]
+      
+[]
+

Add extra specs dynamically to this chart

@@ -253,8 +251,9 @@ json
extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -263,8 +262,9 @@ json
extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -273,44 +273,54 @@ json
fullnameOverride string
-""
+      
+""
+

Full name prefix override

+
global.compatibility.openshift.adaptSecurityContextstring
-auto
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Pull policy of Docker image

@@ -319,8 +329,9 @@ IfNotPresent
image.registry string
-""
+      
+""
+

Image registry

@@ -329,8 +340,9 @@ IfNotPresent
image.repository string
-victoriametrics/vmauth
+      
+victoriametrics/vmauth
+

Victoria Metrics Auth Docker repository and image name

@@ -339,8 +351,9 @@ victoriametrics/vmauth
image.tag string
-""
+      
+""
+

Tag of Docker image

@@ -349,149 +362,199 @@ victoriametrics/vmauth
image.variant string
-""
+      
+""
+

Variant of the image to use. e.g. enterprise, scratch

+
imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

+
ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

+
ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for vmauth component

+
ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
ingress.hosts list
-[]
+      
+[]
+

Array of host objects

+
ingress.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
ingress.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

+

Ingress path type
ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

+
ingressInternal.annotations object
-{}
+      
+{}
+

Ingress annotations

+
ingressInternal.enabled bool
-false
+      
+false
+

Enable deployment of internal ingress for vmauth component

+
ingressInternal.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
ingressInternal.hosts list
-[]
+      
+[]
+

Array of host objects

+
ingressInternal.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
ingressInternal.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

+

Ingress path type
ingressInternal.tls list
-[]
+      
+[]
+

Array of TLS objects

+
license object
-key: ""
+      
+key: ""
 secret:
     key: ""
     name: ""
+

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Documentation - https://docs.victoriametrics.com/enterprise, for more information, visit https://victoriametrics.com/products/enterprise/ . To request a trial license, go to https://victoriametrics.com/products/enterprise/trial/ Supported starting from VictoriaMetrics v1.94.0

+

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 string
-""
+      
+""
+

License key

@@ -500,9 +563,10 @@ secret:
license.secret object
-key: ""
+      
+key: ""
 name: ""
+

Use existing secret with license key

@@ -511,8 +575,9 @@ name: ""
license.secret.key string
-""
+      
+""
+

Key in secret with license key

@@ -521,8 +586,9 @@ name: ""
license.secret.name string
-""
+      
+""
+

Existing secret name

@@ -531,27 +597,31 @@ name: ""
nameOverride string
-""
+      
+""
+

Full name suffix override

+
nodeSelector object
-{}
+      
+{}
+

NodeSelector configurations. Ref: https://kubernetes.io/docs/user-guide/node-selection/

+

NodeSelector configurations. Check here for details
podAnnotations object
-{}
+      
+{}
+

Annotations to be added to pod

@@ -560,81 +630,70 @@ name: ""
podDisruptionBudget object
-enabled: false
+      
+enabled: false
 labels: {}
+

See kubectl explain poddisruptionbudget.spec for more. Ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/

+

See kubectl explain poddisruptionbudget.spec for more. Official guide is here
podSecurityContext.enabledbool
-true
+
podSecurityContextobject
+enabled: true
+

Pod’s security context. Details are here

+
probe.liveness object
-initialDelaySeconds: 5
+      
+initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket: {}
 timeoutSeconds: 5
+

liveness probe

+

Liveness probe
probe.readiness object
-initialDelaySeconds: 5
+      
+initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket: {}
+

readiness probe

+

Readiness probe
probe.startup object
-{}
+      
+{}
+

startup probe

+

Startup probe
rbac.annotationsobject
-{}
-
-
rbac.extraLabelsobject
-{}
-
-
replicaCount int
-1
+      
+1
+

Number of replicas of vmauth

@@ -643,8 +702,9 @@ tcpSocket: {}
resources object
-{}
+      
+{}
+

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 resources:.

@@ -653,144 +713,174 @@ tcpSocket: {}
secretName string
-""
+      
+""
+

Use existing secret if specified otherwise .config values will be used. Ref: https://docs.victoriametrics.com/vmauth. Configuration in the given secret must be stored under auth.yml key.

+

Use existing secret if specified otherwise .config values will be used. Check here for details. Configuration in the given secret must be stored under auth.yml key.
securityContext.enabledbool
-true
+
securityContextobject
+enabled: true
+

Container security context. Check here for details.

+
service.annotations object
-{}
+      
+{}
+

Service annotations

+
service.clusterIP string
-""
+      
+""
+

Service ClusterIP

+
service.enabled bool
-true
+      
+true
+

Enable vmauth service

+
service.externalIPs list
-[]
+      
+[]
+

Service external IPs. Check here for details

+
service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
service.extraLabels object
-{}
+      
+{}
+

Service labels

+
service.healthCheckNodePort string
-""
+      
+""
+

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

+
service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

+
service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

+
service.servicePort int
-8427
+      
+8427
+

Service port

+
service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

+
serviceAccount.annotations object
-{}
+      
+{}
+

Annotations to add to the service account

@@ -799,8 +889,9 @@ ClusterIP
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

@@ -809,8 +900,9 @@ true
serviceAccount.name string
-null
+      
+null
+

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

@@ -819,8 +911,9 @@ null
serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -829,8 +922,9 @@ null
serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -839,8 +933,9 @@ null
serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -849,8 +944,9 @@ false
serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -859,8 +955,9 @@ false
serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -869,8 +966,9 @@ false
serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -879,11 +977,12 @@ false
tolerations list
-[]
+      
+[]
+

Tolerations configurations. Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

+

Tolerations configurations. Check here for details
+
- - - - + + + + - - - - - - - + + - + - - + - - + - - - - - - - - + + + + + + + - - + - - + - - + + + + + + + - - + - - + - - + + + + + + + - - - - - - - - - - - - - - - + - - - + + - - - - - - - - - - - - - - - + - - + - - + - - + - - - - - - - - - - - - + - - - - + - - + - - + + + + + + - - - + - - - - - - - + + - - - - - - - - + - - - + + - + - - + - + + + + + + - - - - - - - - - - - - - - - - + - - - + - - + - - + - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - + - - - - - + - - - + + - - - - - - - - - - - - - - - + - - - + - - - - - - - - - - - - - - + - - - - + - - + - - + + + + + + - - - + - - - - - - - - - - - - - - + + - - - + + - + - - + - - - + + - + - - + - + + + + + + - - - - - - - - - - - - - - - - + - - - + - - + - - + - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - + - - - + + - - - - - - - - - - - - - - - + - - - + - - + - - - - - - - - - + - - + - - - - - - - - - - @@ -2169,8 +2441,9 @@ vmstorage-volume - - - - - - - + - - - - + + - + - - + - + + + + + + - - - - - - - - - + + + + + + - - - - + - - - + - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - + - - - - - - - - + + + + + + + - - - - - - - - + - - - - - - - - - - - - diff --git a/docs/helm/victoria-metrics-distributed/README.md b/docs/helm/victoria-metrics-distributed/README.md index 7008361c81..4bd2c06376 100644 --- a/docs/helm/victoria-metrics-distributed/README.md +++ b/docs/helm/victoria-metrics-distributed/README.md @@ -18,7 +18,7 @@ This chart sets up multiple VictoriaMetrics cluster instances on multiple [avail The default setup is as shown below: -![victoriametrics-distributed-topology](./victoriametrics-distributed-topology.png) +![victoriametrics-distributed-topology](./img/victoriametrics-distributed-topology.webp) For write: 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. -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
clusterDomainSuffix string
-cluster.local
+      
+cluster.local
+

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

+

K8s cluster domain suffix, uses for building storage pods’ FQDN. Details are here
extraObjects list
-[]
+      
+[]
+

Add extra specs dynamically to this chart

@@ -155,57 +157,67 @@ cluster.local
extraSecrets list
-[]
+      
+[]
+
global.compatibility.openshift.adaptSecurityContextstring
-auto
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
license object
-key: ""
+      
+key: ""
 secret:
     key: ""
     name: ""
+

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Documentation - https://docs.victoriametrics.com/enterprise, for more information, visit https://victoriametrics.com/products/enterprise/ . To request a trial license, go to https://victoriametrics.com/products/enterprise/trial/ Supported starting from VictoriaMetrics v1.94.0

+

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 string
-""
+      
+""
+

License key

@@ -214,9 +226,10 @@ secret:
license.secret object
-key: ""
+      
+key: ""
 name: ""
+

Use existing secret with license key

@@ -225,8 +238,9 @@ name: ""
license.secret.key string
-""
+      
+""
+

Key in secret with license key

@@ -235,8 +249,9 @@ name: ""
license.secret.name string
-""
+      
+""
+

Existing secret name

@@ -245,71 +260,119 @@ name: ""
printNotes bool
-true
+      
+true
+

Print information after deployment

+
rbac.annotationsobject
+{}
+
+
+

Role/RoleBinding annotations

+
rbac.create bool
-true
+      
+true
+

Enables Role/RoleBinding creation

+
rbac.extraLabels object
-{}
+      
+{}
+

Role/RoleBinding labels

+
rbac.namespaced bool
-false
+      
+false
+

If true and rbac.enabled, will deploy a Role/RoleBinding instead of a ClusterRole/ClusterRoleBinding

+
serviceAccount.annotationsobject
+{}
+
+
+

Service account annotations

+
serviceAccount.automountToken bool
-true
+      
+true
+

mount API token to pod directly

+
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

+
serviceAccount.extraLabels object
-{}
+      
+{}
+

Service account labels

+
serviceAccount.namestring
+null
+
+
+

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

+
vminsert.affinity object
-{}
+      
+{}
+

Pod affinity

@@ -318,26 +381,20 @@ true
vminsert.annotations object
-{}
+      
+{}
+
vminsert.automountServiceAccountTokenbool
-true
-
+

StatefulSet/Deployment annotations
vminsert.containerWorkingDir string
-""
+      
+""
+

Container workdir

@@ -346,8 +403,9 @@ true
vminsert.enabled bool
-true
+      
+true
+

Enable deployment of vminsert component. Deployment is used

@@ -356,90 +414,88 @@ true
vminsert.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for details.
vminsert.envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
vminsert.extraArgs."envflag.enable"string
-"true"
+
vminsert.extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
vminsert.extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for vminsert component

vminsert.extraArgs.loggerFormatstring
-json
-
-
vminsert.extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with vminsert

+
vminsert.extraLabels object
-{}
+      
+{}
+

StatefulSet/Deployment additional labels

+
vminsert.extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

+
vminsert.extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

+
vminsert.fullnameOverride string
-""
+      
+""
+

Overrides the full name of vminsert component

@@ -448,8 +504,9 @@ json
vminsert.horizontalPodAutoscaler.behavior object
-{}
+      
+{}
+

Behavior settings for scaling by the HPA

@@ -458,8 +515,9 @@ json
vminsert.horizontalPodAutoscaler.enabled bool
-false
+      
+false
+

Use HPA for vminsert component

@@ -468,8 +526,9 @@ false
vminsert.horizontalPodAutoscaler.maxReplicas int
-10
+      
+10
+

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

@@ -478,8 +537,9 @@ false
vminsert.horizontalPodAutoscaler.metrics list
-[]
+      
+[]
+

Metric for HPA to use to scale the vminsert component

@@ -488,8 +548,9 @@ false
vminsert.horizontalPodAutoscaler.minReplicas int
-2
+      
+2
+

Minimum replicas for HPA to use to scale the vminsert component

@@ -498,8 +559,9 @@ false
vminsert.image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Image pull policy

@@ -508,8 +570,9 @@ IfNotPresent
vminsert.image.registry string
-""
+      
+""
+

Image registry

@@ -518,8 +581,9 @@ IfNotPresent
vminsert.image.repository string
-victoriametrics/vminsert
+      
+victoriametrics/vminsert
+

Image repository

@@ -528,8 +592,9 @@ victoriametrics/vminsert
vminsert.image.tag string
-""
+      
+""
+

Image tag override Chart.AppVersion

@@ -538,17 +603,20 @@ victoriametrics/vminsert
vminsert.image.variant string
-cluster
+      
+cluster
+

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

+
vminsert.ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

@@ -557,8 +625,9 @@ cluster
vminsert.ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for vminsert component

@@ -567,37 +636,53 @@ false
vminsert.ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
vminsert.ingress.hosts list
-[]
+      
+[]
+

Array of host objects
vminsert.ingress.pathTypevminsert.ingress.ingressClassName string
-Prefix
+      
+""
+

pathType is only for k8s >= 1.1=

+

Ingress controller class name

+
vminsert.ingress.pathTypestring
+Prefix
+
+
+

Ingress path type
vminsert.ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

@@ -606,27 +691,31 @@ Prefix
vminsert.initContainers list
-[]
+      
+[]
+

Init containers for vminsert

+
vminsert.name string
-vminsert
+      
+vminsert
+

vminsert container name

+

VMInsert container name
vminsert.nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

@@ -635,112 +724,140 @@ vminsert
vminsert.podAnnotations object
-{}
+      
+{}
+

Pod’s annotations
vminsert.podDisruptionBudget.enabledbool
-false
+
vminsert.podDisruptionBudgetobject
+enabled: false
+labels: {}
+

See kubectl explain poddisruptionbudget.spec for more. Details are here
vminsert.podDisruptionBudget.labelsobject
-{}
-
-
vminsert.podLabels object
-{}
+      
+{}
+

Pod’s additional labels

+
vminsert.podSecurityContext.enabledbool
-false
+
vminsert.podSecurityContextobject
+enabled: false
+

Pod’s security context. Details are here

+
vminsert.ports.name string
-http
+      
+http
+

VMInsert http port name

+
vminsert.priorityClassName string
-""
+      
+""
+

Name of Priority Class

+
vminsert.probeobject
+liveness:
+    failureThreshold: 3
+    initialDelaySeconds: 5
+    periodSeconds: 15
+    tcpSocket: {}
+    timeoutSeconds: 5
+readiness:
+    failureThreshold: 3
+    httpGet: {}
+    initialDelaySeconds: 5
+    periodSeconds: 15
+    timeoutSeconds: 5
+startup: {}
+
+
+

Readiness & Liveness probes
vminsert.probe.liveness object
-failureThreshold: 3
+      
+failureThreshold: 3
 initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket: {}
 timeoutSeconds: 5
+

vminsert liveness probe

+

VMInsert liveness probe
vminsert.probe.readiness object
-failureThreshold: 3
+      
+failureThreshold: 3
 httpGet: {}
 initialDelaySeconds: 5
 periodSeconds: 15
 timeoutSeconds: 5
+

vminsert readiness probe

+

VMInsert readiness probe
vminsert.probe.startup object
-{}
+      
+{}
+

vminsert startup probe

+

VMInsert startup probe
vminsert.replicaCount int
-2
+      
+2
+

Count of vminsert pods

@@ -749,18 +866,20 @@ timeoutSeconds: 5
vminsert.resources object
-{}
+      
+{}
+

Resource object

+

Resource object. Details are here
vminsert.securityContext object
-enabled: false
+      
+enabled: false
+

Pod’s security context. Details are here

@@ -769,8 +888,9 @@ enabled: false
vminsert.service.annotations object
-{}
+      
+{}
+

Service annotations

@@ -779,8 +899,9 @@ enabled: false
vminsert.service.clusterIP string
-""
+      
+""
+

Service ClusterIP

@@ -789,27 +910,31 @@ enabled: false
vminsert.service.externalIPs list
-[]
+      
+[]
+

Service External IPs. Details are here

+

Service external IPs. Details are here
vminsert.service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
vminsert.service.extraPorts list
-[]
+      
+[]
+

Extra service ports

@@ -818,35 +943,42 @@ enabled: false
vminsert.service.healthCheckNodePort string
-""
+      
+""
+

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

+
vminsert.service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
vminsert.service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
vminsert.service.labels object
-{}
+      
+{}
+

Service labels

@@ -855,8 +987,9 @@ enabled: false
vminsert.service.loadBalancerIP string
-""
+      
+""
+

Service load balancer IP

@@ -865,8 +998,9 @@ enabled: false
vminsert.service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

@@ -875,8 +1009,9 @@ enabled: false
vminsert.service.servicePort int
-8480
+      
+8480
+

Service port

@@ -885,8 +1020,9 @@ enabled: false
vminsert.service.targetPort string
-http
+      
+http
+

Target port

@@ -895,8 +1031,9 @@ http
vminsert.service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

@@ -905,18 +1042,20 @@ ClusterIP
vminsert.service.udp bool
-false
+      
+false
+

Make sure that service is not type “LoadBalancer”, as it requires “MixedProtocolLBService” feature gate. ref: https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/

+

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
vminsert.serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -925,8 +1064,9 @@ false
vminsert.serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -935,8 +1075,9 @@ false
vminsert.serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -945,8 +1086,9 @@ false
vminsert.serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -955,8 +1097,9 @@ false
vminsert.serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -965,8 +1108,9 @@ false
vminsert.serviceMonitor.namespace string
-""
+      
+""
+

Target namespace of ServiceMonitor manifest

@@ -975,8 +1119,9 @@ false
vminsert.serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -985,17 +1130,20 @@ false
vminsert.strategy object
-{}
+      
+{}
+

VMInsert strategy

+
vminsert.suppressStorageFQDNsRender bool
-false
+      
+false
+

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

@@ -1004,8 +1152,9 @@ false
vminsert.tolerations list
-[]
+      
+[]
+

Array of tolerations object. Details are here

@@ -1014,8 +1163,9 @@ false
vminsert.topologySpreadConstraints list
-[]
+      
+[]
+

Pod topologySpreadConstraints

@@ -1024,8 +1174,9 @@ false
vmselect.affinity object
-{}
+      
+{}
+

Pod affinity

@@ -1034,26 +1185,20 @@ false
vmselect.annotations object
-{}
+      
+{}
+
vmselect.automountServiceAccountTokenbool
-true
-
+

StatefulSet/Deployment annotations
vmselect.cacheMountPath string
-/cache
+      
+/cache
+

Cache root folder

@@ -1062,8 +1207,9 @@ true
vmselect.containerWorkingDir string
-""
+      
+""
+

Container workdir

@@ -1072,17 +1218,20 @@ true
vmselect.emptyDir object
-{}
+      
+{}
+

Empty dir configuration if persistence is disabled

+
vmselect.enabled bool
-true
+      
+true
+

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

@@ -1091,63 +1240,55 @@ true
vmselect.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for details.
vmselect.envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
vmselect.extraArgs."envflag.enable"bool
-true
+
vmselect.extraArgsobject
+envflag.enable: true
+envflag.prefix: VM_
+loggerFormat: json
+
vmselect.extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for vmselect component

vmselect.extraArgs.loggerFormatstring
-json
-
-
vmselect.extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with vmselect

+
vmselect.extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -1156,17 +1297,20 @@ json
vmselect.extraLabels object
-{}
+      
+{}
+

StatefulSet/Deployment additional labels

+
vmselect.extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -1175,8 +1319,9 @@ json
vmselect.extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -1185,8 +1330,9 @@ json
vmselect.fullnameOverride string
-""
+      
+""
+

Overrides the full name of vmselect component

@@ -1195,8 +1341,9 @@ json
vmselect.horizontalPodAutoscaler.behavior object
-{}
+      
+{}
+

Behavior settings for scaling by the HPA

@@ -1205,8 +1352,9 @@ json
vmselect.horizontalPodAutoscaler.enabled bool
-false
+      
+false
+

Use HPA for vmselect component

@@ -1215,8 +1363,9 @@ false
vmselect.horizontalPodAutoscaler.maxReplicas int
-10
+      
+10
+

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

@@ -1225,8 +1374,9 @@ false
vmselect.horizontalPodAutoscaler.metrics list
-[]
+      
+[]
+

Metric for HPA to use to scale the vmselect component

@@ -1235,8 +1385,9 @@ false
vmselect.horizontalPodAutoscaler.minReplicas int
-2
+      
+2
+

Minimum replicas for HPA to use to scale the vmselect component

@@ -1245,8 +1396,9 @@ false
vmselect.image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Image pull policy

@@ -1255,8 +1407,9 @@ IfNotPresent
vmselect.image.registry string
-""
+      
+""
+

Image registry

@@ -1265,8 +1418,9 @@ IfNotPresent
vmselect.image.repository string
-victoriametrics/vmselect
+      
+victoriametrics/vmselect
+

Image repository

@@ -1275,8 +1429,9 @@ victoriametrics/vmselect
vmselect.image.tag string
-""
+      
+""
+

Image tag override Chart.AppVersion

@@ -1285,17 +1440,20 @@ victoriametrics/vmselect
vmselect.image.variant string
-cluster
+      
+cluster
+

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

+
vmselect.ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

@@ -1304,8 +1462,9 @@ cluster
vmselect.ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for vmselect component

@@ -1314,37 +1473,53 @@ false
vmselect.ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
vmselect.ingress.hosts list
-[]
+      
+[]
+

Array of host objects
vmselect.ingress.pathTypevmselect.ingress.ingressClassName string
-Prefix
+      
+""
+

pathType is only for k8s >= 1.1=

+

Ingress controller class name

+
vmselect.ingress.pathTypestring
+Prefix
+
+
+

Ingress path type
vmselect.ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

@@ -1353,27 +1528,31 @@ Prefix
vmselect.initContainers list
-[]
+      
+[]
+

Init containers for vmselect

+
vmselect.name string
-vmselect
+      
+vmselect
+

Vmselect container name

+

VMSelect container name
vmselect.nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

@@ -1382,8 +1561,9 @@ vmselect
vmselect.persistentVolume.accessModes list
-- ReadWriteOnce
+      
+- ReadWriteOnce
+

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

@@ -1392,8 +1572,9 @@ vmselect
vmselect.persistentVolume.annotations object
-{}
+      
+{}
+

Persistent volume annotations

@@ -1402,8 +1583,9 @@ vmselect
vmselect.persistentVolume.enabled bool
-false
+      
+false
+

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

@@ -1412,8 +1594,9 @@ false
vmselect.persistentVolume.existingClaim string
-""
+      
+""
+

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

@@ -1422,8 +1605,9 @@ false
vmselect.persistentVolume.labels object
-{}
+      
+{}
+

Persistent volume labels

@@ -1432,8 +1616,9 @@ false
vmselect.persistentVolume.size string
-2Gi
+      
+2Gi
+

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

@@ -1442,8 +1627,9 @@ false
vmselect.persistentVolume.subPath string
-""
+      
+""
+

Mount subpath

@@ -1452,112 +1638,151 @@ false
vmselect.podAnnotations object
-{}
+      
+{}
+

Pod’s annotations
vmselect.podDisruptionBudget.enabledbool
-false
+
vmselect.podDisruptionBudgetobject
+enabled: false
+labels: {}
+

See kubectl explain poddisruptionbudget.spec for more. Details are here
vmselect.podDisruptionBudget.labelsobject
-{}
+
vmselect.podDisruptionBudget.enabledbool
+false
+

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

+
vmselect.podLabels object
-{}
+      
+{}
+

Pod’s additional labels

+
vmselect.podSecurityContext.enabledbool
-true
+
vmselect.podSecurityContextobject
+enabled: true
+

Pod’s security context. Details are here

+
vmselect.ports.name string
-http
+      
+http
+

VMSelect http port name

+
vmselect.priorityClassName string
-""
+      
+""
+

Name of Priority Class

+
vmselect.probeobject
+liveness:
+    failureThreshold: 3
+    initialDelaySeconds: 5
+    periodSeconds: 15
+    tcpSocket: {}
+    timeoutSeconds: 5
+readiness:
+    failureThreshold: 3
+    httpGet: {}
+    initialDelaySeconds: 5
+    periodSeconds: 15
+    timeoutSeconds: 5
+startup: {}
+
+
+

Readiness & Liveness probes
vmselect.probe.liveness object
-failureThreshold: 3
+      
+failureThreshold: 3
 initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket: {}
 timeoutSeconds: 5
+

vmselect liveness probe

+

VMSelect liveness probe
vmselect.probe.readiness object
-failureThreshold: 3
+      
+failureThreshold: 3
 httpGet: {}
 initialDelaySeconds: 5
 periodSeconds: 15
 timeoutSeconds: 5
+

vmselect readiness probe

+

VMSelect readiness probe
vmselect.probe.startup object
-{}
+      
+{}
+

vmselect startup probe

+

VMSelect startup probe
vmselect.replicaCount int
-2
+      
+2
+

Count of vmselect pods

@@ -1566,18 +1791,20 @@ timeoutSeconds: 5
vmselect.resources object
-{}
+      
+{}
+

Resource object

+

Resource object. Details are here
vmselect.securityContext object
-enabled: true
+      
+enabled: true
+

Pod’s security context. Details are here

@@ -1586,8 +1813,9 @@ enabled: true
vmselect.service.annotations object
-{}
+      
+{}
+

Service annotations

@@ -1596,8 +1824,9 @@ enabled: true
vmselect.service.clusterIP string
-""
+      
+""
+

Service ClusterIP

@@ -1606,27 +1835,31 @@ enabled: true
vmselect.service.externalIPs list
-[]
+      
+[]
+

Service External IPs. Details are here

+

Service external IPs. Details are here
vmselect.service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
vmselect.service.extraPorts list
-[]
+      
+[]
+

Extra service ports

@@ -1635,35 +1868,42 @@ enabled: true
vmselect.service.healthCheckNodePort string
-""
+      
+""
+

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

+
vmselect.service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
vmselect.service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
vmselect.service.labels object
-{}
+      
+{}
+

Service labels

@@ -1672,8 +1912,9 @@ enabled: true
vmselect.service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

@@ -1682,8 +1923,9 @@ enabled: true
vmselect.service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

@@ -1692,8 +1934,9 @@ enabled: true
vmselect.service.servicePort int
-8481
+      
+8481
+

Service port

@@ -1702,8 +1945,9 @@ enabled: true
vmselect.service.targetPort string
-http
+      
+http
+

Target port

@@ -1712,8 +1956,9 @@ http
vmselect.service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

@@ -1722,8 +1967,9 @@ ClusterIP
vmselect.serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -1732,8 +1978,9 @@ ClusterIP
vmselect.serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -1742,8 +1989,9 @@ ClusterIP
vmselect.serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -1752,8 +2000,9 @@ false
vmselect.serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -1762,8 +2011,9 @@ false
vmselect.serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -1772,8 +2022,9 @@ false
vmselect.serviceMonitor.namespace string
-""
+      
+""
+

Target namespace of ServiceMonitor manifest

@@ -1782,8 +2033,9 @@ false
vmselect.serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -1792,8 +2044,9 @@ false
vmselect.statefulSet.enabled bool
-false
+      
+false
+

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

@@ -1802,8 +2055,9 @@ false
vmselect.statefulSet.podManagementPolicy string
-OrderedReady
+      
+OrderedReady
+

Deploy order policy for StatefulSet pods

@@ -1812,17 +2066,20 @@ OrderedReady
vmselect.strategy object
-{}
+      
+{}
+

VMSelect strategy

+
vmselect.suppressStorageFQDNsRender bool
-false
+      
+false
+

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

@@ -1831,8 +2088,9 @@ false
vmselect.tolerations list
-[]
+      
+[]
+

Array of tolerations object. Details are here

@@ -1841,8 +2099,9 @@ false
vmselect.topologySpreadConstraints list
-[]
+      
+[]
+

Pod topologySpreadConstraints

@@ -1851,8 +2110,9 @@ false
vmstorage.affinity object
-{}
+      
+{}
+

Pod affinity

@@ -1861,26 +2121,20 @@ false
vmstorage.annotations object
-{}
+      
+{}
+
vmstorage.automountServiceAccountTokenbool
-true
-
+

StatefulSet/Deployment annotations
vmstorage.containerWorkingDir string
-""
+      
+""
+

Container workdir

@@ -1889,18 +2143,20 @@ true
vmstorage.emptyDir object
-{}
+      
+{}
+

Use an alternate scheduler, e.g. “stork”. ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/ schedulerName:

+

Empty dir configuration if persistence is disabled
vmstorage.enabled bool
-true
+      
+true
+

Enable deployment of vmstorage component. StatefulSet is used

@@ -1909,63 +2165,55 @@ true
vmstorage.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for details
vmstorage.envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
vmstorage.extraArgs."envflag.enable"string
-"true"
+
vmstorage.extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
vmstorage.extraArgs."envflag.prefix"string
-VM_
-
+

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

vmstorage.extraArgs.loggerFormatstring
-json
-
-
vmstorage.extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with vmstorage

+
vmstorage.extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -1974,26 +2222,31 @@ json
vmstorage.extraLabels object
-{}
+      
+{}
+

StatefulSet/Deployment additional labels

+
vmstorage.extraSecretMounts list
-[]
+      
+[]
+

Extra secret mounts for vmstorage

+
vmstorage.extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -2002,8 +2255,9 @@ json
vmstorage.extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -2012,8 +2266,9 @@ json
vmstorage.fullnameOverride string
-null
+      
+null
+

Overrides the full name of vmstorage component

@@ -2022,8 +2277,9 @@ null
vmstorage.image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Image pull policy

@@ -2032,8 +2288,9 @@ IfNotPresent
vmstorage.image.registry string
-""
+      
+""
+

Image registry

@@ -2042,8 +2299,9 @@ IfNotPresent
vmstorage.image.repository string
-victoriametrics/vmstorage
+      
+victoriametrics/vmstorage
+

Image repository

@@ -2052,8 +2310,9 @@ victoriametrics/vmstorage
vmstorage.image.tag string
-""
+      
+""
+

Image tag override Chart.AppVersion

@@ -2062,36 +2321,42 @@ victoriametrics/vmstorage
vmstorage.image.variant string
-cluster
+      
+cluster
+

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

+
vmstorage.initContainers list
-[]
+      
+[]
+

Init containers for vmstorage

+
vmstorage.name string
-vmstorage
+      
+vmstorage
+

vmstorage container name

+

VMStorage container name
vmstorage.nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

@@ -2100,8 +2365,9 @@ vmstorage
vmstorage.persistentVolume.accessModes list
-- ReadWriteOnce
+      
+- ReadWriteOnce
+

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

@@ -2110,8 +2376,9 @@ vmstorage
vmstorage.persistentVolume.annotations object
-{}
+      
+{}
+

Persistent volume annotations

@@ -2120,8 +2387,9 @@ vmstorage
vmstorage.persistentVolume.enabled bool
-true
+      
+true
+

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

@@ -2130,8 +2398,9 @@ true
vmstorage.persistentVolume.existingClaim string
-""
+      
+""
+

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

@@ -2140,8 +2409,9 @@ true
vmstorage.persistentVolume.labels object
-{}
+      
+{}
+

Persistent volume labels

@@ -2150,8 +2420,9 @@ true
vmstorage.persistentVolume.mountPath string
-/storage
+      
+/storage
+

Data root path. Vmstorage data Persistent Volume mount root path

@@ -2160,8 +2431,9 @@ true
vmstorage.persistentVolume.name string
-vmstorage-volume
+      
+vmstorage-volume
+
vmstorage.persistentVolume.size string
-8Gi
+      
+8Gi
+

Size of the volume.

@@ -2179,8 +2452,9 @@ vmstorage-volume
vmstorage.persistentVolume.storageClassName string
-""
+      
+""
+

Storage class name. Will be empty if not setted

@@ -2189,8 +2463,9 @@ vmstorage-volume
vmstorage.persistentVolume.subPath string
-""
+      
+""
+

Mount subpath

@@ -2199,8 +2474,9 @@ vmstorage-volume
vmstorage.podAnnotations object
-{}
+      
+{}
+

Pod’s annotations

@@ -2209,9 +2485,10 @@ vmstorage-volume
vmstorage.podDisruptionBudget object
-enabled: false
+      
+enabled: false
 labels: {}
+

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

@@ -2220,93 +2497,128 @@ labels: {}
vmstorage.podLabels object
-{}
+      
+{}
+

Pod’s additional labels

+
vmstorage.podManagementPolicy string
-OrderedReady
+      
+OrderedReady
+

Deploy order policy for StatefulSet pods
vmstorage.podSecurityContext.enabledbool
-false
+
vmstorage.podSecurityContextobject
+enabled: false
+

Pod’s security context. Details are here

+
vmstorage.ports.name string
-http
+      
+http
+

VMStorage http port name

+
vmstorage.priorityClassName string
-""
+      
+""
+

Name of Priority Class

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

Readiness & Liveness probes
vmstorage.probe.liveness object
-failureThreshold: 10
+      
+failureThreshold: 10
 initialDelaySeconds: 30
 periodSeconds: 30
 tcpSocket: {}
 timeoutSeconds: 5
+

vmstorage liveness probe

+

VMStorage liveness probe
vmstorage.probe.readiness object
-failureThreshold: 3
+      
+failureThreshold: 3
 httpGet: {}
 initialDelaySeconds: 5
 periodSeconds: 15
 timeoutSeconds: 5
+

vmstorage readiness probe

+

VMStorage readiness probe
vmstorage.probe.startup object
-{}
+      
+{}
+

vmstorage startup probe

+

VMStorage startup probe
vmstorage.replicaCount int
-2
+      
+2
+

Count of vmstorage pods

@@ -2315,8 +2627,9 @@ timeoutSeconds: 5
vmstorage.resources object
-{}
+      
+{}
+

Resource object. Details are here

@@ -2325,18 +2638,31 @@ timeoutSeconds: 5
vmstorage.retentionPeriod int
-1
+      
+1
+

Data retention period. Supported values 1w, 1d, number without measurement means month, e.g. 2 = 2month

+
vmstorage.schedulerNamestring
+""
+
+
+

Use an alternate scheduler, e.g. “stork”. Check here for details
vmstorage.securityContext object
-enabled: false
+      
+enabled: false
+

Pod’s security context. Details are here

@@ -2345,8 +2671,9 @@ enabled: false
vmstorage.service.annotations object
-{}
+      
+{}
+

Service annotations

@@ -2355,17 +2682,20 @@ enabled: false
vmstorage.service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
vmstorage.service.extraPorts list
-[]
+      
+[]
+

Extra service ports

@@ -2374,35 +2704,42 @@ enabled: false
vmstorage.service.healthCheckNodePort string
-""
+      
+""
+

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

+
vmstorage.service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
vmstorage.service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
vmstorage.service.labels object
-{}
+      
+{}
+

Service labels

@@ -2411,8 +2748,9 @@ enabled: false
vmstorage.service.servicePort int
-8482
+      
+8482
+

Service port

@@ -2421,8 +2759,9 @@ enabled: false
vmstorage.service.vminsertPort int
-8400
+      
+8400
+

Port for accepting connections from vminsert

@@ -2431,8 +2770,9 @@ enabled: false
vmstorage.service.vmselectPort int
-8401
+      
+8401
+

Port for accepting connections from vmselect

@@ -2441,8 +2781,9 @@ enabled: false
vmstorage.serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -2451,8 +2792,9 @@ enabled: false
vmstorage.serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -2461,8 +2803,9 @@ enabled: false
vmstorage.serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -2471,8 +2814,9 @@ false
vmstorage.serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -2481,8 +2825,9 @@ false
vmstorage.serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -2491,8 +2836,9 @@ false
vmstorage.serviceMonitor.namespace string
-""
+      
+""
+

Target namespace of ServiceMonitor manifest

@@ -2501,8 +2847,9 @@ false
vmstorage.serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -2511,8 +2858,9 @@ false
vmstorage.terminationGracePeriodSeconds int
-60
+      
+60
+

Pod’s termination grace period in seconds

@@ -2521,18 +2869,20 @@ false
vmstorage.tolerations list
-[]
+      
+[]
+

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

+

Array of tolerations object. Node tolerations for server scheduling to nodes with taints. Details are here
vmstorage.topologySpreadConstraints list
-[]
+      
+[]
+

Pod topologySpreadConstraints

@@ -2541,259 +2891,295 @@ false
vmstorage.vmbackupmanager.destination string
-""
+      
+""
+

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

+

Backup destination at S3, GCS or local filesystem. Pod name will be included to path!
vmstorage.vmbackupmanager.disableDaily bool
-false
+      
+false
+

disable daily backups

+

Disable daily backups
vmstorage.vmbackupmanager.disableHourly bool
-false
+      
+false
+

disable hourly backups

+

Disable hourly backups
vmstorage.vmbackupmanager.disableMonthly bool
-false
+      
+false
+

disable monthly backups

+

Disable monthly backups
vmstorage.vmbackupmanager.disableWeekly bool
-false
+      
+false
+

disable weekly backups

+

Disable weekly backups
vmstorage.vmbackupmanager.enabled bool
-false
+      
+false
+

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

+

Enable automatic creation of backup via vmbackupmanager. vmbackupmanager is part of Enterprise packages
vmstorage.vmbackupmanager.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for details
vmstorage.vmbackupmanager.extraArgs."envflag.enable"string
-"true"
+
vmstorage.vmbackupmanager.extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
vmstorage.vmbackupmanager.extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for container of component

vmstorage.vmbackupmanager.extraArgs.loggerFormatstring
-json
-
-
vmstorage.vmbackupmanager.extraSecretMounts list
-[]
+      
+[]
+

Extra secret mounts for vmbackupmanager

+
vmstorage.vmbackupmanager.image.registry string
-""
+      
+""
+

vmbackupmanager image registry

+

VMBackupManager image registry
vmstorage.vmbackupmanager.image.repository string
-victoriametrics/vmbackupmanager
+      
+victoriametrics/vmbackupmanager
+

vmbackupmanager image repository

+

VMBackupManager image repository
vmstorage.vmbackupmanager.image.tag string
-""
+      
+""
+

vmbackupmanager image tag override Chart.AppVersion

+

VMBackupManager image tag override Chart.AppVersion
vmstorage.vmbackupmanager.image.variant string
-cluster
+      
+cluster
+

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

+
vmstorage.vmbackupmanager.probeobject
+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

+
vmstorage.vmbackupmanager.probe.liveness object
-failureThreshold: 10
+      
+failureThreshold: 10
 initialDelaySeconds: 30
 periodSeconds: 30
 tcpSocket:
     port: manager-http
 timeoutSeconds: 5
+

vmbackupmanager liveness probe

+

VMBackupManager liveness probe
vmstorage.vmbackupmanager.probe.readiness object
-failureThreshold: 3
+      
+failureThreshold: 3
 httpGet:
     port: manager-http
 initialDelaySeconds: 5
 periodSeconds: 15
 timeoutSeconds: 5
+

vmbackupmanager readiness probe

+

VMBackupManager readiness probe
vmstorage.vmbackupmanager.probe.startup object
-{}
+      
+{}
+

vmbackupmanager startup probe

+

VMBackupManager startup probe
vmstorage.vmbackupmanager.resources object
-{}
+      
+{}
+

Resource object. Details are here

+
vmstorage.vmbackupmanager.restore object
-onStart:
+      
+onStart:
     enabled: false
+

Allows to enable restore options for pod. Read more: https://docs.victoriametrics.com/vmbackupmanager#restore-commands

+

Allows to enable restore options for pod. Check here for details
vmstorage.vmbackupmanager.retention object
-keepLastDaily: 2
+      
+keepLastDaily: 2
 keepLastHourly: 2
 keepLastMonthly: 2
 keepLastWeekly: 2
+

backups’ retention settings

+

Backups’ retention settings
vmstorage.vmbackupmanager.retention.keepLastDaily int
-2
+      
+2
+

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

+

Keep last N daily backups. 0 means delete all existing daily backups. Specify -1 to turn off
vmstorage.vmbackupmanager.retention.keepLastHourly int
-2
+      
+2
+

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

+

Keep last N hourly backups. 0 means delete all existing hourly backups. Specify -1 to turn off
vmstorage.vmbackupmanager.retention.keepLastMonthly int
-2
+      
+2
+

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

+

Keep last N monthly backups. 0 means delete all existing monthly backups. Specify -1 to turn off
vmstorage.vmbackupmanager.retention.keepLastWeekly int
-2
+      
+2
+

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

+

Keep last N weekly backups. 0 means delete all existing weekly backups. Specify -1 to turn off
+
- - - - + + + + - - - - - - - - - - - - + + + + + + - - - - - - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + - - - - + + - + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/helm/victoria-metrics-distributed/img/victoriametrics-distributed-topology.webp b/docs/helm/victoria-metrics-distributed/img/victoriametrics-distributed-topology.webp new file mode 100644 index 0000000000..06ecb2696d Binary files /dev/null and b/docs/helm/victoria-metrics-distributed/img/victoriametrics-distributed-topology.webp differ diff --git a/docs/helm/victoria-metrics-gateway/README.md b/docs/helm/victoria-metrics-gateway/README.md index ade7b31540..76b5a48639 100644 --- a/docs/helm/victoria-metrics-gateway/README.md +++ b/docs/helm/victoria-metrics-gateway/README.md @@ -185,19 +185,20 @@ 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-gateway/values.yaml`` file. -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
availabilityZoneslist
-- 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
-
-

config per availability zone components, including vmagent, vmcluster, vmauth etc

-
availabilityZones[0].allowIngest bool
-true
+      
+true
+

allow data ingestion to this zone

+

Allow data ingestion to this zone
availabilityZones[0].allowQuery bool
-true
+      
+true
+

allow data query from this zone through global query endpoint

+

Allow data query from this zone through global query endpoint
availabilityZones[0].extraAffinity object
-{}
+      
+{}
+

extraAffinity adds user defined custom affinity rules

+

Extra affinity adds user defined custom affinity rules

+
availabilityZones[0].namestring
+zone-eu-1
+
+
+

Availability zone name
availabilityZones[0].nodeSelector object
-topology.kubernetes.io/zone: zone-eu-1
+      
+topology.kubernetes.io/zone: zone-eu-1
+

nodeselector to restrict where pods of this zone can be placed. usually provided by cloud providers.

+

Node selector to restrict where pods of this zone can be placed. usually provided by cloud providers.
availabilityZones[0].topologySpreadConstraints list
-- maxSkew: 1
+      
+- maxSkew: 1
   topologyKey: kubernetes.io/hostname
   whenUnsatisfiable: ScheduleAnyway
+

topologySpreadConstraints allows to customize the default topologySpreadConstraints.

+

Topology spread constraints allows to customize the default topologySpreadConstraints.
availabilityZones[0].vmagent object
-annotations: {}
+      
+annotations: {}
 enabled: true
 name: ""
 spec: {}
+

vmagent here only meant to proxy write requests to each az, doesn’t support customized other remote write address.

+

VMAgent here only meant to proxy write requests to each az, doesn’t support customized other remote write address.
availabilityZones[0].vmauthCrossAZQueryavailabilityZones[0].vmagent.annotations object
-enabled: true
-name: ""
-spec: {}
+      
+{}
+

set up a vmauth with all the zone with allowQuery: true as query backends

+

VMAgent annotations

+
availabilityZones[0].vmagent.namestring
+""
+
+
+

Override the name of the vmagent object

+
availabilityZones[0].vmagent.specobject
+{}
+
+
+

VMAgent spec. More options can be found here

+
availabilityZones[0].vmauthCrossAZQuery.enabledbool
+true
+
+
+

Create a vmauth with all the zone with allowQuery: true as query backends

+
availabilityZones[0].vmauthCrossAZQuery.namestring
+""
+
+
+

Override the name of the vmauth object

+
availabilityZones[0].vmauthCrossAZQuery.specobject
+{}
+
+
+

VMAuth spec. More options can be found here

+
availabilityZones[0].vmauthIngest.enabledbool
+true
+
+
+

Create vmauth as a local write endpoint
availabilityZones[0].vmauthIngest.name string
-""
+      
+""
+

override the name of the vmauth object

+

Override the name of the vmauth object
availabilityZones[0].vmauthIngest.specobject
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+

VMAuth spec. More options can be found here

+
availabilityZones[0].vmauthQueryPerZone.enabledbool
+true
+
+
+

Create vmauth as a local read endpoint

+
availabilityZones[0].vmauthQueryPerZone.namestring
+""
+
+
+

Override the name of the vmauth object

+
availabilityZones[0].vmauthQueryPerZone.specobject
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+

VMAuth spec. More options can be found here

+
availabilityZones[0].vmcluster.enabledbool
+true
+
+
+
availabilityZones[0].vmcluster.name string
-""
+      
+""
+

override the name of the vmcluster, by default is vmcluster-

+

Override the name of the vmcluster, by default is vmcluster-
availabilityZones[0].vmcluster.spec object
-replicationFactor: 2
+      
+replicationFactor: 2
 retentionPeriod: "14"
 vminsert:
     extraArgs: {}
@@ -461,91 +494,254 @@ vmstorage:
     replicaCount: 2
     resources: {}
     storageDataPath: /vm-data
+

spec for VMCluster crd, see https://docs.victoriametrics.com/operator/api#vmclusterspec

+

Spec for VMCluster CRD, see here
availabilityZones[1].allowIngest bool
-true
+      
+true
+

allow data ingestion to this zone

+

Allow data ingestion to this zone
availabilityZones[1].allowQuery bool
-true
+      
+true
+

allow data query from this zone through global query endpoint

+

Allow data query from this zone through global query endpoint
availabilityZones[1].extraAffinity object
-{}
+      
+{}
+

extraAffinity adds user defined custom affinity rules

+

Extra affinity adds user defined custom affinity rules

+
availabilityZones[1].namestring
+zone-us-1
+
+
+

Availability zone name
availabilityZones[1].nodeSelector object
-topology.kubernetes.io/zone: zone-us-1
+      
+topology.kubernetes.io/zone: zone-us-1
+

nodeselector to restrict where pods of this zone can be placed. usually provided by cloud providers.

+

Node selector to restrict where pods of this zone can be placed. usually provided by cloud providers.
availabilityZones[1].topologySpreadConstraints list
-- maxSkew: 1
+      
+- maxSkew: 1
   topologyKey: kubernetes.io/hostname
   whenUnsatisfiable: ScheduleAnyway
+

topologySpreadConstraints allows to customize the default topologySpreadConstraints.

+

Topology spread constraints allows to customize the default topologySpreadConstraints.
availabilityZones[1].vmagent object
-annotations: {}
+      
+annotations: {}
 enabled: true
 name: ""
 spec: {}
+

vmagent only meant to proxy write requests to each az, doesn’t support customized remote write address

+

VMAgent only meant to proxy write requests to each az, doesn’t support customized remote write address
availabilityZones[1].vmagent.annotationsobject
+{}
+
+
+

VMAgent annotations

+
availabilityZones[1].vmagent.namestring
+""
+
+
+

Override the name of the vmagent object

+
availabilityZones[1].vmagent.specobject
+{}
+
+
+

VMAgent spec. More options can be found here

+
availabilityZones[1].vmauthCrossAZQuery.enabledbool
+true
+
+
+

Create a vmauth with all the zone with allowQuery: true as query backends

+
availabilityZones[1].vmauthCrossAZQuery.namestring
+""
+
+
+

Override the name of the vmauth object

+
availabilityZones[1].vmauthCrossAZQuery.specobject
+{}
+
+
+

VMAuth spec. More options can be found here

+
availabilityZones[1].vmauthIngest.enabledbool
+true
+
+
+

Create vmauth as a local write endpoint

+
availabilityZones[1].vmauthIngest.namestring
+""
+
+
+

Override the name of the vmauth object

+
availabilityZones[1].vmauthIngest.specobject
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+

VMAuth spec. More options can be found here

+
availabilityZones[1].vmauthQueryPerZone.enabledbool
+true
+
+
+

Create vmauth as a local read endpoint

+
availabilityZones[1].vmauthQueryPerZone.namestring
+""
+
+
+

Override the name of the vmauth object

+
availabilityZones[1].vmauthQueryPerZone.specobject
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+

VMAuth spec. More options can be found here

+
availabilityZones[1].vmcluster.enabledbool
+true
+
+
+
availabilityZones[1].vmcluster.name string
-""
+      
+""
+

override the name of the vmcluster, by default is vmcluster-

+

Override the name of the vmcluster, by default is vmcluster-
availabilityZones[1].vmcluster.spec object
-replicationFactor: 2
+      
+replicationFactor: 2
 retentionPeriod: "14"
 vminsert:
     extraArgs: {}
@@ -559,59 +755,64 @@ vmstorage:
     replicaCount: 2
     resources: {}
     storageDataPath: /vm-data
+

spec for VMCluster crd, see https://docs.victoriametrics.com/operator/api#vmclusterspec

+

Spec for VMCluster CRD, see here
enableMultitenancy bool
-false
+      
+false
+

enable multitenancy mode see https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-distributed#how-to-use-multitenancy

+

Enable multitenancy mode see here
extraVMAgent object
-enabled: true
+      
+enabled: true
 name: test-vmagent
 spec:
     selectAllByDefault: true
+

set up an extra vmagent to scrape all the scrape objects by default, and write data to above vmauth-global-ingest endpoint.

+

Set up an extra vmagent to scrape all the scrape objects by default, and write data to above vmauth-global-ingest endpoint.
fullnameOverride string
-""
+      
+""
+

overrides the chart’s computed fullname.

+

Overrides the chart’s computed fullname.
nameOverride string
-vm-distributed
+      
+vm-distributed
+

overrides the chart’s name

+

Overrides the chart’s name
victoria-metrics-k8s-stack object
-alertmanager:
+      
+alertmanager:
     enabled: false
 crds:
     enabled: true
@@ -631,33 +832,76 @@ vmcluster:
     enabled: false
 vmsingle:
     enabled: false
+

set up vm operator and other resources like vmalert, grafana if needed

+

Set up vm operator and other resources like vmalert, grafana if needed
vmauthIngestGlobalobject
-enabled: true
-name: ""
-spec: {}
+
vmauthIngestGlobal.enabledbool
+true
+

set up a vmauth as the global write entrypoint

+

Create a vmauth as the global write entrypoint
vmauthQueryGlobalobject
-enabled: true
-name: ""
-spec: {}
+
vmauthIngestGlobal.namestring
+""
+

set up a vmauth as the global read entrypoint

+

Override the name of the vmauth object

+
vmauthIngestGlobal.specobject
+{}
+
+
+

VMAuth spec. More options can be found here

+
vmauthQueryGlobal.enabledbool
+true
+
+
+

Create vmauth as the global read entrypoint

+
vmauthQueryGlobal.namestring
+""
+
+
+

Override the name of the vmauth object

+
vmauthQueryGlobal.specobject
+{}
+
+
+

VMAuth spec. More options can be found here
+
- - - - + + + + - - - - - - - - - - + - - - - + - - - + + - - - - - - - - - - - - - - - + - - - - - + - - - + + - + - - + - - + - - - - - - + - - + - - + - - + - - + - - + + + + + + + - - - - + - - - - - - - - + - - - - - - - - + + - + - - - - - - - - - - - - - - - - - + - - + - - + - - + + + + + + + - - + + + + + + + - - + - - + - - + - - + - - + - - + - - - - - - - - - - - -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
affinity object
-{}
+      
+{}
+

Affinity configurations

@@ -206,8 +207,9 @@ Change the values according to the need of the environment in ``victoria-metrics
annotations object
-{}
+      
+{}
+

Annotations to be added to the deployment

@@ -216,18 +218,20 @@ Change the values according to the need of the environment in ``victoria-metrics
auth object
-enabled: false
+      
+enabled: false
+

Access Control configuration. https://docs.victoriametrics.com/vmgateway#access-control

+

Access Control configuration. Check here for details
auth.enabled bool
-false
+      
+false
+

Enable/Disable access-control

@@ -236,8 +240,9 @@ false
clusterMode bool
-false
+      
+false
+

Specify to True if the source for rate-limiting, reading and writing as a VictoriaMetrics Cluster. Must be true for rate limiting

@@ -246,82 +251,77 @@ false
configMap string
-""
+      
+""
+

Use existing configmap if specified otherwise .config values will be used. Ref: https://docs.victoriametrics.com/vmgateway

+

Use existing configmap if specified otherwise .config values will be used. Check here for details
containerWorkingDir string
-/
+      
+/
+

Container working directory

+
env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://github.com/VictoriaMetrics/VictoriaMetrics#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for details.
envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
extraArgs."envflag.enable"string
-"true"
+
extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for container of component

extraArgs.loggerFormatstring
-json
-
-
extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with vmgateway

+
extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -330,8 +330,9 @@ json
extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -340,8 +341,9 @@ json
extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -350,44 +352,54 @@ json
fullnameOverride string
-""
+      
+""
+

Full name prefix

+
global.compatibility.openshift.adaptSecurityContextstring
-auto
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Pull policy of Docker image

@@ -396,8 +408,9 @@ IfNotPresent
image.registry string
-""
+      
+""
+

Victoria Metrics gateway Docker registry

@@ -406,8 +419,9 @@ IfNotPresent
image.repository string
-victoriametrics/vmgateway
+      
+victoriametrics/vmgateway
+

Victoria Metrics gateway Docker repository and image name

@@ -416,8 +430,9 @@ victoriametrics/vmgateway
image.tag string
-""
+      
+""
+

Tag of Docker image override Chart.AppVersion

@@ -426,94 +441,122 @@ victoriametrics/vmgateway
image.variant string
-""
+      
+""
+

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

+
imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

+
ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

+
ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for server component

+
ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

+
ingress.hosts list
-[]
+      
+[]
+

Array of host objects

+
ingress.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
ingress.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

+

Ingress path type
ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

+
license object
-key: ""
+      
+key: ""
 secret:
     key: ""
     name: ""
+

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Documentation - https://docs.victoriametrics.com/enterprise, for more information, visit https://victoriametrics.com/products/enterprise/ . To request a trial license, go to https://victoriametrics.com/products/enterprise/trial/ Supported starting from VictoriaMetrics v1.94.0

+

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 string
-""
+      
+""
+

License key

@@ -522,9 +565,10 @@ secret:
license.secret object
-key: ""
+      
+key: ""
 name: ""
+

Use existing secret with license key

@@ -533,8 +577,9 @@ name: ""
license.secret.key string
-""
+      
+""
+

Key in secret with license key

@@ -543,8 +588,9 @@ name: ""
license.secret.name string
-""
+      
+""
+

Existing secret name

@@ -553,27 +599,31 @@ name: ""
nameOverride string
-""
+      
+""
+

Full name suffix

+
nodeSelector object
-{}
+      
+{}
+

NodeSelector configurations. Ref: https://kubernetes.io/docs/user-guide/node-selection/

+

NodeSelector configurations. Check here for details
podAnnotations object
-{}
+      
+{}
+

Annotations to be added to pod

@@ -582,76 +632,84 @@ name: ""
podDisruptionBudget object
-enabled: false
+      
+enabled: false
 labels: {}
+

See kubectl explain poddisruptionbudget.spec for more. Ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/

+

See kubectl explain poddisruptionbudget.spec for more. Check here for details
podSecurityContext.enabledbool
-true
+
podSecurityContextobject
+enabled: true
+

Pod’s security context. Details are here

+
probe.liveness object
-initialDelaySeconds: 5
+      
+initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket: {}
 timeoutSeconds: 5
+

liveness probe

+

Liveness probe
probe.readiness object
-httpGet: {}
+      
+httpGet: {}
 initialDelaySeconds: 5
 periodSeconds: 15
+

readiness probe

+

Readiness probe
probe.startup object
-{}
+      
+{}
+

startup probe

+

Startup probe
rateLimiter object
-config: {}
+      
+config: {}
 datasource:
     url: ""
 enabled: false
+

Rate limiter configuration. Docs https://docs.victoriametrics.com/vmgateway#rate-limiter

+

Rate limiter configuration. Docs are here
rateLimiter.datasource.url string
-""
+      
+""
+

Datasource VictoriaMetrics or vmselects. Required. Example http://victoroametrics:8428 or http://vmselect:8481/select/0/prometheus

@@ -660,8 +718,9 @@ enabled: false
rateLimiter.enabled bool
-false
+      
+false
+

Enable/Disable rate-limiting

@@ -670,8 +729,9 @@ false
read.url string
-""
+      
+""
+

Read endpoint without suffixes, victoriametrics or vmselect. Example http://victoroametrics:8428 or http://vmselect:8481

@@ -680,8 +740,9 @@ false
replicaCount int
-1
+      
+1
+

Number of replicas of vmgateway

@@ -690,8 +751,9 @@ false
resources object
-{}
+      
+{}
+

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 ‘resources:’.

@@ -700,120 +762,166 @@ false
securityContext object
-enabled: true
+      
+enabled: true
 runAsGroup: 1000
 runAsNonRoot: true
 runAsUser: 1000
+

Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

+

Pod security context. Check here for details
service.annotations object
-{}
+      
+{}
+

Service annotations

+
service.clusterIP string
-""
+      
+""
+

Service ClusterIP

+
service.enabled bool
-true
+      
+true
+

Enabled vmgateway service

+
service.externalIPs list
-[]
+      
+[]
+

Service external IPs. Check here for details

+
service.externalTrafficPolicystring
+""
+
+
+

Service external traffic policy. Check here for details

+
service.extraLabels object
-{}
+      
+{}
+

Service labels

+
service.healthCheckNodePortstring
+""
+
+
+

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

+
service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

+
service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

+
service.servicePort int
-8431
+      
+8431
+

Service port

+
service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

+
serviceAccount.annotations object
-{}
+      
+{}
+

Annotations to add to the service account

@@ -822,8 +930,9 @@ ClusterIP
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

@@ -832,8 +941,9 @@ true
serviceAccount.name string
-null
+      
+null
+

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

@@ -842,8 +952,9 @@ null
serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -852,8 +963,9 @@ null
serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -862,8 +974,9 @@ null
serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -872,8 +985,9 @@ false
serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -882,8 +996,9 @@ false
serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -892,8 +1007,9 @@ false
serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -902,18 +1018,20 @@ false
tolerations list
-[]
+      
+[]
+

Tolerations configurations. Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/

+

Tolerations configurations. Check here for details
write.url string
-""
+      
+""
+

Write endpoint without suffixes, victoriametrics or vminsert. Example http://victoroametrics:8428 or http://vminsert:8480

diff --git a/docs/helm/victoria-metrics-k8s-stack/README.md b/docs/helm/victoria-metrics-k8s-stack/README.md index d95202e0d7..a501c56701 100644 --- a/docs/helm/victoria-metrics-k8s-stack/README.md +++ b/docs/helm/victoria-metrics-k8s-stack/README.md @@ -24,7 +24,7 @@ To enable metrics collection for kubernetes this chart installs multiple scrape This chart also installs bunch of dashboards and recording rules from [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) project. -![Overview](img/k8s-stack-overview.png) +![Overview](img/k8s-stack-overview.webp) ## Configuration @@ -388,61 +388,68 @@ 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-k8s-stack/values.yaml`` file. - +
- - - - + + + + - - + - - + - - - - + - - - - - + + - + + + + + + + - - - - - - - - - - + - - + - - + - - - + + - + - - + - - - - - + + - + - - - - - - - - - - - + + + + + + - - - - - - - - - - - - - - + + - - - - - - - - - - + - - - - - - - - - + - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - + - - - + - - - - + - - + - - + - - + - - - + + - + - - + - - - - + - - + - - - + + - + - - - + + - - - - - - - - - - - - - - - - - - - - - - - + - - + - - + - - + - - - + + - + - - + - - - - + - - + - - + - - + - - - + + - + - - + - - - - + - - + - - + - - + - - - + + - + - - + - - - - - + + - + - - - - - - - - - - - - + - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - + + - + - - - - - - + - - - - - - - - - - - - - - - - - - - + - - + - - - - - - - - - - - - + - - + - - + - - + + + + + + - - + - - - - - - + - - + - - - - + - - + - - + - - + - - + - - - + + - + + + + + + + - - + - - + - - + - - + - - + - - + - - + - - - + + - + + + + + + + - - + - - + - - + - - + - - + - - + - - + - - - + + - + + + + + + + - - + - - + - - + - - + - - - - - + - - + - - + - - + - - + - - - + + - + + + + + + + - - + - - + - - + - - + - - -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
additionalVictoriaMetricsMap string
-null
+      
+null
+

Provide custom recording or alerting rules to be deployed into the cluster.

+
alertmanager.annotations object
-{}
+      
+{}
+

Alertmanager annotations

+
alertmanager.config object
-receivers:
+      
+receivers:
     - name: blackhole
 route:
     receiver: blackhole
 templates:
     - /etc/vm/configs/**/*.tmpl
+

alertmanager configuration

+

Alertmanager configuration
alertmanager.enabled bool
-true
+      
+true
+

Create VMAlertmanager CR

+
alertmanager.ingress object
-annotations: {}
+      
+annotations: {}
 enabled: false
 extraPaths: []
 hosts:
@@ -451,116 +458,144 @@ labels: {}
 path: '{{ .Values.alertmanager.spec.routePrefix | default "/" }}'
 pathType: Prefix
 tls: []
+

alertmanager ingress configuration

+

Alertmanager ingress configuration
alertmanager.monzoTemplate.enabledbool
-true
+
alertmanager.ingress.extraPathslist
+[]
+

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.

+
alertmanager.monzoTemplateobject
+enabled: true
+
+
+

Better alert templates for slack source

+
alertmanager.spec object
-configSecret: ""
+      
+configSecret: ""
 externalURL: ""
 image:
     tag: v0.25.0
 port: "9093"
 routePrefix: /
 selectAllByDefault: true
+

full spec for VMAlertmanager CRD. Allowed values described here

+

Full spec for VMAlertmanager CRD. Allowed values described here
alertmanager.spec.configSecret string
-""
+      
+""
+

if this one defined, it will be used for alertmanager configuration and config parameter will be ignored

+

If this one defined, it will be used for alertmanager configuration and config parameter will be ignored
alertmanager.templateFiles object
-{}
+      
+{}
+

extra alert templates

+

Extra alert templates
argocdReleaseOverride string
-""
+      
+""
+

For correct working need set value ‘argocdReleaseOverride=$ARGOCD_APP_NAME’

+

If this chart is used in “Argocd” with “releaseName” field then VMServiceScrapes couldn’t select the proper services. For correct working need set value ‘argocdReleaseOverride=$ARGOCD_APP_NAME’
coreDns.enabled bool
-true
+      
+true
+

Enabled CoreDNS metrics scraping

+
coreDns.service.enabled bool
-true
+      
+true
+

Create service for CoreDNS metrics

+
coreDns.service.port int
-9153
+      
+9153
+

CoreDNS service port

+
coreDns.service.selector.k8s-appstring
-kube-dns
+
coreDns.service.selectorobject
+k8s-app: kube-dns
+

CoreDNS service pod selector

+
coreDns.service.targetPort int
-9153
+      
+9153
+

CoreDNS service target port

+
coreDns.vmScrape object
-spec:
+      
+spec:
     endpoints:
         - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
           port: http-metrics
@@ -568,27 +603,31 @@ spec:
     namespaceSelector:
         matchNames:
             - kube-system
+

spec for VMServiceScrape crd https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec

+

Spec for VMServiceScrape CRD is here
crds.enabledbool
-true
+
crdsobject
+enabled: true
+

Install VM operator CRDs

+
dashboards object
-node-exporter-full: true
+      
+node-exporter-full: true
 operator: false
 vmalert: false
+

Enable dashboards despite it’s dependency is not installed

@@ -597,18 +636,20 @@ vmalert: false
dashboards.node-exporter-full bool
-true
+      
+true
+

in ArgoCD using client-side apply this dashboard reaches annotations size limit and causes k8s issues without server side apply See this issue

+

In ArgoCD using client-side apply this dashboard reaches annotations size limit and causes k8s issues without server side apply See this issue
defaultDashboardsEnabled bool
-true
+      
+true
+

Create default dashboards

@@ -617,8 +658,8 @@ true
defaultRules object
-alerting:
+      
+alerting:
     spec:
         annotations: {}
         labels: {}
@@ -746,6 +787,7 @@ rule:
         labels: {}
 rules: {}
 runbookUrl: https://runbooks.prometheus-operator.dev/runbooks
+

Create default rules for monitoring the cluster

@@ -754,10 +796,11 @@ runbookUrl: https://runbooks.prometheus-operator.dev/runbooks
defaultRules.alerting object
-spec:
+      
+spec:
     annotations: {}
     labels: {}
+

Common properties for VMRules alerts

@@ -766,8 +809,9 @@ spec:
defaultRules.alerting.spec.annotations object
-{}
+      
+{}
+

Additional annotations for VMRule alerts

@@ -776,8 +820,9 @@ spec:
defaultRules.alerting.spec.labels object
-{}
+      
+{}
+

Additional labels for VMRule alerts

@@ -786,8 +831,9 @@ spec:
defaultRules.annotations object
-{}
+      
+{}
+

Annotations for default rules

@@ -796,9 +842,10 @@ spec:
defaultRules.group object
-spec:
+      
+spec:
     params: {}
+

Common properties for VMRule groups

@@ -807,18 +854,137 @@ spec:
defaultRules.group.spec.params object
-{}
+      
+{}
+

Optional HTTP URL parameters added to each rule request

+
defaultRules.groupsobject
+alertmanager:
+    create: true
+    rules: {}
+etcd:
+    create: true
+    rules: {}
+general:
+    create: true
+    rules: {}
+k8sContainerCpuUsageSecondsTotal:
+    create: true
+    rules: {}
+k8sContainerMemoryCache:
+    create: true
+    rules: {}
+k8sContainerMemoryRss:
+    create: true
+    rules: {}
+k8sContainerMemorySwap:
+    create: true
+    rules: {}
+k8sContainerMemoryWorkingSetBytes:
+    create: true
+    rules: {}
+k8sContainerResource:
+    create: true
+    rules: {}
+k8sPodOwner:
+    create: true
+    rules: {}
+kubeApiserver:
+    create: true
+    rules: {}
+kubeApiserverAvailability:
+    create: true
+    rules: {}
+kubeApiserverBurnrate:
+    create: true
+    rules: {}
+kubeApiserverHistogram:
+    create: true
+    rules: {}
+kubeApiserverSlos:
+    create: true
+    rules: {}
+kubePrometheusGeneral:
+    create: true
+    rules: {}
+kubePrometheusNodeRecording:
+    create: true
+    rules: {}
+kubeScheduler:
+    create: true
+    rules: {}
+kubeStateMetrics:
+    create: true
+    rules: {}
+kubelet:
+    create: true
+    rules: {}
+kubernetesApps:
+    create: true
+    rules: {}
+    targetNamespace: .*
+kubernetesResources:
+    create: true
+    rules: {}
+kubernetesStorage:
+    create: true
+    rules: {}
+    targetNamespace: .*
+kubernetesSystem:
+    create: true
+    rules: {}
+kubernetesSystemApiserver:
+    create: true
+    rules: {}
+kubernetesSystemControllerManager:
+    create: true
+    rules: {}
+kubernetesSystemKubelet:
+    create: true
+    rules: {}
+kubernetesSystemScheduler:
+    create: true
+    rules: {}
+node:
+    create: true
+    rules: {}
+nodeNetwork:
+    create: true
+    rules: {}
+vmHealth:
+    create: true
+    rules: {}
+vmagent:
+    create: true
+    rules: {}
+vmcluster:
+    create: true
+    rules: {}
+vmoperator:
+    create: true
+    rules: {}
+vmsingle:
+    create: true
+    rules: {}
+
+
+

Rule group properties
defaultRules.groups.etcd.rules object
-{}
+      
+{}
+

Common properties for all rules in a group

@@ -827,8 +993,9 @@ spec:
defaultRules.labels object
-{}
+      
+{}
+

Labels for default rules

@@ -837,10 +1004,11 @@ spec:
defaultRules.recording object
-spec:
+      
+spec:
     annotations: {}
     labels: {}
+

Common properties for VMRules recording rules

@@ -849,8 +1017,9 @@ spec:
defaultRules.recording.spec.annotations object
-{}
+      
+{}
+

Additional annotations for VMRule recording rules

@@ -859,8 +1028,9 @@ spec:
defaultRules.recording.spec.labels object
-{}
+      
+{}
+

Additional labels for VMRule recording rules

@@ -869,10 +1039,11 @@ spec:
defaultRules.rule object
-spec:
+      
+spec:
     annotations: {}
     labels: {}
+

Common properties for all VMRules

@@ -881,8 +1052,9 @@ spec:
defaultRules.rule.spec.annotations object
-{}
+      
+{}
+

Additional annotations for all VMRules

@@ -891,8 +1063,9 @@ spec:
defaultRules.rule.spec.labels object
-{}
+      
+{}
+

Additional labels for all VMRules

@@ -901,8 +1074,9 @@ spec:
defaultRules.rules object
-{}
+      
+{}
+

Per rule properties

@@ -911,8 +1085,9 @@ spec:
defaultRules.runbookUrl string
-https://runbooks.prometheus-operator.dev/runbooks
+      
+https://runbooks.prometheus-operator.dev/runbooks
+

Runbook url prefix for default rules

@@ -921,36 +1096,34 @@ https://runbooks.prometheus-operator.dev/runbooks
experimentalDashboardsEnabled bool
-true
+      
+true
+

Create experimental dashboards
externalVM.read.urlstring
-""
+
externalVMobject
+read:
+    url: ""
+write:
+    url: ""
+
externalVM.write.urlstring
-""
-
+

External VM read and write URLs
extraObjects list
-[]
+      
+[]
+

Add extra objects dynamically to this chart

@@ -959,294 +1132,166 @@ true
fullnameOverride string
-""
+      
+""
+

Resource full name prefix override

+
global.clusterLabel string
-cluster
+      
+cluster
+
global.license.keystring
-""
-
+

Cluster label to use for dashboards and rules
global.license.keyRefglobal.license object
-{}
+      
+key: ""
+keyRef: {}
+

Global license configuration

+
grafanaobject
+additionalDataSources: []
+defaultDashboardsTimezone: utc
+defaultDatasourceType: prometheus
+enabled: true
+forceDeployDatasource: false
+ingress:
+    annotations: {}
+    enabled: false
+    extraPaths: []
+    hosts:
+        - grafana.domain.com
+    labels: {}
+    path: /
+    pathType: Prefix
+    tls: []
+sidecar:
+    dashboards:
+        additionalDashboardAnnotations: {}
+        additionalDashboardLabels: {}
+        defaultFolderName: default
+        enabled: true
+        folder: /var/lib/grafana/dashboards
+        multicluster: false
+        provider:
+            name: default
+            orgid: 1
+    datasources:
+        createVMReplicasDatasources: false
+        default:
+            - isDefault: true
+              name: VictoriaMetrics
+            - isDefault: false
+              name: VictoriaMetrics (DS)
+              type: victoriametrics-datasource
+        enabled: true
+        initDatasources: true
+vmScrape:
+    enabled: true
+    spec:
+        endpoints:
+            - port: '{{ .Values.grafana.service.portName }}'
+        selector:
+            matchLabels:
+                app.kubernetes.io/name: '{{ include "grafana.name" .Subcharts.grafana }}'
+
+
+

Grafana dependency chart configuration. For possible values refer here

+
grafana.additionalDataSources list
-[]
+      
+[]
+
grafana.defaultDashboardsTimezonestring
-utc
-
+

Configure additional grafana datasources (passed through tpl). Check here for details

grafana.defaultDatasourceTypestring
-prometheus
-
-
grafana.enabledbool
-true
-
-
grafana.forceDeployDatasource bool
-false
+      
+false
+
grafana.ingress.annotationsobject
-{}
-
+

Create datasource configmap even if grafana deployment has been disabled

grafana.ingress.enabledbool
-false
-
-
grafana.ingress.extraPaths list
-[]
+      
+[]
+
grafana.ingress.hosts[0]string
-grafana.domain.com
-
+

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.

grafana.ingress.labelsobject
-{}
-
-
grafana.ingress.pathstring
-/
-
-
grafana.ingress.pathTypestring
-Prefix
-
-
grafana.ingress.tlslist
-[]
-
-
grafana.sidecar.dashboards.additionalDashboardAnnotationsobject
-{}
-
-
grafana.sidecar.dashboards.additionalDashboardLabelsobject
-{}
-
-
grafana.sidecar.dashboards.defaultFolderNamestring
-default
-
-
grafana.sidecar.dashboards.enabledbool
-true
-
-
grafana.sidecar.dashboards.folderstring
-/var/lib/grafana/dashboards
-
-
grafana.sidecar.dashboards.multiclusterbool
-false
-
-
grafana.sidecar.dashboards.provider.namestring
-default
-
-
grafana.sidecar.dashboards.provider.orgidint
-1
-
-
grafana.sidecar.datasources.createVMReplicasDatasourcesbool
-false
-
-
grafana.sidecar.datasources.default list
-- isDefault: true
+      
+- isDefault: true
   name: VictoriaMetrics
 - isDefault: false
   name: VictoriaMetrics (DS)
   type: victoriametrics-datasource
+

list of default prometheus compatible datasource configurations. VM url will be added to each of them in templates and type will be set to defaultDatasourceType if not defined

+

List of default prometheus compatible datasource configurations. VM url will be added to each of them in templates and type will be set to defaultDatasourceType if not defined
grafana.sidecar.datasources.enabledbool
-true
-
-
grafana.sidecar.datasources.initDatasourcesbool
-true
-
-
grafana.vmScrape object
-enabled: true
+      
+enabled: true
 spec:
     endpoints:
         - port: '{{ .Values.grafana.service.portName }}'
     selector:
         matchLabels:
             app.kubernetes.io/name: '{{ include "grafana.name" .Subcharts.grafana }}'
+

grafana VM scrape config

+

Grafana VM scrape config
grafana.vmScrape.spec object
-endpoints:
+      
+endpoints:
     - port: '{{ .Values.grafana.service.portName }}'
 selector:
     matchLabels:
         app.kubernetes.io/name: '{{ include "grafana.name" .Subcharts.grafana }}'
+

Scrape configuration for Grafana

@@ -1255,31 +1300,48 @@ selector:
grafanaOperatorDashboardsFormat object
-allowCrossNamespaceImport: false
+      
+allowCrossNamespaceImport: false
 enabled: false
 instanceSelector:
     matchLabels:
         dashboards: grafana
+

Create dashboards as CRDs (reuqires grafana-operator to be installed)
kube-state-metrics.enabledbool
-true
+
kube-state-metricsobject
+enabled: true
+vmScrape:
+    enabled: true
+    spec:
+        endpoints:
+            - honorLabels: true
+              metricRelabelConfigs:
+                - action: labeldrop
+                  regex: (uid|container_id|image_id)
+              port: http
+        jobLabel: app.kubernetes.io/name
+        selector:
+            matchLabels:
+                app.kubernetes.io/instance: '{{ include "vm.release" . }}'
+                app.kubernetes.io/name: '{{ include "kube-state-metrics.name" (index .Subcharts "kube-state-metrics") }}'
+

kube-state-metrics dependency chart configuration. For possible values check here

+
kube-state-metrics.vmScrape object
-enabled: true
+      
+enabled: true
 spec:
     endpoints:
         - honorLabels: true
@@ -1292,6 +1354,7 @@ spec:
         matchLabels:
             app.kubernetes.io/instance: '{{ include "vm.release" . }}'
             app.kubernetes.io/name: '{{ include "kube-state-metrics.name" (index .Subcharts "kube-state-metrics") }}'
+

Scrape configuration for Kube State Metrics

@@ -1300,17 +1363,19 @@ spec:
kubeApiServer.enabled bool
-true
+      
+true
+

Enable Kube Api Server metrics scraping

+
kubeApiServer.vmScrape object
-spec:
+      
+spec:
     endpoints:
         - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
           port: https
@@ -1326,70 +1391,83 @@ spec:
         matchLabels:
             component: apiserver
             provider: kubernetes
+

spec for VMServiceScrape crd https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec

+

Spec for VMServiceScrape CRD is here
kubeControllerManager.enabled bool
-true
+      
+true
+

Enable kube controller manager metrics scraping

+
kubeControllerManager.endpoints list
-[]
+      
+[]
+

If your kube controller manager is not deployed as a pod, specify IPs it can be found on

+
kubeControllerManager.service.enabled bool
-true
+      
+true
+

Create service for kube controller manager metrics scraping

+
kubeControllerManager.service.port int
-10257
+      
+10257
+

Kube controller manager service port

+
kubeControllerManager.service.selector.componentstring
-kube-controller-manager
+
kubeControllerManager.service.selectorobject
+component: kube-controller-manager
+

Kube controller manager service pod selector

+
kubeControllerManager.service.targetPort int
-10257
+      
+10257
+

Kube controller manager service target port

+
kubeControllerManager.vmScrape object
-spec:
+      
+spec:
     endpoints:
         - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
           port: http-metrics
@@ -1401,79 +1479,66 @@ spec:
     namespaceSelector:
         matchNames:
             - kube-system
+

spec for VMServiceScrape crd https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec

+

Spec for VMServiceScrape CRD is here
kubeDns.enabled bool
-false
+      
+false
+

Enabled KubeDNS metrics scraping

+
kubeDns.service.enabled bool
-false
+      
+false
+

Create Service for KubeDNS metrics

+
kubeDns.service.ports.dnsmasq.portint
-10054
+
kubeDns.service.portsobject
+dnsmasq:
+    port: 10054
+    targetPort: 10054
+skydns:
+    port: 10055
+    targetPort: 10055
+

KubeDNS service ports

+
kubeDns.service.ports.dnsmasq.targetPortint
-10054
+
kubeDns.service.selectorobject
+k8s-app: kube-dns
+
kubeDns.service.ports.skydns.portint
-10055
-
+

KubeDNS service pods selector

kubeDns.service.ports.skydns.targetPortint
-10055
-
-
kubeDns.service.selector.k8s-appstring
-kube-dns
-
-
kubeDns.vmScrape object
-spec:
+      
+spec:
     endpoints:
         - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
           port: http-metrics-dnsmasq
@@ -1483,70 +1548,83 @@ spec:
     namespaceSelector:
         matchNames:
             - kube-system
+

spec for VMServiceScrape crd https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec

+

Spec for VMServiceScrape CRD is here
kubeEtcd.enabled bool
-true
+      
+true
+

Enabled KubeETCD metrics scraping

+
kubeEtcd.endpoints list
-[]
+      
+[]
+

If your etcd is not deployed as a pod, specify IPs it can be found on

+
kubeEtcd.service.enabled bool
-true
+      
+true
+

Enable service for ETCD metrics scraping

+
kubeEtcd.service.port int
-2379
+      
+2379
+

ETCD service port

+
kubeEtcd.service.selector.componentstring
-etcd
+
kubeEtcd.service.selectorobject
+component: etcd
+

ETCD service pods selector

+
kubeEtcd.service.targetPort int
-2379
+      
+2379
+

ETCD service target port

+
kubeEtcd.vmScrape object
-spec:
+      
+spec:
     endpoints:
         - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
           port: http-metrics
@@ -1557,70 +1635,83 @@ spec:
     namespaceSelector:
         matchNames:
             - kube-system
+

spec for VMServiceScrape crd https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec

+

Spec for VMServiceScrape CRD is here
kubeProxy.enabled bool
-false
+      
+false
+

Enable kube proxy metrics scraping

+
kubeProxy.endpoints list
-[]
+      
+[]
+

If your kube proxy is not deployed as a pod, specify IPs it can be found on

+
kubeProxy.service.enabled bool
-true
+      
+true
+

Enable service for kube proxy metrics scraping

+
kubeProxy.service.port int
-10249
+      
+10249
+

Kube proxy service port

+
kubeProxy.service.selector.k8s-appstring
-kube-proxy
+
kubeProxy.service.selectorobject
+k8s-app: kube-proxy
+

Kube proxy service pod selector

+
kubeProxy.service.targetPort int
-10249
+      
+10249
+

Kube proxy service target port

+
kubeProxy.vmScrape object
-spec:
+      
+spec:
     endpoints:
         - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
           port: http-metrics
@@ -1631,70 +1722,83 @@ spec:
     namespaceSelector:
         matchNames:
             - kube-system
+

spec for VMServiceScrape crd https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec

+

Spec for VMServiceScrape CRD is here
kubeScheduler.enabled bool
-true
+      
+true
+

Enable KubeScheduler metrics scraping

+
kubeScheduler.endpoints list
-[]
+      
+[]
+

If your kube scheduler is not deployed as a pod, specify IPs it can be found on

+
kubeScheduler.service.enabled bool
-true
+      
+true
+

Enable service for KubeScheduler metrics scrape

+
kubeScheduler.service.port int
-10259
+      
+10259
+

KubeScheduler service port

+
kubeScheduler.service.selector.componentstring
-kube-scheduler
+
kubeScheduler.service.selectorobject
+component: kube-scheduler
+

KubeScheduler service pod selector

+
kubeScheduler.service.targetPort int
-10259
+      
+10259
+

KubeScheduler service target port

+
kubeScheduler.vmScrape object
-spec:
+      
+spec:
     endpoints:
         - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
           port: http-metrics
@@ -1705,25 +1809,68 @@ spec:
     namespaceSelector:
         matchNames:
             - kube-system
+

spec for VMServiceScrape crd https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec

+

Spec for VMServiceScrape CRD is here
kubelet.enabledbool
-true
+
kubeletobject
+enabled: true
+vmScrape:
+    kind: VMNodeScrape
+    spec:
+        bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
+        honorLabels: true
+        honorTimestamps: false
+        interval: 30s
+        metricRelabelConfigs:
+            - action: labeldrop
+              regex: (uid)
+            - action: labeldrop
+              regex: (id|name)
+            - action: drop
+              regex: (rest_client_request_duration_seconds_bucket|rest_client_request_duration_seconds_sum|rest_client_request_duration_seconds_count)
+              source_labels:
+                - __name__
+        relabelConfigs:
+            - action: labelmap
+              regex: __meta_kubernetes_node_label_(.+)
+            - sourceLabels:
+                - __metrics_path__
+              targetLabel: metrics_path
+            - replacement: kubelet
+              targetLabel: job
+        scheme: https
+        scrapeTimeout: 5s
+        tlsConfig:
+            caFile: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
+            insecureSkipVerify: true
+vmScrapes:
+    cadvisor:
+        enabled: true
+        spec:
+            path: /metrics/cadvisor
+    kubelet:
+        spec: {}
+    probes:
+        enabled: true
+        spec:
+            path: /metrics/probes
+

Component scraping the kubelets

+
kubelet.vmScrape object
-kind: VMNodeScrape
+      
+kind: VMNodeScrape
 spec:
     bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
     honorLabels: true
@@ -1751,39 +1898,33 @@ spec:
     tlsConfig:
         caFile: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
         insecureSkipVerify: true
+

spec for VMNodeScrape crd https://docs.victoriametrics.com/operator/api.html#vmnodescrapespec

+

Spec for VMNodeScrape CRD is here
kubelet.vmScrapes.cadvisor object
-enabled: true
+      
+enabled: true
 spec:
     path: /metrics/cadvisor
+

Enable scraping /metrics/cadvisor from kubelet’s service
kubelet.vmScrapes.kubelet.specobject
-{}
-
-
kubelet.vmScrapes.probes object
-enabled: true
+      
+enabled: true
 spec:
     path: /metrics/probes
+

Enable scraping /metrics/probes from kubelet’s service

@@ -1792,53 +1933,50 @@ spec:
nameOverride string
-""
+      
+""
+

Resource full name suffix override

+
prometheus-node-exporter.enabledbool
-true
+
prometheus-node-exporterobject
+enabled: true
+extraArgs:
+    - --collector.filesystem.ignored-mount-points=^/(dev|proc|sys|var/lib/docker/.+|var/lib/kubelet/.+)($|/)
+    - --collector.filesystem.ignored-fs-types=^(autofs|binfmt_misc|bpf|cgroup2?|configfs|debugfs|devpts|devtmpfs|fusectl|hugetlbfs|iso9660|mqueue|nsfs|overlay|proc|procfs|pstore|rpc_pipefs|securityfs|selinuxfs|squashfs|sysfs|tracefs)$
+service:
+    labels:
+        jobLabel: node-exporter
+vmScrape:
+    enabled: true
+    spec:
+        endpoints:
+            - metricRelabelConfigs:
+                - action: drop
+                  regex: /var/lib/kubelet/pods.+
+                  source_labels:
+                    - mountpoint
+              port: metrics
+        jobLabel: jobLabel
+        selector:
+            matchLabels:
+                app.kubernetes.io/name: '{{ include "prometheus-node-exporter.name" (index .Subcharts "prometheus-node-exporter") }}'
+
prometheus-node-exporter.extraArgs[0]string
---collector.filesystem.ignored-mount-points=^/(dev|proc|sys|var/lib/docker/.+|var/lib/kubelet/.+)($|/)
-
+

prometheus-node-exporter dependency chart configuration. For possible values check here

prometheus-node-exporter.extraArgs[1]string
---collector.filesystem.ignored-fs-types=^(autofs|binfmt_misc|bpf|cgroup2?|configfs|debugfs|devpts|devtmpfs|fusectl|hugetlbfs|iso9660|mqueue|nsfs|overlay|proc|procfs|pstore|rpc_pipefs|securityfs|selinuxfs|squashfs|sysfs|tracefs)$
-
-
prometheus-node-exporter.service.labels.jobLabelstring
-node-exporter
-
-
prometheus-node-exporter.vmScrape object
-enabled: true
+      
+enabled: true
 spec:
     endpoints:
         - metricRelabelConfigs:
@@ -1851,16 +1989,17 @@ spec:
     selector:
         matchLabels:
             app.kubernetes.io/name: '{{ include "prometheus-node-exporter.name" (index .Subcharts "prometheus-node-exporter") }}'
+

node exporter VM scrape config

+

Node Exporter VM scrape config
prometheus-node-exporter.vmScrape.spec object
-endpoints:
+      
+endpoints:
     - metricRelabelConfigs:
         - action: drop
           regex: /var/lib/kubelet/pods.+
@@ -1871,25 +2010,29 @@ jobLabel: jobLabel
 selector:
     matchLabels:
         app.kubernetes.io/name: '{{ include "prometheus-node-exporter.name" (index .Subcharts "prometheus-node-exporter") }}'
+

Scrape configuration for Node Exporter
prometheus-operator-crds.enabledbool
-false
+
prometheus-operator-crdsobject
+enabled: false
+

Install prometheus operator CRDs

+
serviceAccount.annotations object
-{}
+      
+{}
+

Annotations to add to the service account

@@ -1898,8 +2041,9 @@ false
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

@@ -1908,27 +2052,30 @@ true
serviceAccount.name string
-""
+      
+""
+

If not set and create is true, a name is generated using the fullname template

+

The name of the service account to use. If not set and create is true, a name is generated using the fullname template
tenant string
-"0"
+      
+"0"
+

Tenant to use for Grafana datasources and remote write

+
victoria-metrics-operator object
-crd:
+      
+crd:
     cleanup:
         enabled: true
         image:
@@ -1940,39 +2087,18 @@ operator:
     disable_prometheus_converter: false
 serviceMonitor:
     enabled: true
+

also checkout here possible ENV variables to configure operator behaviour https://docs.victoriametrics.com/operator/vars

-
victoria-metrics-operator.crd.cleanupobject
-enabled: true
-image:
-    pullPolicy: IfNotPresent
-    repository: bitnami/kubectl
-
-

tells helm to clean up vm cr resources when uninstalling

-
victoria-metrics-operator.crd.createbool
-false
-
-

we disable crd creation by operator chart as we create them in this chart

+

VictoriaMetrics Operator dependency chart configuration. More values can be found here. Also checkout here possible ENV variables to configure operator behaviour
victoria-metrics-operator.operator.disable_prometheus_converter bool
-false
+      
+false
+

By default, operator converts prometheus-operator objects.

@@ -1981,36 +2107,41 @@ false
vmagent.additionalRemoteWrites list
-[]
+      
+[]
+

remoteWrite configuration of VMAgent, allowed parameters defined in a spec

+

Remote write configuration of VMAgent, allowed parameters defined in a spec
vmagent.annotations object
-{}
+      
+{}
+

VMAgent annotations

+
vmagent.enabled bool
-true
+      
+true
+

Create VMAgent CR

+
vmagent.ingress object
-annotations: {}
+      
+annotations: {}
 enabled: false
 extraPaths: []
 hosts:
@@ -2019,26 +2150,17 @@ labels: {}
 path: ""
 pathType: Prefix
 tls: []
+

vmagent ingress configuration

-
vmagent.ingress.extraPathslist
-[]
-
-

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.

+

VMAgent ingress configuration
vmagent.spec object
-externalLabels: {}
+      
+externalLabels: {}
 extraArgs:
     promscrape.dropOriginalLabels: "true"
     promscrape.streamParse: "true"
@@ -2047,43 +2169,50 @@ image:
 port: "8429"
 scrapeInterval: 20s
 selectAllByDefault: true
+

full spec for VMAgent CRD. Allowed values described here

+

Full spec for VMAgent CRD. Allowed values described here
vmalert.additionalNotifierConfigs object
-{}
+      
+{}
+

Allows to configure static notifiers, discover notifiers via Consul and DNS, see specification here. This configuration will be created as separate secret and mounted to VMAlert pod.

+
vmalert.annotations object
-{}
+      
+{}
+

VMAlert annotations

+
vmalert.enabled bool
-true
+      
+true
+

Create VMAlert CR

+
vmalert.ingress object
-annotations: {}
+      
+annotations: {}
 enabled: false
 extraPaths: []
 hosts:
@@ -2092,25 +2221,39 @@ labels: {}
 path: ""
 pathType: Prefix
 tls: []
+

vmalert ingress config

+

VMAlert ingress config

+
vmalert.ingress.extraPathslist
+[]
+
+
+

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.
vmalert.remoteWriteVMAgent bool
-false
+      
+false
+

Controls whether VMAlert should use VMAgent or VMInsert as a target for remotewrite

+
vmalert.spec object
-evaluationInterval: 15s
+      
+evaluationInterval: 15s
 externalLabels: {}
 extraArgs:
     http.pathPrefix: /
@@ -2118,289 +2261,381 @@ image:
     tag: v1.103.0
 port: "8080"
 selectAllByDefault: true
+

full spec for VMAlert CRD. Allowed values described here

+

Full spec for VMAlert CRD. Allowed values described here
vmalert.templateFiles object
-{}
+      
+{}
+

extra vmalert annotation templates

+

Extra VMAlert annotation templates
vmauth.annotations object
-{}
+      
+{}
+

VMAuth annotations

+
vmauth.enabled bool
-false
+      
+false
+

Enable VMAuth CR

+
vmauth.spec object
-discover_backend_ips: true
+      
+discover_backend_ips: true
 port: "8427"
+

full spec for VMAuth CRD. Allowed values described here

+

Full spec for VMAuth CRD. Allowed values described here
vmcluster.annotations object
-{}
+      
+{}
+

VMCluster annotations

+
vmcluster.enabled bool
-false
+      
+false
+

Create VMCluster CR

+
vmcluster.ingress.insert.annotations object
-{}
+      
+{}
+

Ingress annotations

+
vmcluster.ingress.insert.enabled bool
-false
+      
+false
+

Enable deployment of ingress for server component

+
vmcluster.ingress.insert.extraPaths list
-[]
+      
+[]
+

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.

+
vmcluster.ingress.insert.hosts[0]string
-vminsert.domain.com
+
vmcluster.ingress.insert.hostslist
+[]
+

Array of host objects

+
vmcluster.ingress.insert.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
vmcluster.ingress.insert.labels object
-{}
+      
+{}
+

Ingress extra labels

+
vmcluster.ingress.insert.path string
-'{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vminsert }}'
+      
+'{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vminsert }}'
+

Ingress default path

+
vmcluster.ingress.insert.pathType string
-Prefix
+      
+Prefix
+

Ingress path type

+
vmcluster.ingress.insert.tls list
-[]
+      
+[]
+

Array of TLS objects

+
vmcluster.ingress.select.annotations object
-{}
+      
+{}
+

Ingress annotations

+
vmcluster.ingress.select.enabled bool
-false
+      
+false
+

Enable deployment of ingress for server component

+
vmcluster.ingress.select.extraPaths list
-[]
+      
+[]
+

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.

+
vmcluster.ingress.select.hosts[0]string
-vmselect.domain.com
+
vmcluster.ingress.select.hostslist
+[]
+

Array of host objects

+
vmcluster.ingress.select.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
vmcluster.ingress.select.labels object
-{}
+      
+{}
+

Ingress extra labels

+
vmcluster.ingress.select.path string
-'{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vmselect }}'
+      
+'{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vmselect }}'
+

Ingress default path

+
vmcluster.ingress.select.pathType string
-Prefix
+      
+Prefix
+

Ingress path type

+
vmcluster.ingress.select.tls list
-[]
+      
+[]
+

Array of TLS objects

+
vmcluster.ingress.storage.annotations object
-{}
+      
+{}
+

Ingress annotations

+
vmcluster.ingress.storage.enabled bool
-false
+      
+false
+

Enable deployment of ingress for server component

+
vmcluster.ingress.storage.extraPaths list
-[]
+      
+[]
+

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.

+
vmcluster.ingress.storage.hosts[0]string
-vmstorage.domain.com
+
vmcluster.ingress.storage.hostslist
+[]
+

Array of host objects

+
vmcluster.ingress.storage.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
vmcluster.ingress.storage.labels object
-{}
+      
+{}
+

Ingress extra labels

+
vmcluster.ingress.storage.path string
-""
+      
+""
+

Ingress default path

+
vmcluster.ingress.storage.pathType string
-Prefix
+      
+Prefix
+

Ingress path type

+
vmcluster.ingress.storage.tls list
-[]
+      
+[]
+

Array of TLS objects

+
vmcluster.spec object
-replicationFactor: 2
+      
+replicationFactor: 2
 retentionPeriod: "1"
 vminsert:
     extraArgs: {}
@@ -2435,16 +2670,18 @@ vmstorage:
                     requests:
                         storage: 10Gi
     storageDataPath: /vm-data
+

full spec for VMCluster CRD. Allowed values described here

+

Full spec for VMCluster CRD. Allowed values described here
vmcluster.spec.retentionPeriod string
-"1"
+      
+"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

@@ -2453,98 +2690,129 @@ vmstorage:
vmsingle.annotations object
-{}
+      
+{}
+

VMSingle annotations

+
vmsingle.enabled bool
-true
+      
+true
+

Create VMSingle CR

+
vmsingle.ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

+
vmsingle.ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for server component

+
vmsingle.ingress.extraPaths list
-[]
+      
+[]
+

Extra paths to prepend to every host configuration. This is useful when working with annotation based services.

+
vmsingle.ingress.hosts[0]string
-vmsingle.domain.com
+
vmsingle.ingress.hostslist
+[]
+

Array of host objects

+
vmsingle.ingress.ingressClassNamestring
+""
+
+
+

Ingress controller class name

+
vmsingle.ingress.labels object
-{}
+      
+{}
+

Ingress extra labels

+
vmsingle.ingress.path string
-""
+      
+""
+

Ingress default path

+
vmsingle.ingress.pathType string
-Prefix
+      
+Prefix
+

Ingress path type

+
vmsingle.ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

+
vmsingle.spec object
-extraArgs: {}
+      
+extraArgs: {}
 image:
     tag: v1.103.0
 port: "8429"
@@ -2556,16 +2824,18 @@ storage:
     resources:
         requests:
             storage: 20Gi
+

full spec for VMSingle CRD. Allowed values describe here

+

Full spec for VMSingle CRD. Allowed values describe here
vmsingle.spec.retentionPeriod string
-"1"
+      
+"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

diff --git a/docs/helm/victoria-metrics-k8s-stack/img/k8s-stack-overview.webp b/docs/helm/victoria-metrics-k8s-stack/img/k8s-stack-overview.webp new file mode 100644 index 0000000000..84b6f6aa5e Binary files /dev/null and b/docs/helm/victoria-metrics-k8s-stack/img/k8s-stack-overview.webp differ diff --git a/docs/helm/victoria-metrics-operator/README.md b/docs/helm/victoria-metrics-operator/README.md index ce9289ebe8..47162c443e 100644 --- a/docs/helm/victoria-metrics-operator/README.md +++ b/docs/helm/victoria-metrics-operator/README.md @@ -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. - +
- - - - + + + + - - - - - - - - - - - - - - - - - + - - - - + - - - - - - - + + + + + + - - + - - + - - - - - - - - - - - - - - - - - + - - + - - - - - - - - - - + - - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - + - - - - - - -
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
admissionWebhooks object
-certManager:
+      
+certManager:
     enabled: false
     issuer: {}
 enabled: true
@@ -226,6 +226,7 @@ tls:
     caCert: null
     cert: null
     key: null
+

Configures resource validation

@@ -234,19 +235,21 @@ tls:
admissionWebhooks.certManager object
-enabled: false
+      
+enabled: false
 issuer: {}
+

with keys: tls.key, tls.crt, ca.crt

+

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
admissionWebhooks.certManager.enabled bool
-false
+      
+false
+

Enables cert creation and injection by cert-manager.

@@ -255,8 +258,9 @@ false
admissionWebhooks.certManager.issuer object
-{}
+      
+{}
+

If needed, provide own issuer. Operator will create self-signed if empty.

@@ -265,8 +269,9 @@ false
admissionWebhooks.enabled bool
-true
+      
+true
+

Enables validation webhook.

@@ -275,8 +280,9 @@ true
admissionWebhooks.policy string
-Fail
+      
+Fail
+

What to do in case, when operator not available to validate request.

@@ -285,8 +291,9 @@ Fail
affinity object
-{}
+      
+{}
+

Pod affinity

@@ -295,8 +302,9 @@ Fail
annotations object
-{}
+      
+{}
+

Annotations to be added to the all resources

@@ -305,8 +313,9 @@ Fail
crd.cleanup.enabled bool
-false
+      
+false
+

Tells helm to clean up all the vm resources under this release’s namespace when uninstalling

@@ -315,10 +324,11 @@ false
crd.cleanup.image object
-pullPolicy: IfNotPresent
+      
+pullPolicy: IfNotPresent
 repository: bitnami/kubectl
 tag: ""
+

Image configuration for CRD cleanup Job

@@ -327,56 +337,64 @@ tag: ""
crd.create bool
-true
+      
+true
+

with this option, if you remove this chart, all crd resources will be deleted with it.

+

Enables CRD creation and management. With this option, if you remove this chart, all CRD resources will be deleted with it.
env list
-[]
+      
+[]
+

extra settings for the operator deployment. Full list here

+

Extra settings for the operator deployment. Full list here
envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
extraArgs object
-{}
+      
+{}
+

operator container additional commandline arguments

+

Operator container additional commandline arguments
extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with operator

+
extraHostPathMounts list
-[]
+      
+[]
+

Additional hostPath mounts

@@ -385,8 +403,9 @@ true
extraLabels object
-{}
+      
+{}
+

Labels to be added to the all resources

@@ -395,8 +414,9 @@ true
extraObjects list
-[]
+      
+[]
+

Add extra specs dynamically to this chart

@@ -405,8 +425,9 @@ true
extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

@@ -415,8 +436,9 @@ true
extraVolumes list
-[]
+      
+[]
+

Extra Volumes for the pod

@@ -425,8 +447,9 @@ true
fullnameOverride string
-""
+      
+""
+

Overrides the full name of server component

@@ -435,39 +458,57 @@ true
global.cluster.dnsDomain string
-cluster.local
+      
+cluster.local
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+
+
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
image object
-pullPolicy: IfNotPresent
+      
+pullPolicy: IfNotPresent
 registry: ""
 repository: victoriametrics/operator
 tag: ""
 variant: ""
+

operator image configuration

@@ -476,8 +517,9 @@ variant: ""
image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Image pull policy

@@ -486,8 +528,9 @@ IfNotPresent
image.registry string
-""
+      
+""
+

Image registry

@@ -496,8 +539,9 @@ IfNotPresent
image.repository string
-victoriametrics/operator
+      
+victoriametrics/operator
+

Image repository

@@ -506,8 +550,9 @@ victoriametrics/operator
image.tag string
-""
+      
+""
+

Image tag override Chart.AppVersion

@@ -516,8 +561,9 @@ victoriametrics/operator
imagePullSecrets list
-[]
+      
+[]
+

Secret to pull images

@@ -526,18 +572,20 @@ victoriametrics/operator
logLevel string
-info
+      
+info
+

possible values: info and error.

+

VM operator log level. Possible values: info and error.
nameOverride string
-""
+      
+""
+

VM operatror deployment name override

@@ -546,8 +594,9 @@ info
nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

@@ -556,8 +605,9 @@ info
operator.disable_prometheus_converter bool
-false
+      
+false
+

By default, operator converts prometheus-operator objects.

@@ -566,8 +616,9 @@ false
operator.enable_converter_ownership bool
-false
+      
+false
+

Enables ownership reference for converted prometheus-operator objects, it will remove corresponding victoria-metrics objects in case of deletion prometheus one.

@@ -576,8 +627,9 @@ false
operator.prometheus_converter_add_argocd_ignore_annotations bool
-false
+      
+false
+

Compare-options and sync-options for prometheus objects converted by operator for properly use with ArgoCD

@@ -586,8 +638,9 @@ false
operator.useCustomConfigReloader bool
-false
+      
+false
+

Enables custom config-reloader, bundled with operator. It should reduce vmagent and vmauth config sync-time and make it predictable.

@@ -596,9 +649,10 @@ false
podDisruptionBudget object
-enabled: false
+      
+enabled: false
 labels: {}
+

See kubectl explain poddisruptionbudget.spec for more or check these docs

@@ -607,31 +661,36 @@ labels: {}
podLabels object
-{}
+      
+{}
+

extra Labels for Pods only

+
podSecurityContext object
-{}
+      
+{}
+

Pod’s security context. Details are here

+
probe.liveness object
-failureThreshold: 3
+      
+failureThreshold: 3
 initialDelaySeconds: 5
 periodSeconds: 15
 tcpSocket:
     port: probe
 timeoutSeconds: 5
+

Liveness probe

@@ -640,13 +699,14 @@ timeoutSeconds: 5
probe.readiness object
-failureThreshold: 3
+      
+failureThreshold: 3
 httpGet:
     port: probe
 initialDelaySeconds: 5
 periodSeconds: 15
 timeoutSeconds: 5
+

Readiness probe

@@ -655,8 +715,9 @@ timeoutSeconds: 5
probe.startup object
-{}
+      
+{}
+

Startup probe

@@ -665,36 +726,39 @@ timeoutSeconds: 5
rbac.aggregatedClusterRoles object
-enabled: true
+      
+enabled: true
 labels:
     admin:
         rbac.authorization.k8s.io/aggregate-to-admin: "true"
     view:
         rbac.authorization.k8s.io/aggregate-to-view: "true"
+

create aggregated clusterRoles for CRD readonly and admin permissions

+

Create aggregated clusterRoles for CRD readonly and admin permissions
rbac.aggregatedClusterRoles.labels object
-admin:
+      
+admin:
     rbac.authorization.k8s.io/aggregate-to-admin: "true"
 view:
     rbac.authorization.k8s.io/aggregate-to-view: "true"
+

labels attached to according clusterRole

+

Labels attached to according clusterRole
rbac.create bool
-true
+      
+true
+

Specifies whether the RBAC resources should be created

@@ -703,17 +767,20 @@ true
replicaCount int
-1
+      
+1
+

Number of operator replicas

+
resources object
-{}
+      
+{}
+

Resource object

@@ -722,134 +789,163 @@ true
securityContext object
-{}
+      
+{}
+

Security context to be added to server pods

+
service.annotations object
-{}
+      
+{}
+

Service annotations

+
service.clusterIP string
-""
+      
+""
+

Service ClusterIP

+
service.externalIPs string
-""
+      
+""
+

Service external IPs. Check here for details

+
service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
service.healthCheckNodePort string
-""
+      
+""
+

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

+
service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
service.labels object
-{}
+      
+{}
+

Service labels

+
service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

+
service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

+
service.servicePort int
-8080
+      
+8080
+

Service port

+
service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

+
service.webhookPort int
-9443
+      
+9443
+

Service webhook port

+
serviceAccount.create bool
-true
+      
+true
+

Specifies whether a service account should be created

@@ -858,8 +954,9 @@ true
serviceAccount.name string
-""
+      
+""
+

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

@@ -868,8 +965,8 @@ true
serviceMonitor object
-annotations: {}
+      
+annotations: {}
 basicAuth: {}
 enabled: false
 extraLabels: {}
@@ -878,16 +975,18 @@ relabelings: []
 scheme: ""
 scrapeTimeout: ""
 tlsConfig: {}
+

configures monitoring with serviceScrape. VMServiceScrape must be pre-installed

+

Configures monitoring with serviceScrape. VMServiceScrape must be pre-installed
tolerations list
-[]
+      
+[]
+

Array of tolerations object. Spec is here

@@ -896,8 +995,9 @@ tlsConfig: {}
topologySpreadConstraints list
-[]
+      
+[]
+

Pod Topology Spread Constraints. Spec is here

@@ -906,8 +1006,9 @@ tlsConfig: {}
watchNamespaces list
-[]
+      
+[]
+

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.

diff --git a/docs/helm/victoria-metrics-single/README.md b/docs/helm/victoria-metrics-single/README.md index d8075d2634..ec661c4b26 100644 --- a/docs/helm/victoria-metrics-single/README.md +++ b/docs/helm/victoria-metrics-single/README.md @@ -124,78 +124,79 @@ 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-single/values.yaml`` file. - +
- - - - + + + + - - - - - - - - - - + + - + - - + - - + - - - - - - - - - + + - - - - - - - - - - + + - + + + + + + + - - + - - + - - - - + - - - - - + - - - + + - - - - - - - - - - - - - - - + - @@ -394,8 +406,9 @@ json - - - + - @@ -422,8 +438,9 @@ json - - - - - - @@ -481,17 +503,20 @@ victoriametrics/victoria-metrics - - + - - - - - - + - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - + - - + - - - + + - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + - - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - @@ -2016,219 +1504,215 @@ json - - - - - - - - - - + + - + - - - + + - + - - - + + - + - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - + + + + + + - - - - + + + + + + +
KeyTypeDefaultDescriptionKeyTypeDefaultDescription
automountServiceAccountTokenbool
-true
-
-
extraObjects list
-[]
+      
+[]
+

Add extra specs dynamically to this chart
global.compatibility.openshift.adaptSecurityContextstring
-auto
+
global.compatibilityobject
+openshift:
+    adaptSecurityContext: auto
+

Openshift security context compatibility configuration

+
global.image.registry string
-""
+      
+""
+

Image registry, that can be shared across multiple helm charts

+
global.imagePullSecrets list
-[]
+      
+[]
+

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

+
license object
-key: ""
+      
+key: ""
 secret:
     key: ""
     name: ""
+

Enterprise license key configuration for VictoriaMetrics enterprise. Required only for VictoriaMetrics enterprise. Documentation - https://docs.victoriametrics.com/enterprise, for more information, visit https://victoriametrics.com/products/enterprise/ . To request a trial license, go to https://victoriametrics.com/products/enterprise/trial/ Supported starting from VictoriaMetrics v1.94.0

+

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 string
-""
+      
+""
+

License key

@@ -204,9 +205,10 @@ secret:
license.secret object
-key: ""
+      
+key: ""
 name: ""
+

Use existing secret with license key

@@ -215,8 +217,9 @@ name: ""
license.secret.key string
-""
+      
+""
+

Key in secret with license key

@@ -225,74 +228,87 @@ name: ""
license.secret.name string
-""
+      
+""
+

Existing secret name
podDisruptionBudget.enabledbool
-false
+
podDisruptionBudgetobject
+enabled: false
+extraLabels: {}
+

See kubectl explain poddisruptionbudget.spec for more. Details are here
podDisruptionBudget.extraLabelsobject
-{}
-
-
printNotes bool
-true
+      
+true
+

Print chart notes
rbac.createbool
-true
+
rbac.annotationsobject
+{}
+

Role/RoleBinding annotations

+
rbac.createbool
+true
+
+
+

Enables Role/RoleBinding creation

+
rbac.extraLabels object
-{}
+      
+{}
+

Role/RoleBinding labels

+
rbac.namespaced bool
-false
+      
+false
+

If true and rbac.enabled, will deploy a Role/RoleBinding instead of a ClusterRole/ClusterRoleBinding

+
server.affinity object
-{}
+      
+{}
+

Pod affinity

@@ -301,8 +317,9 @@ false
server.containerWorkingDir string
-""
+      
+""
+

Container workdir

@@ -311,17 +328,20 @@ false
server.emptyDir object
-{}
+      
+{}
+

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

+
server.enabled bool
-true
+      
+true
+

Enable deployment of server component. Deployed as StatefulSet

@@ -330,63 +350,55 @@ true
server.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here for more details
server.envFrom list
-[]
+      
+[]
+

Specify alternative source for env variables

+
server.extraArgs."envflag.enable"string
-"true"
+
server.extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
server.extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for container of component

server.extraArgs.loggerFormatstring
-json
-
-
server.extraContainers list
-[]
+      
+[]
+

Extra containers to run in a pod with VM single

+
server.extraHostPathMounts list
-[]
+      
+[]
+
server.extraLabels object
-{}
+      
+{}
+

Sts/Deploy additional labels

@@ -404,17 +417,20 @@ json
server.extraVolumeMounts list
-[]
+      
+[]
+

Extra Volume Mounts for the container

+
server.extraVolumes list
-[]
+      
+[]
+
server.fullnameOverride string
-null
+      
+null
+

Overrides the full name of server component

@@ -432,8 +449,9 @@ null
server.image.pullPolicy string
-IfNotPresent
+      
+IfNotPresent
+

Image pull policy

@@ -442,8 +460,9 @@ IfNotPresent
server.image.registry string
-""
+      
+""
+

Image registry

@@ -452,8 +471,9 @@ IfNotPresent
server.image.repository string
-victoriametrics/victoria-metrics
+      
+victoriametrics/victoria-metrics
+

Image repository

@@ -462,8 +482,9 @@ victoriametrics/victoria-metrics
server.image.tag string
-""
+      
+""
+

Image tag

@@ -472,8 +493,9 @@ victoriametrics/victoria-metrics
server.image.variant string
-""
+      
+""
+
server.imagePullSecrets list
-[]
+      
+[]
+

Image pull secrets

+
server.ingress.annotations object
-{}
+      
+{}
+

Ingress annotations

@@ -500,8 +525,9 @@ victoriametrics/victoria-metrics
server.ingress.enabled bool
-false
+      
+false
+

Enable deployment of ingress for server component

@@ -510,8 +536,9 @@ false
server.ingress.extraLabels object
-{}
+      
+{}
+

Ingress extra labels

@@ -520,8 +547,9 @@ false
server.ingress.hosts list
-[]
+      
+[]
+

Array of host objects

@@ -530,18 +558,19 @@ false
server.ingress.pathType string
-Prefix
+      
+Prefix
+

pathType is only for k8s >= 1.1=

-
server.ingress.tls list
-[]
+      
+[]
+

Array of TLS objects

@@ -550,17 +579,20 @@ Prefix
server.initContainers list
-[]
+      
+[]
+

Init containers for VM single pod

+
server.name string
-server
+      
+server
+

Server container name

@@ -569,8 +601,9 @@ server
server.nodeSelector object
-{}
+      
+{}
+

Pod’s node selector. Details are here

@@ -579,8 +612,9 @@ server
server.persistentVolume.accessModes list
-- ReadWriteOnce
+      
+- ReadWriteOnce
+

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

@@ -589,8 +623,9 @@ server
server.persistentVolume.annotations object
-{}
+      
+{}
+

Persistant volume annotations

@@ -599,8 +634,9 @@ server
server.persistentVolume.enabled bool
-true
+      
+true
+

Create/use Persistent Volume Claim for server component. Empty dir if false

@@ -609,8 +645,9 @@ true
server.persistentVolume.existingClaim string
-""
+      
+""
+

Existing Claim name. If defined, PVC must be created manually before volume will be bound

@@ -619,8 +656,9 @@ true
server.persistentVolume.matchLabels object
-{}
+      
+{}
+

Bind Persistent Volume by labels. Must match all labels of targeted PV.

@@ -629,8 +667,9 @@ true
server.persistentVolume.mountPath string
-/storage
+      
+/storage
+

Mount path. Server data Persistent Volume mount root path.

@@ -639,8 +678,9 @@ true
server.persistentVolume.size string
-16Gi
+      
+16Gi
+

Size of the volume. Should be calculated based on the metrics you send and retention policy you set.

@@ -649,8 +689,9 @@ true
server.persistentVolume.storageClassName string
-""
+      
+""
+

StorageClass to use for persistent volume. Requires server.persistentVolume.enabled: true. If defined, PVC created automatically

@@ -659,8 +700,9 @@ true
server.persistentVolume.subPath string
-""
+      
+""
+

Mount subpath

@@ -669,8 +711,9 @@ true
server.podAnnotations object
-{}
+      
+{}
+

Pod’s annotations

@@ -679,8 +722,9 @@ true
server.podLabels object
-{}
+      
+{}
+

Pod’s additional labels

@@ -689,8 +733,9 @@ true
server.podManagementPolicy string
-OrderedReady
+      
+OrderedReady
+

Pod’s management policy

@@ -699,8 +744,9 @@ OrderedReady
server.podSecurityContext object
-enabled: true
+      
+enabled: true
+

Pod’s security context. Details are here

@@ -709,119 +755,86 @@ enabled: true
server.priorityClassName string
-""
+      
+""
+

Name of Priority Class
server.probe.liveness.failureThresholdint
-10
-
-
server.probe.liveness.initialDelaySecondsint
-30
-
-
server.probe.liveness.periodSecondsint
-30
-
-
server.probe.liveness.tcpSocketserver.probe object
-{}
+      
+liveness:
+    failureThreshold: 10
+    initialDelaySeconds: 30
+    periodSeconds: 30
+    tcpSocket: {}
+    timeoutSeconds: 5
+readiness:
+    failureThreshold: 3
+    httpGet: {}
+    initialDelaySeconds: 5
+    periodSeconds: 15
+    timeoutSeconds: 5
+startup: {}
+
server.probe.liveness.timeoutSecondsint
-5
-
+

Readiness & Liveness probes
server.probe.readiness.failureThresholdint
-3
-
-
server.probe.readiness.httpGetserver.probe.liveness object
-{}
+      
+failureThreshold: 10
+initialDelaySeconds: 30
+periodSeconds: 30
+tcpSocket: {}
+timeoutSeconds: 5
+

Indicates whether the Container is running. If the liveness probe fails, the kubelet kills the Container, and the Container is subjected to its restart policy. If a Container does not provide a liveness probe, the default state is Success.

+
server.probe.readiness.initialDelaySecondsint
-5
+
server.probe.readinessobject
+failureThreshold: 3
+httpGet: {}
+initialDelaySeconds: 5
+periodSeconds: 15
+timeoutSeconds: 5
+
server.probe.readiness.periodSecondsint
-15
-
+

Indicates whether the Container is ready to service requests. If the readiness probe fails, the endpoints controller removes the Pod’s IP address from the endpoints of all Services that match the Pod. The default state of readiness before the initial delay is Failure. If a Container does not provide a readiness probe, the default state is Success.

server.probe.readiness.timeoutSecondsint
-5
-
-
server.probe.startup object
-{}
+      
+{}
+

Indicates whether the Container is done with potentially costly initialization. If set it is executed first. If it fails Container is restarted. If it succeeds liveness and readiness probes takes over.

+
server.relabel object
-config: []
+      
+config: []
 configMap: ""
 enabled: false
+

Global relabel configuration

@@ -830,8 +843,9 @@ enabled: false
server.relabel.configMap string
-""
+      
+""
+

Use existing configmap if specified otherwise .config values will be used. Relabel config should reside under relabel.yml key

@@ -840,18 +854,20 @@ enabled: false
server.replicaCount int
-1
+      
+1
+

Replica count

+

Number of victoriametrics single replicas
server.resources object
-{}
+      
+{}
+

Resource object. Details are here

@@ -860,252 +876,19 @@ enabled: false
server.retentionPeriod int
-1
+      
+1
+

Data retention period in month

-
server.scrapeobject
-config:
-    global:
-        scrape_interval: 15s
-    scrape_configs:
-        - job_name: victoriametrics
-          static_configs:
-            - targets:
-                - localhost:8428
-        - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-          job_name: kubernetes-apiservers
-          kubernetes_sd_configs:
-            - role: endpoints
-          relabel_configs:
-            - action: keep
-              regex: default;kubernetes;https
-              source_labels:
-                - __meta_kubernetes_namespace
-                - __meta_kubernetes_service_name
-                - __meta_kubernetes_endpoint_port_name
-          scheme: https
-          tls_config:
-            ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-            insecure_skip_verify: true
-        - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-          job_name: kubernetes-nodes
-          kubernetes_sd_configs:
-            - role: node
-          relabel_configs:
-            - action: labelmap
-              regex: __meta_kubernetes_node_label_(.+)
-            - replacement: kubernetes.default.svc:443
-              target_label: __address__
-            - regex: (.+)
-              replacement: /api/v1/nodes/$1/proxy/metrics
-              source_labels:
-                - __meta_kubernetes_node_name
-              target_label: __metrics_path__
-          scheme: https
-          tls_config:
-            ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-            insecure_skip_verify: true
-        - bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-          honor_timestamps: false
-          job_name: kubernetes-nodes-cadvisor
-          kubernetes_sd_configs:
-            - role: node
-          relabel_configs:
-            - action: labelmap
-              regex: __meta_kubernetes_node_label_(.+)
-            - replacement: kubernetes.default.svc:443
-              target_label: __address__
-            - regex: (.+)
-              replacement: /api/v1/nodes/$1/proxy/metrics/cadvisor
-              source_labels:
-                - __meta_kubernetes_node_name
-              target_label: __metrics_path__
-          scheme: https
-          tls_config:
-            ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-            insecure_skip_verify: true
-        - job_name: kubernetes-service-endpoints
-          kubernetes_sd_configs:
-            - role: endpoints
-          relabel_configs:
-            - action: drop
-              regex: true
-              source_labels:
-                - __meta_kubernetes_pod_container_init
-            - action: keep_if_equal
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_port
-                - __meta_kubernetes_pod_container_port_number
-            - action: keep
-              regex: true
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_scrape
-            - action: replace
-              regex: (https?)
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_scheme
-              target_label: __scheme__
-            - action: replace
-              regex: (.+)
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_path
-              target_label: __metrics_path__
-            - action: replace
-              regex: ([^:]+)(?::\d+)?;(\d+)
-              replacement: $1:$2
-              source_labels:
-                - __address__
-                - __meta_kubernetes_service_annotation_prometheus_io_port
-              target_label: __address__
-            - action: labelmap
-              regex: __meta_kubernetes_service_label_(.+)
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_namespace
-              target_label: namespace
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_service_name
-              target_label: service
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_pod_node_name
-              target_label: node
-        - job_name: kubernetes-service-endpoints-slow
-          kubernetes_sd_configs:
-            - role: endpoints
-          relabel_configs:
-            - action: drop
-              regex: true
-              source_labels:
-                - __meta_kubernetes_pod_container_init
-            - action: keep_if_equal
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_port
-                - __meta_kubernetes_pod_container_port_number
-            - action: keep
-              regex: true
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_scrape_slow
-            - action: replace
-              regex: (https?)
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_scheme
-              target_label: __scheme__
-            - action: replace
-              regex: (.+)
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_path
-              target_label: __metrics_path__
-            - action: replace
-              regex: ([^:]+)(?::\d+)?;(\d+)
-              replacement: $1:$2
-              source_labels:
-                - __address__
-                - __meta_kubernetes_service_annotation_prometheus_io_port
-              target_label: __address__
-            - action: labelmap
-              regex: __meta_kubernetes_service_label_(.+)
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_namespace
-              target_label: namespace
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_service_name
-              target_label: service
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_pod_node_name
-              target_label: node
-          scrape_interval: 5m
-          scrape_timeout: 30s
-        - job_name: kubernetes-services
-          kubernetes_sd_configs:
-            - role: service
-          metrics_path: /probe
-          params:
-            module:
-                - http_2xx
-          relabel_configs:
-            - action: keep
-              regex: true
-              source_labels:
-                - __meta_kubernetes_service_annotation_prometheus_io_probe
-            - source_labels:
-                - __address__
-              target_label: __param_target
-            - replacement: blackbox
-              target_label: __address__
-            - source_labels:
-                - __param_target
-              target_label: instance
-            - action: labelmap
-              regex: __meta_kubernetes_service_label_(.+)
-            - source_labels:
-                - __meta_kubernetes_namespace
-              target_label: namespace
-            - source_labels:
-                - __meta_kubernetes_service_name
-              target_label: service
-        - job_name: kubernetes-pods
-          kubernetes_sd_configs:
-            - role: pod
-          relabel_configs:
-            - action: drop
-              regex: true
-              source_labels:
-                - __meta_kubernetes_pod_container_init
-            - action: keep_if_equal
-              source_labels:
-                - __meta_kubernetes_pod_annotation_prometheus_io_port
-                - __meta_kubernetes_pod_container_port_number
-            - action: keep
-              regex: true
-              source_labels:
-                - __meta_kubernetes_pod_annotation_prometheus_io_scrape
-            - action: replace
-              regex: (.+)
-              source_labels:
-                - __meta_kubernetes_pod_annotation_prometheus_io_path
-              target_label: __metrics_path__
-            - action: replace
-              regex: ([^:]+)(?::\d+)?;(\d+)
-              replacement: $1:$2
-              source_labels:
-                - __address__
-                - __meta_kubernetes_pod_annotation_prometheus_io_port
-              target_label: __address__
-            - action: labelmap
-              regex: __meta_kubernetes_pod_label_(.+)
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_namespace
-              target_label: namespace
-            - action: replace
-              source_labels:
-                - __meta_kubernetes_pod_name
-              target_label: pod
-configMap: ""
-enabled: false
-extraScrapeConfigs: []
-
-

Scrape configuration for victoriametrics
server.scrape.config object
-global:
+      
+global:
     scrape_interval: 15s
 scrape_configs:
     - job_name: victoriametrics
@@ -1326,336 +1109,18 @@ scrape_configs:
           source_labels:
             - __meta_kubernetes_pod_name
           target_label: pod
+

Scrape config

-
server.scrape.config.scrape_configslist
-- job_name: victoriametrics
-  static_configs:
-    - targets:
-        - localhost:8428
-- bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-  job_name: kubernetes-apiservers
-  kubernetes_sd_configs:
-    - role: endpoints
-  relabel_configs:
-    - action: keep
-      regex: default;kubernetes;https
-      source_labels:
-        - __meta_kubernetes_namespace
-        - __meta_kubernetes_service_name
-        - __meta_kubernetes_endpoint_port_name
-  scheme: https
-  tls_config:
-    ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-    insecure_skip_verify: true
-- bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-  job_name: kubernetes-nodes
-  kubernetes_sd_configs:
-    - role: node
-  relabel_configs:
-    - action: labelmap
-      regex: __meta_kubernetes_node_label_(.+)
-    - replacement: kubernetes.default.svc:443
-      target_label: __address__
-    - regex: (.+)
-      replacement: /api/v1/nodes/$1/proxy/metrics
-      source_labels:
-        - __meta_kubernetes_node_name
-      target_label: __metrics_path__
-  scheme: https
-  tls_config:
-    ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-    insecure_skip_verify: true
-- bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token
-  honor_timestamps: false
-  job_name: kubernetes-nodes-cadvisor
-  kubernetes_sd_configs:
-    - role: node
-  relabel_configs:
-    - action: labelmap
-      regex: __meta_kubernetes_node_label_(.+)
-    - replacement: kubernetes.default.svc:443
-      target_label: __address__
-    - regex: (.+)
-      replacement: /api/v1/nodes/$1/proxy/metrics/cadvisor
-      source_labels:
-        - __meta_kubernetes_node_name
-      target_label: __metrics_path__
-  scheme: https
-  tls_config:
-    ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-    insecure_skip_verify: true
-- job_name: kubernetes-service-endpoints
-  kubernetes_sd_configs:
-    - role: endpoints
-  relabel_configs:
-    - action: drop
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_container_init
-    - action: keep_if_equal
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-        - __meta_kubernetes_pod_container_port_number
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scrape
-    - action: replace
-      regex: (https?)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scheme
-      target_label: __scheme__
-    - action: replace
-      regex: (.+)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_path
-      target_label: __metrics_path__
-    - action: replace
-      regex: ([^:]+)(?::\d+)?;(\d+)
-      replacement: $1:$2
-      source_labels:
-        - __address__
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-      target_label: __address__
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_pod_node_name
-      target_label: node
-- job_name: kubernetes-service-endpoints-slow
-  kubernetes_sd_configs:
-    - role: endpoints
-  relabel_configs:
-    - action: drop
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_container_init
-    - action: keep_if_equal
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-        - __meta_kubernetes_pod_container_port_number
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scrape_slow
-    - action: replace
-      regex: (https?)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scheme
-      target_label: __scheme__
-    - action: replace
-      regex: (.+)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_path
-      target_label: __metrics_path__
-    - action: replace
-      regex: ([^:]+)(?::\d+)?;(\d+)
-      replacement: $1:$2
-      source_labels:
-        - __address__
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-      target_label: __address__
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_pod_node_name
-      target_label: node
-  scrape_interval: 5m
-  scrape_timeout: 30s
-- job_name: kubernetes-services
-  kubernetes_sd_configs:
-    - role: service
-  metrics_path: /probe
-  params:
-    module:
-        - http_2xx
-  relabel_configs:
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_probe
-    - source_labels:
-        - __address__
-      target_label: __param_target
-    - replacement: blackbox
-      target_label: __address__
-    - source_labels:
-        - __param_target
-      target_label: instance
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-- job_name: kubernetes-pods
-  kubernetes_sd_configs:
-    - role: pod
-  relabel_configs:
-    - action: drop
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_container_init
-    - action: keep_if_equal
-      source_labels:
-        - __meta_kubernetes_pod_annotation_prometheus_io_port
-        - __meta_kubernetes_pod_container_port_number
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_annotation_prometheus_io_scrape
-    - action: replace
-      regex: (.+)
-      source_labels:
-        - __meta_kubernetes_pod_annotation_prometheus_io_path
-      target_label: __metrics_path__
-    - action: replace
-      regex: ([^:]+)(?::\d+)?;(\d+)
-      replacement: $1:$2
-      source_labels:
-        - __address__
-        - __meta_kubernetes_pod_annotation_prometheus_io_port
-      target_label: __address__
-    - action: labelmap
-      regex: __meta_kubernetes_pod_label_(.+)
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_pod_name
-      target_label: pod
-
-

Scrape targets

-
server.scrape.config.scrape_configs[4]object
-job_name: kubernetes-service-endpoints
-kubernetes_sd_configs:
-    - role: endpoints
-relabel_configs:
-    - action: drop
-      regex: true
-      source_labels:
-        - __meta_kubernetes_pod_container_init
-    - action: keep_if_equal
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-        - __meta_kubernetes_pod_container_port_number
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scrape
-    - action: replace
-      regex: (https?)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_scheme
-      target_label: __scheme__
-    - action: replace
-      regex: (.+)
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_path
-      target_label: __metrics_path__
-    - action: replace
-      regex: ([^:]+)(?::\d+)?;(\d+)
-      replacement: $1:$2
-      source_labels:
-        - __address__
-        - __meta_kubernetes_service_annotation_prometheus_io_port
-      target_label: __address__
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-    - action: replace
-      source_labels:
-        - __meta_kubernetes_pod_node_name
-      target_label: node
-
-

Scrape rule using kubernetes service discovery for endpoints

-
server.scrape.config.scrape_configs[6]object
-job_name: kubernetes-services
-kubernetes_sd_configs:
-    - role: service
-metrics_path: /probe
-params:
-    module:
-        - http_2xx
-relabel_configs:
-    - action: keep
-      regex: true
-      source_labels:
-        - __meta_kubernetes_service_annotation_prometheus_io_probe
-    - source_labels:
-        - __address__
-      target_label: __param_target
-    - replacement: blackbox
-      target_label: __address__
-    - source_labels:
-        - __param_target
-      target_label: instance
-    - action: labelmap
-      regex: __meta_kubernetes_service_label_(.+)
-    - source_labels:
-        - __meta_kubernetes_namespace
-      target_label: namespace
-    - source_labels:
-        - __meta_kubernetes_service_name
-      target_label: service
-
-

Example scrape config for probing services via the Blackbox Exporter. The relabeling allows the actual service scrape endpoint to be configured via the following annotations: * prometheus.io/probe: Only probe services that have a value of true
server.scrape.configMap string
-""
+      
+""
+

Use existing configmap if specified otherwise .config values will be used. Scrape config should reside under scrape.yml key

@@ -1664,8 +1129,9 @@ relabel_configs:
server.scrape.enabled bool
-false
+      
+false
+

If true scrapes targets, creates config map or use specified one with scrape targets

@@ -1674,8 +1140,9 @@ false
server.scrape.extraScrapeConfigs list
-[]
+      
+[]
+

Extra scrape configs that will be appended to server.scrape.config

@@ -1684,8 +1151,9 @@ false
server.securityContext object
-enabled: true
+      
+enabled: true
+

Security context to be added to server pods

@@ -1694,8 +1162,9 @@ enabled: true
server.service.annotations object
-{}
+      
+{}
+

Service annotations

@@ -1704,8 +1173,9 @@ enabled: true
server.service.clusterIP string
-""
+      
+""
+

Service ClusterIP

@@ -1714,54 +1184,64 @@ enabled: true
server.service.externalIPs list
-[]
+      
+[]
+

Service External IPs. Details are here

+

Service external IPs. Details are here
server.service.externalTrafficPolicy string
-""
+      
+""
+

Service external traffic policy. Check here for details

+
server.service.healthCheckNodePort string
-""
+      
+""
+

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

+
server.service.ipFamilies list
-[]
+      
+[]
+

List of service IP families. Check here for details.

+
server.service.ipFamilyPolicy string
-""
+      
+""
+

Service IP family policy. Check here for details.

+
server.service.labels object
-{}
+      
+{}
+

Service labels

@@ -1770,8 +1250,9 @@ enabled: true
server.service.loadBalancerIP string
-""
+      
+""
+

Service load balacner IP

@@ -1780,8 +1261,9 @@ enabled: true
server.service.loadBalancerSourceRanges list
-[]
+      
+[]
+

Load balancer source range

@@ -1790,8 +1272,9 @@ enabled: true
server.service.servicePort int
-8428
+      
+8428
+

Service port

@@ -1800,8 +1283,9 @@ enabled: true
server.service.type string
-ClusterIP
+      
+ClusterIP
+

Service type

@@ -1810,8 +1294,9 @@ ClusterIP
server.serviceMonitor.annotations object
-{}
+      
+{}
+

Service Monitor annotations

@@ -1820,8 +1305,9 @@ ClusterIP
server.serviceMonitor.basicAuth object
-{}
+      
+{}
+

Basic auth params for Service Monitor

@@ -1830,8 +1316,9 @@ ClusterIP
server.serviceMonitor.enabled bool
-false
+      
+false
+

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

@@ -1840,8 +1327,9 @@ false
server.serviceMonitor.extraLabels object
-{}
+      
+{}
+

Service Monitor labels

@@ -1850,8 +1338,9 @@ false
server.serviceMonitor.metricRelabelings list
-[]
+      
+[]
+

Service Monitor metricRelabelings

@@ -1860,8 +1349,9 @@ false
server.serviceMonitor.relabelings list
-[]
+      
+[]
+

Service Monitor relabelings

@@ -1870,8 +1360,9 @@ false
server.statefulSet.enabled bool
-true
+      
+true
+

Creates statefulset instead of deployment, useful when you want to keep the cache

@@ -1880,8 +1371,9 @@ true
server.statefulSet.podManagementPolicy string
-OrderedReady
+      
+OrderedReady
+

Deploy order policy for StatefulSet pods

@@ -1890,8 +1382,9 @@ OrderedReady
server.terminationGracePeriodSeconds int
-60
+      
+60
+

Pod’s termination grace period in seconds

@@ -1900,8 +1393,9 @@ OrderedReady
server.tolerations list
-[]
+      
+[]
+

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

@@ -1910,105 +1404,99 @@ OrderedReady
server.vmbackupmanager.destination string
-""
+      
+""
+

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

+

Backup destination at S3, GCS or local filesystem. Release name will be included to path!
server.vmbackupmanager.disableDaily bool
-false
+      
+false
+

disable daily backups

+

Disable daily backups
server.vmbackupmanager.disableHourly bool
-false
+      
+false
+

disable hourly backups

+

Disable hourly backups
server.vmbackupmanager.disableMonthly bool
-false
+      
+false
+

disable monthly backups

+

Disable monthly backups
server.vmbackupmanager.disableWeekly bool
-false
+      
+false
+

disable weekly backups

+

Disable weekly backups
server.vmbackupmanager.enabled bool
-false
+      
+false
+

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

+

Enable automatic creation of backup via vmbackupmanager. vmbackupmanager is part of Enterprise packages
server.vmbackupmanager.env list
-[]
+      
+[]
+

Additional environment variables (ex.: secret tokens, flags) https://docs.victoriametrics.com/#environment-variables

+

Additional environment variables (ex.: secret tokens, flags). Check here
server.vmbackupmanager.extraArgs."envflag.enable"string
-"true"
+
server.vmbackupmanager.extraArgsobject
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
+
server.vmbackupmanager.extraArgs."envflag.prefix"string
-VM_
-
+

Extra command line arguments for container of component

server.vmbackupmanager.extraArgs.loggerFormatstring
-json
-
-
server.vmbackupmanager.extraVolumeMounts list
-[]
+      
+[]
+
server.vmbackupmanager.image.registry string
-""
+      
+""
+

vmbackupmanager image registry

+

VMBackupManager image registry
server.vmbackupmanager.image.repository string
-victoriametrics/vmbackupmanager
+      
+victoriametrics/vmbackupmanager
+

vmbackupmanager image repository

+

VMBackupManager image repository
server.vmbackupmanager.image.tag string
-""
+      
+""
+

vmbackupmanager image tag

+

VMBackupManager image tag
server.vmbackupmanager.image.variant string
-""
+      
+""
+
server.vmbackupmanager.probe.liveness.failureThresholdint
-10
+
server.vmbackupmanager.probeobject
+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:
+    httpGet:
+        port: manager-http
+

Readiness & Liveness probes

+
server.vmbackupmanager.probe.liveness.initialDelaySecondsint
-30
+
server.vmbackupmanager.probe.livenessobject
+failureThreshold: 10
+initialDelaySeconds: 30
+periodSeconds: 30
+tcpSocket:
+    port: manager-http
+timeoutSeconds: 5
+

VMBackupManager liveness probe

+
server.vmbackupmanager.probe.liveness.periodSecondsint
-30
+
server.vmbackupmanager.probe.readinessobject
+failureThreshold: 3
+httpGet:
+    port: manager-http
+initialDelaySeconds: 5
+periodSeconds: 15
+timeoutSeconds: 5
+

VMBackupManager readiness probe

+
server.vmbackupmanager.probe.liveness.tcpSocket.portstring
-manager-http
+
server.vmbackupmanager.probe.startupobject
+httpGet:
+    port: manager-http
+
server.vmbackupmanager.probe.liveness.timeoutSecondsint
-5
-
+

VMBackupManager startup probe

server.vmbackupmanager.probe.readiness.failureThresholdint
-3
-
-
server.vmbackupmanager.probe.readiness.httpGet.portstring
-manager-http
-
-
server.vmbackupmanager.probe.readiness.initialDelaySecondsint
-5
-
-
server.vmbackupmanager.probe.readiness.periodSecondsint
-15
-
-
server.vmbackupmanager.probe.readiness.timeoutSecondsint
-5
-
-
server.vmbackupmanager.probe.startup.httpGet.portstring
-manager-http
-
-
server.vmbackupmanager.resources object
-{}
+      
+{}
+

Resource object. Details are here

+
server.vmbackupmanager.restore object
-onStart:
+      
+onStart:
     enabled: false
+

Allows to enable restore options for pod. Read more: https://docs.victoriametrics.com/vmbackupmanager#restore-commands

+

Allows to enable restore options for pod. Read more here
server.vmbackupmanager.retention object
-keepLastDaily: 2
+      
+keepLastDaily: 2
 keepLastHourly: 2
 keepLastMonthly: 2
 keepLastWeekly: 2
+

backups’ retention settings

+

Backups’ retention settings
server.vmbackupmanager.retention.keepLastDaily int
-2
+      
+2
+

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

+

Keep last N daily backups. 0 means delete all existing daily backups. Specify -1 to turn off
server.vmbackupmanager.retention.keepLastHourly int
-2
+      
+2
+

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

+

Keep last N hourly backups. 0 means delete all existing hourly backups. Specify -1 to turn off
server.vmbackupmanager.retention.keepLastMonthly int
-2
+      
+2
+

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

+

Keep last N monthly backups. 0 means delete all existing monthly backups. Specify -1 to turn off
server.vmbackupmanager.retention.keepLastWeekly int
-2
+      
+2
+

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

+

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

+
serviceAccount.annotationsobject
+{}
+
+
+

ServiceAccount annotations
serviceAccount.automountToken bool
-true
+      
+true
+

Mount API token to pod directly

@@ -2237,8 +1721,9 @@ true
serviceAccount.create bool
-true
+      
+true
+

Create service account.

@@ -2247,11 +1732,24 @@ true
serviceAccount.extraLabels object
-{}
+      
+{}
+

ServiceAccount labels

+
serviceAccount.namestring
+null
+
+
+

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

+