From 1931f240b2fe5e57cf6a018591c9032cc8915753 Mon Sep 17 00:00:00 2001 From: Andrii Chubatiuk Date: Sun, 22 Sep 2024 22:21:09 +0300 Subject: [PATCH] added more docs --- charts/victoria-metrics-agent/README.md | 9 +- charts/victoria-metrics-agent/values.yaml | 5 +- charts/victoria-metrics-alert/README.md | 94 +-- charts/victoria-metrics-alert/values.yaml | 27 +- charts/victoria-metrics-anomaly/README.md | 27 +- charts/victoria-metrics-anomaly/values.yaml | 9 + charts/victoria-metrics-auth/README.md | 9 +- charts/victoria-metrics-auth/values.yaml | 4 +- charts/victoria-metrics-cluster/README.md | 66 +- charts/victoria-metrics-cluster/values.yaml | 35 +- charts/victoria-metrics-distributed/README.md | 464 ++++++++++---- .../victoria-metrics-distributed/values.yaml | 42 +- charts/victoria-metrics-gateway/README.md | 12 +- charts/victoria-metrics-gateway/values.yaml | 5 +- charts/victoria-metrics-k8s-stack/README.md | 579 ++++++++++++------ charts/victoria-metrics-k8s-stack/values.yaml | 176 ++++-- 16 files changed, 1094 insertions(+), 469 deletions(-) diff --git a/charts/victoria-metrics-agent/README.md b/charts/victoria-metrics-agent/README.md index a42dd8590..3d71e22f1 100644 --- a/charts/victoria-metrics-agent/README.md +++ b/charts/victoria-metrics-agent/README.md @@ -576,7 +576,8 @@ loggerFormat: json - +

Overrides the fullname prefix

+ global.compatibility @@ -891,7 +892,8 @@ name: "" - +

Destination multitenant endpoint for scraped/received metrics

+ nameOverride @@ -901,7 +903,8 @@ name: "" - +

Overrides fullname suffix

+ nodeSelector diff --git a/charts/victoria-metrics-agent/values.yaml b/charts/victoria-metrics-agent/values.yaml index d1af58914..d4943133b 100644 --- a/charts/victoria-metrics-agent/values.yaml +++ b/charts/victoria-metrics-agent/values.yaml @@ -53,7 +53,10 @@ image: # -- Image pull secrets imagePullSecrets: [] +# -- Overrides fullname suffix nameOverride: "" + +# -- Overrides the fullname prefix fullnameOverride: "" # -- Container working directory @@ -94,8 +97,8 @@ remoteWriteUrls: [] # - http://vm-insert:8480/insert/0/prometheus # - http://prometheus:8480/insert/0/prometheus +# -- Destination multitenant endpoint for scraped/received metrics multiTenantUrls: [] -# multiTenantUrls: # - http://vm-insert-az1:8480 # - http://vm-insert-az2:8480 diff --git a/charts/victoria-metrics-alert/README.md b/charts/victoria-metrics-alert/README.md index 29cf3b611..339848074 100644 --- a/charts/victoria-metrics-alert/README.md +++ b/charts/victoria-metrics-alert/README.md @@ -195,7 +195,8 @@ route: - +

Empty dir configuration if persistence is disabled for Alertmanager

+ alertmanager.enabled @@ -205,7 +206,8 @@ route: - +

Create alertmanager resources

+ alertmanager.envFrom @@ -226,7 +228,8 @@ route: - +

Extra command line arguments for container of component

+ alertmanager.extraContainers @@ -392,7 +395,8 @@ tag: v0.25.0 - +

Alertmanager listen address

+ alertmanager.nodeSelector @@ -402,7 +406,8 @@ tag: v0.25.0 - +

Pod’s node selector. Details are here

+ alertmanager.persistentVolume.accessModes @@ -493,24 +498,16 @@ tag: v0.25.0 - alertmanager.podMetadata.annotations + alertmanager.podMetadata object 
-{}
+annotations: {}
+labels: {}
- - - - alertmanager.podMetadata.labels - object - 
-{}
-
-
+

Alertmanager Pod metadata

- alertmanager.podSecurityContext @@ -531,7 +528,8 @@ tag: v0.25.0 - +

Name of Priority Class

+ alertmanager.probe.liveness @@ -591,7 +589,8 @@ tag: v0.25.0 - +

Alertmanager retention

+ alertmanager.securityContext @@ -744,7 +743,8 @@ tag: v0.25.0 - +

Alertmanager extra templates

+ alertmanager.tolerations @@ -913,7 +913,8 @@ name: "" - +

Pod affinity

+ server.annotations @@ -927,14 +928,16 @@ name: "" - server.config.alerts.groups - list + server.config + object 
-[]
+alerts:
+    groups: []
- +

VMAlert configuration

+ server.configMap @@ -944,7 +947,7 @@ name: "" -

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

@@ -1006,7 +1009,8 @@ username: "" - +

Create vmalert component

+ server.env @@ -1095,7 +1099,8 @@ loggerFormat: json - +

Full name prefix override

+ server.image @@ -1241,7 +1246,8 @@ variant: "" - +

Override fullname suffix

+ server.nameOverride @@ -1251,7 +1257,8 @@ variant: "" - +

Full name suffix override

+ server.nodeSelector @@ -1261,7 +1268,8 @@ variant: "" - +

Pod’s node selector. Details are here

+ server.notifier @@ -1357,7 +1365,8 @@ labels: {} - +

Pod’s additional labels

+ server.podSecurityContext @@ -1378,7 +1387,8 @@ labels: {} - +

Name of Priority Class

+ server.probe.liveness @@ -1431,6 +1441,18 @@ username: ""

Basic auth for remote read

+ + + + server.remote.read.bearer + object + 
+token: ""
+tokenFile: ""
+
+
+ +

Auth based on Bearer token for remote read

@@ -1463,7 +1485,8 @@ username: "" - +

VMAlert remote read URL

+ server.remote.write.basicAuth @@ -1519,7 +1542,8 @@ tokenFile: "" - +

VMAlert remote write URL

+ server.replicaCount diff --git a/charts/victoria-metrics-alert/values.yaml b/charts/victoria-metrics-alert/values.yaml index 834502445..7c6e3eefa 100644 --- a/charts/victoria-metrics-alert/values.yaml +++ b/charts/victoria-metrics-alert/values.yaml @@ -37,7 +37,9 @@ rbac: annotations: {} server: + # -- Override fullname suffix name: server + # -- Create vmalert component enabled: true # -- VMAlert image configuration image: @@ -48,7 +50,9 @@ server: # e.g. enterprise, scratch variant: "" pullPolicy: IfNotPresent + # -- Full name suffix override nameOverride: "" + # -- Full name prefix override fullnameOverride: "" # -- Image pull secrets imagePullSecrets: [] @@ -124,6 +128,7 @@ server: remote: write: + # -- VMAlert remote write URL url: "" # -- Basic auth for remote write basicAuth: @@ -136,12 +141,13 @@ server: # -- Token Auth file with Bearer token. You can use one of token or tokenFile tokenFile: "" read: + # -- VMAlert remote read URL url: "" # -- Basic auth for remote read basicAuth: username: "" password: "" - # -- Auth based on Bearer token for remote read + # -- Auth based on Bearer token for remote read bearer: # -- Token with Bearer token. You can use one of token or tokenFile. You don't need to add "Bearer" prefix string token: "" @@ -304,21 +310,25 @@ server: # -- Annotations to be added to pod podAnnotations: {} + # -- Pod's additional labels podLabels: {} + # -- Pod's node selector. Details are [here](https://kubernetes.io/docs/user-guide/node-selection/) nodeSelector: {} + # -- Name of Priority Class priorityClassName: "" # -- Node tolerations for server scheduling to nodes with taints. Details are [here](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) tolerations: [] + # -- Pod affinity affinity: {} - # -- 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 configMap: "" + # -- VMAlert configuration config: alerts: groups: [] @@ -368,7 +378,9 @@ serviceMonitor: # insecureSkipVerify: true alertmanager: + # -- Create alertmanager resources enabled: false + # -- Alertmanager Pod metadata podMetadata: labels: {} annotations: {} @@ -377,8 +389,11 @@ alertmanager: registry: "" repository: prom/alertmanager tag: v0.25.0 + # -- Alertmanager retention retention: 120h + # -- Pod's node selector. Details are [here](https://kubernetes.io/docs/user-guide/node-selection/) nodeSelector: {} + # -- Name of Priority Class priorityClassName: "" # -- Resource object. Details are [here](http://kubernetes.io/docs/user-guide/compute-resources/) resources: {} @@ -410,7 +425,9 @@ alertmanager: # -- Security context to be added to server pods securityContext: enabled: false + # -- Alertmanager listen address listenAddress: "0.0.0.0:9093" + # -- Extra command line arguments for container of component extraArgs: {} # -- Specify alternative source for env variables envFrom: [] @@ -438,6 +455,7 @@ alertmanager: repeat_interval: 24h receivers: - name: devnull + # -- Alertmanager extra templates templates: {} # alertmanager.tmpl: |- service: @@ -497,6 +515,7 @@ alertmanager: # -- Ingress path type pathType: Prefix + # -- Empty dir configuration if persistence is disabled for Alertmanager emptyDir: {} persistentVolume: # -- Create/use Persistent Volume Claim for alertmanager component. Empty dir if false diff --git a/charts/victoria-metrics-anomaly/README.md b/charts/victoria-metrics-anomaly/README.md index da4abe45b..6fd6a3512 100644 --- a/charts/victoria-metrics-anomaly/README.md +++ b/charts/victoria-metrics-anomaly/README.md @@ -352,7 +352,8 @@ tenant_id: "" - +

Container working directory

+ emptyDir @@ -362,7 +363,8 @@ tenant_id: "" - +

Empty dir configuration when persistence is disabled

+ env @@ -394,7 +396,8 @@ tenant_id: "" - +

Extra command line arguments for container of component

+ extraContainers @@ -404,7 +407,8 @@ tenant_id: "" - +

Extra containers to run in a pod with anomaly container

+ extraHostPathMounts @@ -447,7 +451,8 @@ tenant_id: "" - +

Full name prefix override

+ global.compatibility @@ -605,7 +610,8 @@ name: "" - +

Full name suffix override

+ nodeSelector @@ -745,7 +751,8 @@ minAvailable: 1 - +

PodMonitor annotations

+ podMonitor.enabled @@ -755,7 +762,8 @@ minAvailable: 1 - +

Enable PodMonitor

+ podMonitor.extraLabels @@ -765,7 +773,8 @@ minAvailable: 1 - +

PodMonitor labels

+ podSecurityContext diff --git a/charts/victoria-metrics-anomaly/values.yaml b/charts/victoria-metrics-anomaly/values.yaml index cb2fa7d5f..b105e3149 100644 --- a/charts/victoria-metrics-anomaly/values.yaml +++ b/charts/victoria-metrics-anomaly/values.yaml @@ -24,9 +24,12 @@ image: # -- Image pull secrets imagePullSecrets: [] +# -- Full name suffix override nameOverride: "" +# -- Full name prefix override fullnameOverride: "" +# -- Container working directory containerWorkingDir: "/vmanomaly" serviceAccount: @@ -43,6 +46,7 @@ podDisruptionBudget: minAvailable: 1 labels: {} +# -- Extra command line arguments for container of component extraArgs: {} # -- Additional environment variables (ex.: secret tokens, flags) @@ -73,6 +77,7 @@ extraVolumeMounts: [] # - name: example # mountPath: /example +# -- Extra containers to run in a pod with anomaly container extraContainers: [] # - name: config-reloader # image: reloader-image @@ -121,8 +126,11 @@ tolerations: [] affinity: {} podMonitor: + # -- Enable PodMonitor enabled: false + # -- PodMonitor labels extraLabels: {} + # -- PodMonitor annotations annotations: {} # -- Full [vmanomaly config section](https://docs.victoriametrics.com/anomaly-detection/components/) @@ -168,6 +176,7 @@ config: # -- For VictoriaMetrics Cluster version only, tenants are identified by accountID or accountID:projectID. See VictoriaMetrics Cluster multitenancy docs tenant_id: "" +# -- Empty dir configuration when persistence is disabled emptyDir: {} # -- Persistence to store models on disk. # Available starting from v1.13.0 diff --git a/charts/victoria-metrics-auth/README.md b/charts/victoria-metrics-auth/README.md index 3792ca4b6..844662692 100644 --- a/charts/victoria-metrics-auth/README.md +++ b/charts/victoria-metrics-auth/README.md @@ -278,7 +278,8 @@ loggerFormat: json - +

Full name prefix override

+ global.compatibility @@ -366,7 +367,8 @@ loggerFormat: json - +

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

+ imagePullSecrets @@ -600,7 +602,8 @@ name: "" - +

Full name suffix override

+ nodeSelector diff --git a/charts/victoria-metrics-auth/values.yaml b/charts/victoria-metrics-auth/values.yaml index 36f9ae2d2..1a07c171b 100644 --- a/charts/victoria-metrics-auth/values.yaml +++ b/charts/victoria-metrics-auth/values.yaml @@ -22,7 +22,7 @@ image: repository: victoriametrics/vmauth # -- Tag of Docker image tag: "" # rewrites Chart.AppVersion - # Variant of the image to use. + # -- Variant of the image to use. # e.g. enterprise, scratch variant: "" # -- Pull policy of Docker image @@ -30,7 +30,9 @@ image: # -- Image pull secrets imagePullSecrets: [] +# -- Full name suffix override nameOverride: "" +# -- Full name prefix override fullnameOverride: "" containerWorkingDir: "/" diff --git a/charts/victoria-metrics-cluster/README.md b/charts/victoria-metrics-cluster/README.md index cc9312173..3e1dedbb2 100644 --- a/charts/victoria-metrics-cluster/README.md +++ b/charts/victoria-metrics-cluster/README.md @@ -265,7 +265,8 @@ name: "" - +

Print information after deployment

+ rbac.annotations @@ -385,7 +386,8 @@ name: "" - +

StatefulSet/Deployment annotations

+ vminsert.containerWorkingDir @@ -474,7 +476,8 @@ loggerFormat: json - +

Extra Volume Mounts for the container

+ vminsert.extraVolumes @@ -484,7 +487,8 @@ loggerFormat: json - +

Extra Volumes for the pod

+ vminsert.fullnameOverride @@ -604,7 +608,8 @@ loggerFormat: json - +

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

+ vminsert.ingress.annotations @@ -769,7 +774,8 @@ labels: {} - +

VMInsert http port name

+ vminsert.priorityClassName @@ -1041,7 +1047,7 @@ timeoutSeconds: 5 -

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

+

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

@@ -1129,7 +1135,8 @@ timeoutSeconds: 5 - +

VMInsert strategy

+ vminsert.suppressStorageFQDNsRender @@ -1183,7 +1190,8 @@ timeoutSeconds: 5 - +

StatefulSet/Deployment annotations

+ vmselect.cacheMountPath @@ -1215,7 +1223,8 @@ timeoutSeconds: 5 - +

Empty dir configuration if persistence is disabled

+ vmselect.enabled @@ -1436,7 +1445,8 @@ loggerFormat: json - +

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

+ vmselect.ingress.annotations @@ -1689,7 +1699,8 @@ labels: {} - +

VMSelect http port name

+ vmselect.priorityClassName @@ -2060,7 +2071,8 @@ timeoutSeconds: 5 - +

VMSelect strategy

+ vmselect.suppressStorageFQDNsRender @@ -2136,7 +2148,7 @@ timeoutSeconds: 5 -

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

+

Empty dir configuration if persistence is disabled

@@ -2226,7 +2238,8 @@ loggerFormat: json - +

Extra secret mounts for vmstorage

+ vmstorage.extraVolumeMounts @@ -2313,7 +2326,8 @@ loggerFormat: json - +

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

+ vmstorage.initContainers @@ -2521,7 +2535,8 @@ labels: {} - +

VMStorage http port name

+ vmstorage.priorityClassName @@ -2629,6 +2644,17 @@ timeoutSeconds: 5

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

+ + + + vmstorage.schedulerName + string + 
+""
+
+
+ +

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

@@ -2960,7 +2986,8 @@ loggerFormat: json - +

Extra secret mounts for vmbackupmanager

+ vmstorage.vmbackupmanager.image.registry @@ -3003,7 +3030,8 @@ loggerFormat: json - +

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

+ vmstorage.vmbackupmanager.probe diff --git a/charts/victoria-metrics-cluster/values.yaml b/charts/victoria-metrics-cluster/values.yaml index d7c01a648..be831c446 100644 --- a/charts/victoria-metrics-cluster/values.yaml +++ b/charts/victoria-metrics-cluster/values.yaml @@ -14,6 +14,7 @@ global: # -- K8s cluster domain suffix, uses for building storage pods' FQDN. Details are [here](https://kubernetes.io/docs/tasks/administer-cluster/dns-custom-nameservers/) clusterDomainSuffix: cluster.local +# -- Print information after deployment printNotes: true rbac: @@ -62,6 +63,7 @@ vmselect: enabled: true # -- VMSelect container name name: vmselect + # -- VMSelect strategy strategy: {} # rollingUpdate: # maxSurge: 25% @@ -77,10 +79,11 @@ vmselect: tag: "" # -- Image pull policy pullPolicy: IfNotPresent - # Variant of the image to use. + # -- Variant of the image to use. # e.g. cluster, enterprise-cluster variant: cluster ports: + # -- VMSelect http port name name: "http" # -- Name of Priority Class priorityClassName: "" @@ -93,6 +96,7 @@ vmselect: envflag.enable: true envflag.prefix: VM_ loggerFormat: json + # -- StatefulSet/Deployment annotations annotations: {} # -- StatefulSet/Deployment additional labels extraLabels: {} @@ -279,6 +283,8 @@ vmselect: enabled: false # -- Deploy order policy for StatefulSet pods podManagementPolicy: OrderedReady + + # -- Empty dir configuration if persistence is disabled emptyDir: {} persistentVolume: # -- Create/use Persistent Volume Claim for vmselect component. Empty dir if false. If true, vmselect will create/use a Persistent Volume Claim @@ -330,6 +336,7 @@ vminsert: enabled: true # -- VMInsert container name name: vminsert + # -- VMInsert strategy strategy: {} # rollingUpdate: # maxSurge: 25% @@ -343,12 +350,13 @@ vminsert: # -- Image tag # override Chart.AppVersion tag: "" - # Variant of the image to use. + # -- Variant of the image to use. # e.g. cluster, enterprise-cluster variant: cluster # -- Image pull policy pullPolicy: IfNotPresent - ports: + ports: + # -- VMInsert http port name name: "http" # -- Name of Priority Class priorityClassName: "" @@ -359,6 +367,7 @@ vminsert: envflag.enable: "true" envflag.prefix: VM_ loggerFormat: json + # -- StatefulSet/Deployment annotations annotations: {} # -- StatefulSet/Deployment additional labels extraLabels: {} @@ -408,14 +417,14 @@ vminsert: # -- Behavior settings for scaling by the HPA behavior: {} - # Extra Volumes for the pod + # -- Extra Volumes for the pod extraVolumes: [] # - name: example # configMap: # name: example - # Extra Volume Mounts for the container + # -- Extra Volume Mounts for the container extraVolumeMounts: [] # - name: example @@ -494,8 +503,8 @@ vminsert: targetPort: http # -- Service type type: ClusterIP - # -- 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](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/) for details + # -- 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](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/) for details udp: false # -- Health check node port for a service. Check [here](https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip) for details healthCheckNodePort: "" @@ -576,12 +585,13 @@ vmstorage: # -- Image tag # override Chart.AppVersion tag: "" - # Variant of the image to use. + # -- Variant of the image to use. # e.g. cluster, enterprise-cluster variant: cluster # -- Image pull policy pullPolicy: IfNotPresent ports: + # -- VMStorage http port name name: "http" # -- Name of Priority Class priorityClassName: "" @@ -631,7 +641,8 @@ vmstorage: [] # - name: config-reloader # image: reloader-image - + + # -- Extra secret mounts for vmstorage extraSecretMounts: [] # - name: secret @@ -681,8 +692,9 @@ vmstorage: # -- Use an alternate scheduler, e.g. "stork". Check [here](https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/) for details # - # schedulerName: + schedulerName: "" + # -- Empty dir configuration if persistence is disabled emptyDir: {} persistentVolume: # -- Create/use Persistent Volume Claim for vmstorage component. Empty dir if false. If true, vmstorage will create/use a Persistent Volume Claim @@ -789,7 +801,7 @@ vmstorage: # -- VMBackupManager image tag # override Chart.AppVersion tag: "" - # Variant of the image tag to use. + # -- Variant of the image tag to use. # e.g. enterprise. variant: cluster # -- Disable hourly backups @@ -845,6 +857,7 @@ vmstorage: failureThreshold: 10 # -- VMBackupManager startup probe startup: {} + # -- Extra secret mounts for vmbackupmanager extraSecretMounts: [] # - name: secret diff --git a/charts/victoria-metrics-distributed/README.md b/charts/victoria-metrics-distributed/README.md index ba474fd79..4bd2c0637 100644 --- a/charts/victoria-metrics-distributed/README.md +++ b/charts/victoria-metrics-distributed/README.md @@ -239,114 +239,6 @@ Change the values according to the need of the environment in ``victoria-metrics Description - - availabilityZones - list - 
-- 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 @@ -378,6 +270,17 @@ Change the values according to the need of the environment in ``victoria-metrics

Extra affinity adds user defined custom affinity rules

+ + + + availabilityZones[0].name + string + 
+zone-eu-1
+
+
+ +

Availability zone name

@@ -419,16 +322,80 @@ spec: {} - availabilityZones[0].vmauthCrossAZQuery + availabilityZones[0].vmagent.annotations object 
-enabled: true
-name: ""
-spec: {}
+{}
+
+
+ +

VMAgent annotations

+ + + + availabilityZones[0].vmagent.name + string + 
+""
+
+
+ +

Override the name of the vmagent object

+ + + + availabilityZones[0].vmagent.spec + object + 
+{}
+
+
+ +

VMAgent spec. More options can be found here

+ + + + availabilityZones[0].vmauthCrossAZQuery.enabled + bool + 
+true
+
+
+ +

Create a vmauth with all the zone with allowQuery: true as query backends

+ + + + availabilityZones[0].vmauthCrossAZQuery.name + string + 
+""
+
+
+ +

Override the name of the vmauth object

+ + + + availabilityZones[0].vmauthCrossAZQuery.spec + object + 
+{}
+
+
+ +

VMAuth spec. More options can be found here

+ + + + availabilityZones[0].vmauthIngest.enabled + bool + 
+true
-

Set up a vmauth with all the zone with allowQuery: true as query backends

+

Create vmauth as a local write endpoint

@@ -442,6 +409,62 @@ spec: {}

Override the name of the vmauth object

+ + availabilityZones[0].vmauthIngest.spec + object + 
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+ +

VMAuth spec. More options can be found here

+ + + + availabilityZones[0].vmauthQueryPerZone.enabled + bool + 
+true
+
+
+ +

Create vmauth as a local read endpoint

+ + + + availabilityZones[0].vmauthQueryPerZone.name + string + 
+""
+
+
+ +

Override the name of the vmauth object

+ + + + availabilityZones[0].vmauthQueryPerZone.spec + object + 
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+ +

VMAuth spec. More options can be found here

+ + + + availabilityZones[0].vmcluster.enabled + bool + 
+true
+
+
+ + + availabilityZones[0].vmcluster.name string @@ -508,6 +531,17 @@ vmstorage:

Extra affinity adds user defined custom affinity rules

+ + + + availabilityZones[1].name + string + 
+zone-us-1
+
+
+ +

Availability zone name

@@ -548,6 +582,150 @@ spec: {}

VMAgent only meant to proxy write requests to each az, doesn’t support customized remote write address

+ + availabilityZones[1].vmagent.annotations + object + 
+{}
+
+
+ +

VMAgent annotations

+ + + + availabilityZones[1].vmagent.name + string + 
+""
+
+
+ +

Override the name of the vmagent object

+ + + + availabilityZones[1].vmagent.spec + object + 
+{}
+
+
+ +

VMAgent spec. More options can be found here

+ + + + availabilityZones[1].vmauthCrossAZQuery.enabled + bool + 
+true
+
+
+ +

Create a vmauth with all the zone with allowQuery: true as query backends

+ + + + availabilityZones[1].vmauthCrossAZQuery.name + string + 
+""
+
+
+ +

Override the name of the vmauth object

+ + + + availabilityZones[1].vmauthCrossAZQuery.spec + object + 
+{}
+
+
+ +

VMAuth spec. More options can be found here

+ + + + availabilityZones[1].vmauthIngest.enabled + bool + 
+true
+
+
+ +

Create vmauth as a local write endpoint

+ + + + availabilityZones[1].vmauthIngest.name + string + 
+""
+
+
+ +

Override the name of the vmauth object

+ + + + availabilityZones[1].vmauthIngest.spec + object + 
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+ +

VMAuth spec. More options can be found here

+ + + + availabilityZones[1].vmauthQueryPerZone.enabled + bool + 
+true
+
+
+ +

Create vmauth as a local read endpoint

+ + + + availabilityZones[1].vmauthQueryPerZone.name + string + 
+""
+
+
+ +

Override the name of the vmauth object

+ + + + availabilityZones[1].vmauthQueryPerZone.spec + object + 
+extraArgs:
+    discoverBackendIPs: "true"
+
+
+ +

VMAuth spec. More options can be found here

+ + + + availabilityZones[1].vmcluster.enabled + bool + 
+true
+
+
+ + + availabilityZones[1].vmcluster.name string @@ -661,29 +839,69 @@ vmsingle: - vmauthIngestGlobal + vmauthIngestGlobal.enabled + bool + 
+true
+
+
+ +

Create a vmauth as the global write entrypoint

+ + + + vmauthIngestGlobal.name + string + 
+""
+
+
+ +

Override the name of the vmauth object

+ + + + vmauthIngestGlobal.spec object 
-enabled: true
-name: ""
-spec: {}
+{}
-

Set up a vmauth as the global write entrypoint

+

VMAuth spec. More options can be found here

- vmauthQueryGlobal + vmauthQueryGlobal.enabled + bool + 
+true
+
+
+ +

Create vmauth as the global read entrypoint

+ + + + vmauthQueryGlobal.name + string + 
+""
+
+
+ +

Override the name of the vmauth object

+ + + + vmauthQueryGlobal.spec object 
-enabled: true
-name: ""
-spec: {}
+{}
-

Set up a vmauth as the global read entrypoint

+

VMAuth spec. More options can be found here

diff --git a/charts/victoria-metrics-distributed/values.yaml b/charts/victoria-metrics-distributed/values.yaml index ec7ab0a81..5d032974e 100644 --- a/charts/victoria-metrics-distributed/values.yaml +++ b/charts/victoria-metrics-distributed/values.yaml @@ -4,21 +4,27 @@ nameOverride: "vm-distributed" # -- Overrides the chart's computed fullname. fullnameOverride: "" -# -- Set up a vmauth as the global write entrypoint vmauthIngestGlobal: + # -- Create a vmauth as the global write entrypoint enabled: true + # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: {} -# -- Set up a vmauth as the global read entrypoint vmauthQueryGlobal: + # -- Create vmauth as the global read entrypoint enabled: true + # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: {} -# -- Config per availability zone components, including vmagent, vmcluster, vmauth etc +# Config per availability zone components, including vmagent, vmcluster, vmauth etc availabilityZones: - - name: zone-eu-1 + - + # -- Availability zone name + name: zone-eu-1 # -- Allow data ingestion to this zone allowIngest: true # -- Allow data query from this zone through global query endpoint @@ -43,9 +49,11 @@ availabilityZones: topologyKey: kubernetes.io/hostname whenUnsatisfiable: ScheduleAnyway vmauthIngest: + # -- Create vmauth as a local write endpoint enabled: true # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: extraArgs: # vmauth discovers backend IPs via periodic DNS queries, @@ -53,22 +61,30 @@ availabilityZones: # check https://docs.victoriametrics.com/vmauth/#discovering-backend-ips discoverBackendIPs: "true" vmauthQueryPerZone: + # -- Create vmauth as a local read endpoint enabled: true + # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: extraArgs: discoverBackendIPs: "true" - # -- Set up a vmauth with all the zone with `allowQuery: true` as query backends vmauthCrossAZQuery: + # -- Create a vmauth with all the zone with `allowQuery: true` as query backends enabled: true + # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: {} # -- VMAgent here only meant to proxy write requests to each az, # doesn't support customized other remote write address. vmagent: enabled: true + # -- Override the name of the vmagent object name: "" + # -- VMAgent annotations annotations: {} + # -- VMAgent spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmagentspec) spec: {} vmcluster: enabled: true @@ -93,7 +109,9 @@ availabilityZones: resources: {} - - name: zone-us-1 + - + # -- Availability zone name + name: zone-us-1 # -- Allow data ingestion to this zone allowIngest: true # -- Allow data query from this zone through global query endpoint @@ -118,8 +136,11 @@ availabilityZones: topologyKey: kubernetes.io/hostname whenUnsatisfiable: ScheduleAnyway vmauthIngest: + # -- Create vmauth as a local write endpoint enabled: true + # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: extraArgs: # vmauth discovers backend IPs via periodic DNS queries, @@ -127,21 +148,30 @@ availabilityZones: # check https://docs.victoriametrics.com/vmauth/#discovering-backend-ips discoverBackendIPs: "true" vmauthQueryPerZone: + # -- Create vmauth as a local read endpoint enabled: true + # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: extraArgs: discoverBackendIPs: "true" vmauthCrossAZQuery: + # -- Create a vmauth with all the zone with `allowQuery: true` as query backends enabled: true + # -- Override the name of the vmauth object name: "" + # -- VMAuth spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmauthspec) spec: {} # -- VMAgent only meant to proxy write requests to each az, # doesn't support customized remote write address vmagent: enabled: true + # -- Override the name of the vmagent object name: "" + # -- VMAgent annotations annotations: {} + # -- VMAgent spec. More options can be found [here](https://docs.victoriametrics.com/operator/api/#vmagentspec) spec: {} vmcluster: enabled: true diff --git a/charts/victoria-metrics-gateway/README.md b/charts/victoria-metrics-gateway/README.md index c2e1f8af8..76b5a4863 100644 --- a/charts/victoria-metrics-gateway/README.md +++ b/charts/victoria-metrics-gateway/README.md @@ -267,7 +267,8 @@ Change the values according to the need of the environment in ``victoria-metrics - +

Container working directory

+ env @@ -356,7 +357,8 @@ loggerFormat: json - +

Full name prefix

+ global.compatibility @@ -444,7 +446,8 @@ loggerFormat: json - +

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

+ imagePullSecrets @@ -601,7 +604,8 @@ name: "" - +

Full name suffix

+ nodeSelector diff --git a/charts/victoria-metrics-gateway/values.yaml b/charts/victoria-metrics-gateway/values.yaml index 3e5252561..3b4f252ee 100644 --- a/charts/victoria-metrics-gateway/values.yaml +++ b/charts/victoria-metrics-gateway/values.yaml @@ -23,7 +23,7 @@ image: # -- Tag of Docker image # override Chart.AppVersion tag: "" - # Variant of the image to use. + # -- Variant of the image to use. # e.g. enterprise, enterprise-scratch variant: "" # -- Pull policy of Docker image @@ -31,9 +31,12 @@ image: # -- Image pull secrets imagePullSecrets: [] +# -- Full name suffix nameOverride: "" +# -- Full name prefix fullnameOverride: "" +# -- Container working directory containerWorkingDir: "/" serviceAccount: diff --git a/charts/victoria-metrics-k8s-stack/README.md b/charts/victoria-metrics-k8s-stack/README.md index a15e4b1c7..a501c5670 100644 --- a/charts/victoria-metrics-k8s-stack/README.md +++ b/charts/victoria-metrics-k8s-stack/README.md @@ -415,7 +415,8 @@ Change the values according to the need of the environment in ``victoria-metrics - +

Alertmanager annotations

+ alertmanager.config @@ -441,7 +442,8 @@ templates: - +

Create VMAlertmanager CR

+ alertmanager.ingress @@ -474,14 +476,15 @@ tls: [] - alertmanager.monzoTemplate.enabled - bool - 
-true
+      alertmanager.monzoTemplate
+      object
+      
+enabled: true
 
 

 
-      
+      
Better alert templates for slack source

+
     
     
       alertmanager.spec
@@ -530,7 +533,7 @@ selectAllByDefault: true
-

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’

@@ -541,7 +544,8 @@ selectAllByDefault: true - +

Enabled CoreDNS metrics scraping

+ coreDns.service.enabled @@ -551,7 +555,8 @@ selectAllByDefault: true - +

Create service for CoreDNS metrics

+ coreDns.service.port @@ -561,17 +566,19 @@ selectAllByDefault: true - +

CoreDNS service port

+ - coreDns.service.selector.k8s-app - string - 
-kube-dns
+      coreDns.service.selector
+      object
+      
+k8s-app: kube-dns
 
 

 
-      
+      
CoreDNS service pod selector

+
     
     
       coreDns.service.targetPort
@@ -581,7 +588,8 @@ selectAllByDefault: true
- +

CoreDNS service target port

+ coreDns.vmScrape @@ -852,6 +860,123 @@ runbookUrl: https://runbooks.prometheus-operator.dev/runbooks

Optional HTTP URL parameters added to each rule request

+ + + + defaultRules.groups + object + 
+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

@@ -980,24 +1105,18 @@ runbookUrl: https://runbooks.prometheus-operator.dev/runbooks - externalVM.read.url - string - 
-""
+      externalVM
+      object
+      
+read:
+    url: ""
+write:
+    url: ""
 
 

 
-      
-    
-    
-      externalVM.write.url
-      string
-      
-""
-
-

+      
External VM read and write URLs

 
-      
     
     
       extraObjects
@@ -1018,7 +1137,8 @@ runbookUrl: https://runbooks.prometheus-operator.dev/runbooks
- +

Resource full name prefix override

+ global.clusterLabel @@ -1028,27 +1148,20 @@ runbookUrl: https://runbooks.prometheus-operator.dev/runbooks - - - - global.license.key - string - 
-""
-
-
+

Cluster label to use for dashboards and rules

- - global.license.keyRef + global.license object 
-{}
+key: ""
+keyRef: {}
- +

Global license configuration

+ grafana @@ -1255,7 +1368,8 @@ spec: - +

Enable Kube Api Server metrics scraping

+ kubeApiServer.vmScrape @@ -1291,7 +1405,8 @@ spec: - +

Enable kube controller manager metrics scraping

+ kubeControllerManager.endpoints @@ -1301,7 +1416,8 @@ spec: - +

If your kube controller manager is not deployed as a pod, specify IPs it can be found on

+ kubeControllerManager.service.enabled @@ -1311,7 +1427,8 @@ spec: - +

Create service for kube controller manager metrics scraping

+ kubeControllerManager.service.port @@ -1321,17 +1438,19 @@ spec: - +

Kube controller manager service port

+ - kubeControllerManager.service.selector.component - string - 
-kube-controller-manager
+      kubeControllerManager.service.selector
+      object
+      
+component: kube-controller-manager
 
 

 
-      
+      
Kube controller manager service pod selector

+
     
     
       kubeControllerManager.service.targetPort
@@ -1341,7 +1460,8 @@ spec:
- +

Kube controller manager service target port

+ kubeControllerManager.vmScrape @@ -1373,7 +1493,8 @@ spec: - +

Enabled KubeDNS metrics scraping

+ kubeDns.service.enabled @@ -1383,57 +1504,35 @@ spec: - - - - kubeDns.service.ports.dnsmasq.port - int - 
-10054
-
-
+

Create Service for KubeDNS metrics

- - kubeDns.service.ports.dnsmasq.targetPort - int - 
-10054
+      kubeDns.service.ports
+      object
+      
+dnsmasq:
+    port: 10054
+    targetPort: 10054
+skydns:
+    port: 10055
+    targetPort: 10055
 
 

 
-      
-    
-    
-      kubeDns.service.ports.skydns.port
-      int
-      
-10055
-
-

+      
KubeDNS service ports

 
-      
     
     
-      kubeDns.service.ports.skydns.targetPort
-      int
-      
-10055
+      kubeDns.service.selector
+      object
+      
+k8s-app: kube-dns
 
 

 
-      
-    
-    
-      kubeDns.service.selector.k8s-app
-      string
-      
-kube-dns
-
-

+      
KubeDNS service pods selector

 
-      
     
     
       kubeDns.vmScrape
@@ -1463,7 +1562,8 @@ spec:
 
 

 
-      
+      
Enabled KubeETCD metrics scraping

+
     
     
       kubeEtcd.endpoints
@@ -1473,7 +1573,8 @@ spec:
- +

If your etcd is not deployed as a pod, specify IPs it can be found on

+ kubeEtcd.service.enabled @@ -1483,7 +1584,8 @@ spec: - +

Enable service for ETCD metrics scraping

+ kubeEtcd.service.port @@ -1493,17 +1595,19 @@ spec: - +

ETCD service port

+ - kubeEtcd.service.selector.component - string - 
-etcd
+      kubeEtcd.service.selector
+      object
+      
+component: etcd
 
 

 
-      
+      
ETCD service pods selector

+
     
     
       kubeEtcd.service.targetPort
@@ -1513,7 +1617,8 @@ spec:
- +

ETCD service target port

+ kubeEtcd.vmScrape @@ -1544,7 +1649,8 @@ spec: - +

Enable kube proxy metrics scraping

+ kubeProxy.endpoints @@ -1554,7 +1660,8 @@ spec: - +

If your kube proxy is not deployed as a pod, specify IPs it can be found on

+ kubeProxy.service.enabled @@ -1564,7 +1671,8 @@ spec: - +

Enable service for kube proxy metrics scraping

+ kubeProxy.service.port @@ -1574,17 +1682,19 @@ spec: - +

Kube proxy service port

+ - kubeProxy.service.selector.k8s-app - string - 
-kube-proxy
+      kubeProxy.service.selector
+      object
+      
+k8s-app: kube-proxy
 
 

 
-      
+      
Kube proxy service pod selector

+
     
     
       kubeProxy.service.targetPort
@@ -1594,7 +1704,8 @@ spec:
- +

Kube proxy service target port

+ kubeProxy.vmScrape @@ -1625,7 +1736,8 @@ spec: - +

Enable KubeScheduler metrics scraping

+ kubeScheduler.endpoints @@ -1635,7 +1747,8 @@ spec: - +

If your kube scheduler is not deployed as a pod, specify IPs it can be found on

+ kubeScheduler.service.enabled @@ -1645,7 +1758,8 @@ spec: - +

Enable service for KubeScheduler metrics scrape

+ kubeScheduler.service.port @@ -1655,17 +1769,19 @@ spec: - +

KubeScheduler service port

+ - kubeScheduler.service.selector.component - string - 
-kube-scheduler
+      kubeScheduler.service.selector
+      object
+      
+component: kube-scheduler
 
 

 
-      
+      
KubeScheduler service pod selector

+
     
     
       kubeScheduler.service.targetPort
@@ -1675,7 +1791,8 @@ spec:
- +

KubeScheduler service target port

+ kubeScheduler.vmScrape @@ -1821,7 +1938,8 @@ spec: - +

Resource full name suffix override

+ prometheus-node-exporter @@ -1939,7 +2057,7 @@ selector: -

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

@@ -1950,7 +2068,8 @@ selector: - +

Tenant to use for Grafana datasources and remote write

+ victoria-metrics-operator @@ -1972,31 +2091,6 @@ serviceMonitor:

VictoriaMetrics Operator dependency chart configuration. More values can be found here. Also checkout here possible ENV variables to configure operator behaviour

- - - - victoria-metrics-operator.crd.cleanup - object - 
-enabled: true
-image:
-    pullPolicy: IfNotPresent
-    repository: bitnami/kubectl
-
-
- -

Helm delete hook for VM CR cleanup

- - - - victoria-metrics-operator.crd.create - bool - 
-false
-
-
- -

Disable CRD creation by operator chart as it’s being created in this chart

@@ -2029,7 +2123,8 @@ image: - +

VMAgent annotations

+ vmagent.enabled @@ -2039,7 +2134,8 @@ image: - +

Create VMAgent CR

+ vmagent.ingress @@ -2087,7 +2183,7 @@ selectAllByDefault: true -

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.

+

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.

@@ -2098,7 +2194,8 @@ selectAllByDefault: true - +

VMAlert annotations

+ vmalert.enabled @@ -2108,7 +2205,8 @@ selectAllByDefault: true - +

Create VMAlert CR

+ vmalert.ingress @@ -2148,7 +2246,8 @@ tls: [] - +

Controls whether VMAlert should use VMAgent or VMInsert as a target for remotewrite

+ vmalert.spec @@ -2187,7 +2286,8 @@ selectAllByDefault: true - +

VMAuth annotations

+ vmauth.enabled @@ -2197,7 +2297,8 @@ selectAllByDefault: true - +

Enable VMAuth CR

+ vmauth.spec @@ -2219,7 +2320,8 @@ port: "8427" - +

VMCluster annotations

+ vmcluster.enabled @@ -2229,7 +2331,8 @@ port: "8427" - +

Create VMCluster CR

+ vmcluster.ingress.insert.annotations @@ -2239,7 +2342,8 @@ port: "8427" - +

Ingress annotations

+ vmcluster.ingress.insert.enabled @@ -2249,7 +2353,8 @@ port: "8427" - +

Enable deployment of ingress for server component

+ vmcluster.ingress.insert.extraPaths @@ -2263,14 +2368,26 @@ port: "8427" - vmcluster.ingress.insert.hosts[0] + vmcluster.ingress.insert.hosts + list + 
+[]
+
+
+ +

Array of host objects

+ + + + vmcluster.ingress.insert.ingressClassName string 
-vminsert.domain.com
+""
- +

Ingress controller class name

+ vmcluster.ingress.insert.labels @@ -2280,7 +2397,8 @@ port: "8427" - +

Ingress extra labels

+ vmcluster.ingress.insert.path @@ -2290,7 +2408,8 @@ port: "8427" - +

Ingress default path

+ vmcluster.ingress.insert.pathType @@ -2300,7 +2419,8 @@ port: "8427" - +

Ingress path type

+ vmcluster.ingress.insert.tls @@ -2310,7 +2430,8 @@ port: "8427" - +

Array of TLS objects

+ vmcluster.ingress.select.annotations @@ -2320,7 +2441,8 @@ port: "8427" - +

Ingress annotations

+ vmcluster.ingress.select.enabled @@ -2330,7 +2452,8 @@ port: "8427" - +

Enable deployment of ingress for server component

+ vmcluster.ingress.select.extraPaths @@ -2344,14 +2467,26 @@ port: "8427" - vmcluster.ingress.select.hosts[0] + vmcluster.ingress.select.hosts + list + 
+[]
+
+
+ +

Array of host objects

+ + + + vmcluster.ingress.select.ingressClassName string 
-vmselect.domain.com
+""
- +

Ingress controller class name

+ vmcluster.ingress.select.labels @@ -2361,7 +2496,8 @@ port: "8427" - +

Ingress extra labels

+ vmcluster.ingress.select.path @@ -2371,7 +2507,8 @@ port: "8427" - +

Ingress default path

+ vmcluster.ingress.select.pathType @@ -2381,7 +2518,8 @@ port: "8427" - +

Ingress path type

+ vmcluster.ingress.select.tls @@ -2391,7 +2529,8 @@ port: "8427" - +

Array of TLS objects

+ vmcluster.ingress.storage.annotations @@ -2401,7 +2540,8 @@ port: "8427" - +

Ingress annotations

+ vmcluster.ingress.storage.enabled @@ -2411,7 +2551,8 @@ port: "8427" - +

Enable deployment of ingress for server component

+ vmcluster.ingress.storage.extraPaths @@ -2425,14 +2566,26 @@ port: "8427" - vmcluster.ingress.storage.hosts[0] + vmcluster.ingress.storage.hosts + list + 
+[]
+
+
+ +

Array of host objects

+ + + + vmcluster.ingress.storage.ingressClassName string 
-vmstorage.domain.com
+""
- +

Ingress controller class name

+ vmcluster.ingress.storage.labels @@ -2442,7 +2595,8 @@ port: "8427" - +

Ingress extra labels

+ vmcluster.ingress.storage.path @@ -2452,7 +2606,8 @@ port: "8427" - +

Ingress default path

+ vmcluster.ingress.storage.pathType @@ -2462,7 +2617,8 @@ port: "8427" - +

Ingress path type

+ vmcluster.ingress.storage.tls @@ -2472,7 +2628,8 @@ port: "8427" - +

Array of TLS objects

+ vmcluster.spec @@ -2538,7 +2695,8 @@ vmstorage: - +

VMSingle annotations

+ vmsingle.enabled @@ -2548,7 +2706,8 @@ vmstorage: - +

Create VMSingle CR

+ vmsingle.ingress.annotations @@ -2558,7 +2717,8 @@ vmstorage: - +

Ingress annotations

+ vmsingle.ingress.enabled @@ -2568,7 +2728,8 @@ vmstorage: - +

Enable deployment of ingress for server component

+ vmsingle.ingress.extraPaths @@ -2582,14 +2743,26 @@ vmstorage: - vmsingle.ingress.hosts[0] + vmsingle.ingress.hosts + list + 
+[]
+
+
+ +

Array of host objects

+ + + + vmsingle.ingress.ingressClassName string 
-vmsingle.domain.com
+""
- +

Ingress controller class name

+ vmsingle.ingress.labels @@ -2599,7 +2772,8 @@ vmstorage: - +

Ingress extra labels

+ vmsingle.ingress.path @@ -2609,7 +2783,8 @@ vmstorage: - +

Ingress default path

+ vmsingle.ingress.pathType @@ -2619,7 +2794,8 @@ vmstorage: - +

Ingress path type

+ vmsingle.ingress.tls @@ -2629,7 +2805,8 @@ vmstorage: - +

Array of TLS objects

+ vmsingle.spec diff --git a/charts/victoria-metrics-k8s-stack/values.yaml b/charts/victoria-metrics-k8s-stack/values.yaml index 4bb5ece97..b047236af 100644 --- a/charts/victoria-metrics-k8s-stack/values.yaml +++ b/charts/victoria-metrics-k8s-stack/values.yaml @@ -1,17 +1,22 @@ global: + # -- Cluster label to use for dashboards and rules clusterLabel: cluster + # -- Global license configuration license: key: "" keyRef: {} # name: secret-license # key: license +# -- Resource full name suffix override nameOverride: "" +# -- Resource full name prefix override fullnameOverride: "" +# -- Tenant to use for Grafana datasources and remote write tenant: "0" # -- 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' +# VMServiceScrapes couldn't select the proper services. +# For correct working need set value 'argocdReleaseOverride=$ARGOCD_APP_NAME' argocdReleaseOverride: "" # -- VictoriaMetrics Operator dependency chart configuration. More values can be found [here](https://docs.victoriametrics.com/helm/victoriametrics-operator#parameters). Also checkout [here](https://docs.victoriametrics.com/operator/vars) possible ENV variables to configure operator behaviour @@ -20,16 +25,11 @@ victoria-metrics-operator: serviceMonitor: enabled: true crd: - # -- Disable CRD creation by operator chart as it's being created in this chart create: false - - # -- Helm delete hook for VM CR cleanup cleanup: enabled: true image: repository: bitnami/kubectl - # use image tag that matches k8s API version by default - # tag: 1.29.6 pullPolicy: IfNotPresent operator: # -- By default, operator converts prometheus-operator objects. @@ -41,7 +41,7 @@ serviceAccount: # -- Annotations to add to the service account annotations: {} # -- The name of the service account to use. - # -- If not set and create is true, a name is generated using the fullname template + # If not set and create is true, a name is generated using the fullname template name: "" # -- Enable dashboards despite it's dependency is not installed @@ -94,6 +94,7 @@ defaultRules: # for: 15m # labels: # severity: critical + # -- Rule group properties groups: etcd: create: true @@ -238,6 +239,7 @@ additionalVictoriaMetricsMap: # - record: my_record # expr: 100 * my_record +# -- External VM read and write URLs externalVM: read: url: "" @@ -252,7 +254,9 @@ externalVM: # Configures vmsingle params vmsingle: + # -- VMSingle annotations annotations: {} + # -- Create VMSingle CR enabled: true # -- Full spec for VMSingle CRD. Allowed values describe [here](https://docs.victoriametrics.com/operator/api#vmsinglespec) spec: @@ -270,21 +274,25 @@ vmsingle: requests: storage: 20Gi ingress: + # -- Enable deployment of ingress for server component enabled: false - # For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - # See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - # ingressClassName: nginx - # Values can be templated + # -- Ingress annotations annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" + # -- Ingress extra labels labels: {} + # -- Ingress default path path: "" + # -- Ingress path type pathType: Prefix + # -- Ingress controller class name + ingressClassName: "" - hosts: - - vmsingle.domain.com + # -- Array of host objects + hosts: [] + # - vmsingle.domain.com # -- Extra paths to prepend to every host configuration. This is useful when working with annotation based services. extraPaths: [] # - path: /* @@ -294,13 +302,17 @@ vmsingle: # name: ssl-redirect # port: # name: service + + # -- Array of TLS objects tls: [] # - secretName: vmsingle-ingress-tls # hosts: # - vmsingle.domain.com vmcluster: + # -- Create VMCluster CR enabled: false + # -- VMCluster annotations annotations: {} # -- Full spec for VMCluster CRD. Allowed values described [here](https://docs.victoriametrics.com/operator/api#vmclusterspec) spec: @@ -361,21 +373,30 @@ vmcluster: ingress: storage: + # -- Enable deployment of ingress for server component enabled: false - # For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - # See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - # ingressClassName: nginx - # Values can be templated - annotations: - {} + + # -- Ingress annotations + annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" + + # -- Ingress extra labels labels: {} - path: "" + + # -- Ingress controller class name + ingressClassName: "" + + # -- Ingress path type pathType: Prefix - hosts: - - vmstorage.domain.com + # -- Ingress default path + path: "" + + # -- Array of host objects + hosts: [] + # - vmstorage.domain.com + # -- Extra paths to prepend to every host configuration. This is useful when working with annotation based services. extraPaths: [] # - path: /* @@ -385,26 +406,36 @@ vmcluster: # name: ssl-redirect # port: # name: service + + # -- Array of TLS objects tls: [] # - secretName: vmstorage-ingress-tls # hosts: # - vmstorage.domain.com select: + # -- Enable deployment of ingress for server component enabled: false - # For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - # See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - # ingressClassName: nginx - # Values can be templated - annotations: - {} + + # -- Ingress annotations + annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" + + # -- Ingress extra labels labels: {} - path: '{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vmselect }}' + + # -- Ingress controller class name + ingressClassName: "" + + # -- Ingress path type pathType: Prefix - hosts: - - vmselect.domain.com + # -- Ingress default path + path: '{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vmselect }}' + + # -- Array of host objects + hosts: [] + # - vmselect.domain.com # -- Extra paths to prepend to every host configuration. This is useful when working with annotation based services. extraPaths: [] # - path: /* @@ -414,26 +445,37 @@ vmcluster: # name: ssl-redirect # port: # name: service + + # -- Array of TLS objects tls: [] # - secretName: vmselect-ingress-tls # hosts: # - vmselect.domain.com insert: + # -- Enable deployment of ingress for server component enabled: false - # For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - # See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - # ingressClassName: nginx - # Values can be templated + + # -- Ingress annotations annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" + + # -- Ingress extra labels labels: {} - path: '{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vminsert }}' + + # -- Ingress controller class name + ingressClassName: "" + + # -- Ingress path type pathType: Prefix - hosts: - - vminsert.domain.com + # -- Ingress default path + path: '{{ dig "extraArgs" "http.pathPrefix" "/" .Values.vmcluster.spec.vminsert }}' + + # -- Array of host objects + hosts: [] + # - vminsert.domain.com # -- Extra paths to prepend to every host configuration. This is useful when working with annotation based services. extraPaths: [] # - path: /* @@ -443,13 +485,17 @@ vmcluster: # name: ssl-redirect # port: # name: service + + # -- Array of TLS objects tls: [] # - secretName: vminsert-ingress-tls # hosts: # - vminsert.domain.com alertmanager: + # -- Create VMAlertmanager CR enabled: true + # -- Alertmanager annotations annotations: {} # -- (object) Full spec for VMAlertmanager CRD. Allowed values described [here](https://docs.victoriametrics.com/operator/api#vmalertmanagerspec) spec: @@ -565,8 +611,7 @@ alertmanager: # text: '{{ template "slack.monzo.link_button_text" . }}' # url: "{{ .CommonAnnotations.link_url }}" # - # better alert templates for slack - # source https://gist.github.com/milesbxf/e2744fc90e9c41b47aa47925f8ff6512 + # -- Better alert templates for [slack source](https://gist.github.com/milesbxf/e2744fc90e9c41b47aa47925f8ff6512) monzoTemplate: enabled: true @@ -611,10 +656,12 @@ alertmanager: # - alertmanager.domain.com vmalert: + # -- VMAlert annotations annotations: {} + # -- Create VMAlert CR enabled: true - # Controls whether VMAlert should use VMAgent or VMInsert as a target for remotewrite + # -- Controls whether VMAlert should use VMAgent or VMInsert as a target for remotewrite remoteWriteVMAgent: false # -- (object) Full spec for VMAlert CRD. Allowed values described [here](https://docs.victoriametrics.com/operator/api#vmalertspec) spec: @@ -638,7 +685,7 @@ vmalert: # {{- end }} # template_2.tmpl: "" - # -- allows to configure static notifiers, discover notifiers via Consul and DNS, + # -- Allows to configure static notifiers, discover notifiers via Consul and DNS, # see specification [here](https://docs.victoriametrics.com/vmalert/#notifier-configuration-file). # This configuration will be created as separate secret and mounted to VMAlert pod. additionalNotifierConfigs: {} @@ -679,7 +726,9 @@ vmalert: # - vmalert.domain.com vmauth: + # -- Enable VMAuth CR enabled: false + # -- VMAuth annotations annotations: {} # -- (object) Full spec for VMAuth CRD. Allowed values described [here](https://docs.victoriametrics.com/operator/api#vmauthspec) spec: @@ -687,7 +736,9 @@ vmauth: port: "8427" vmagent: + # -- Create VMAgent CR enabled: true + # -- VMAgent annotations annotations: {} # -- Remote write configuration of VMAgent, allowed parameters defined in a [spec](https://docs.victoriametrics.com/operator/api#vmagentremotewritespec) additionalRemoteWrites: @@ -942,6 +993,7 @@ kubelet: honorTimestamps: false # Component scraping the kube api server kubeApiServer: + # -- Enable Kube Api Server metrics scraping enabled: true # -- Spec for VMServiceScrape CRD is [here](https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec) vmScrape: @@ -966,9 +1018,10 @@ kubeApiServer: # Component scraping the kube controller manager kubeControllerManager: + # -- Enable kube controller manager metrics scraping enabled: true - # If your kube controller manager is not deployed as a pod, specify IPs it can be found on + # -- If your kube controller manager is not deployed as a pod, specify IPs it can be found on endpoints: [] # - 10.141.4.22 # - 10.141.4.23 @@ -976,9 +1029,13 @@ kubeControllerManager: # If using kubeControllerManager.endpoints only the port and targetPort are used service: + # -- Create service for kube controller manager metrics scraping enabled: true + # -- Kube controller manager service port port: 10257 + # -- Kube controller manager service target port targetPort: 10257 + # -- Kube controller manager service pod selector selector: component: kube-controller-manager @@ -1001,10 +1058,12 @@ kubeControllerManager: # Component scraping kubeDns. Use either this or coreDns kubeDns: + # -- Enabled KubeDNS metrics scraping enabled: false - # -- service: + # -- Create Service for KubeDNS metrics enabled: false + # -- KubeDNS service ports ports: dnsmasq: port: 10054 @@ -1012,6 +1071,7 @@ kubeDns: skydns: port: 10055 targetPort: 10055 + # -- KubeDNS service pods selector selector: k8s-app: kube-dns # -- Spec for VMServiceScrape CRD is [here](https://docs.victoriametrics.com/operator/api.html#vmservicescrapespec) @@ -1028,11 +1088,16 @@ kubeDns: # Component scraping coreDns. Use either this or kubeDns coreDns: + # -- Enabled CoreDNS metrics scraping enabled: true service: + # -- Create service for CoreDNS metrics enabled: true + # -- CoreDNS service port port: 9153 + # -- CoreDNS service target port targetPort: 9153 + # -- CoreDNS service pod selector selector: k8s-app: kube-dns @@ -1048,9 +1113,10 @@ coreDns: # Component scraping etcd kubeEtcd: + # -- Enabled KubeETCD metrics scraping enabled: true - # If your etcd is not deployed as a pod, specify IPs it can be found on + # -- If your etcd is not deployed as a pod, specify IPs it can be found on endpoints: [] # - 10.141.4.22 # - 10.141.4.23 @@ -1058,9 +1124,13 @@ kubeEtcd: # Etcd service. If using kubeEtcd.endpoints only the port and targetPort are used service: + # -- Enable service for ETCD metrics scraping enabled: true + # -- ETCD service port port: 2379 + # -- ETCD service target port targetPort: 2379 + # -- ETCD service pods selector selector: component: etcd @@ -1081,9 +1151,10 @@ kubeEtcd: # Component scraping kube scheduler kubeScheduler: + # -- Enable KubeScheduler metrics scraping enabled: true - # If your kube scheduler is not deployed as a pod, specify IPs it can be found on + # -- If your kube scheduler is not deployed as a pod, specify IPs it can be found on endpoints: [] # - 10.141.4.22 # - 10.141.4.23 @@ -1091,9 +1162,13 @@ kubeScheduler: # If using kubeScheduler.endpoints only the port and targetPort are used service: + # -- Enable service for KubeScheduler metrics scrape enabled: true + # -- KubeScheduler service port port: 10259 + # -- KubeScheduler service target port targetPort: 10259 + # -- KubeScheduler service pod selector selector: component: kube-scheduler @@ -1114,18 +1189,23 @@ kubeScheduler: # Component scraping kube proxy kubeProxy: + # -- Enable kube proxy metrics scraping enabled: false - # If your kube proxy is not deployed as a pod, specify IPs it can be found on + # -- If your kube proxy is not deployed as a pod, specify IPs it can be found on endpoints: [] # - 10.141.4.22 # - 10.141.4.23 # - 10.141.4.24 service: + # -- Enable service for kube proxy metrics scraping enabled: true + # -- Kube proxy service port port: 10249 + # -- Kube proxy service target port targetPort: 10249 + # -- Kube proxy service pod selector selector: k8s-app: kube-proxy