From 5027a2acba17ff62ebcfd6e6b757252116bf18eb Mon Sep 17 00:00:00 2001 From: Andrii Chubatiuk Date: Sat, 14 Sep 2024 20:54:03 +0300 Subject: [PATCH] updated readme --- charts/victoria-metrics-cluster/README.md | 857 ++++++++++++++++++++-- charts/victoria-metrics-single/README.md | 2 +- 2 files changed, 801 insertions(+), 58 deletions(-) diff --git a/charts/victoria-metrics-cluster/README.md b/charts/victoria-metrics-cluster/README.md index 4dc157bfa..b7af6f56f 100644 --- a/charts/victoria-metrics-cluster/README.md +++ b/charts/victoria-metrics-cluster/README.md @@ -119,45 +119,717 @@ Change the values according to the need of the environment in ``victoria-metrics - clusterDomainSuffix + extraObjects + list + 
+[]
+
+ +

Add extra specs dynamically to this chart

+ + + + extraSecrets + list + 
+[]
+
+ + + + + global.cluster + object + 
+dnsDomain: cluster.local
+
+ +

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

+ + + + global.compatibility.openshift.adaptSecurityContext + string + 
+auto
+
+ + + + + global.image.registry + string + 
+""
+
+ + + + + global.imagePullSecrets + list + 
+[]
+
+ + + + + license + object + 
+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

+ + + + license.key + string + 
+""
+
+ +

License key

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

Use existing secret with license key

+ + + + license.secret.key + string + 
+""
+
+ +

Key in secret with license key

+ + + + license.secret.name + string + 
+""
+
+ +

Existing secret name

+ + + + printNotes + bool + 
+true
+
+ + + + + rbac.create + bool + 
+true
+
+ + + + + rbac.extraLabels + object + 
+{}
+
+ + + + + rbac.namespaced + bool + 
+false
+
+ + + + + serviceAccount.automountToken + bool + 
+true
+
+ + + + + serviceAccount.create + bool + 
+true
+
+ + + + + serviceAccount.extraLabels + object + 
+{}
+
+ + + + + vmauth.affinity + object + 
+{}
+
+ +

Pod affinity

+ + + + vmauth.annotations + object + 
+{}
+
+ + + + + vmauth.automountServiceAccountToken + bool + 
+true
+
+ + + + + vmauth.config.unauthorized_user + object + 
+{}
+
+ + + + + vmauth.configSecretName + string + 
+""
+
+ + + + + vmauth.containerWorkingDir + string + 
+""
+
+ +

Container workdir

+ + + + vmauth.enabled + bool + 
+false
+
+ +

Enable deployment of vmauth component. Deployment is used

+ + + + vmauth.env + list + 
+[]
+
+ +

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

+ + + + vmauth.envFrom + list + 
+[]
+
+ + + + + vmauth.extraArgs."envflag.enable" + string + 
+"true"
+
+ + + + + vmauth.extraArgs."envflag.prefix" + string + 
+VM_
+
+ + + + + vmauth.extraArgs.loggerFormat + string + 
+json
+
+ + + + + vmauth.extraContainers + list + 
+[]
+
+ + + + + vmauth.extraLabels + object + 
+{}
+
+ + + + + vmauth.extraVolumeMounts + list + 
+[]
+
+ + + + + vmauth.extraVolumes + list + 
+[]
+
+ + + + + vmauth.fullnameOverride + string + 
+""
+
+ +

Overrides the full name of vmauth component

+ + + + vmauth.horizontalPodAutoscaler.behavior + object + 
+{}
+
+ +

Behavior settings for scaling by the HPA

+ + + + vmauth.horizontalPodAutoscaler.enabled + bool + 
+false
+
+ +

Use HPA for vmauth component

+ + + + vmauth.horizontalPodAutoscaler.maxReplicas + int + 
+10
+
+ +

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

+ + + + vmauth.horizontalPodAutoscaler.metrics + list + 
+[]
+
+ +

Metric for HPA to use to scale the vmauth component

+ + + + vmauth.horizontalPodAutoscaler.minReplicas + int + 
+2
+
+ +

Minimum replicas for HPA to use to scale the vmauth component

+ + + + vmauth.image.pullPolicy + string + 
+IfNotPresent
+
+ +

Image pull policy

+ + + + vmauth.image.registry + string + 
+""
+
+ +

Image registry

+ + + + vmauth.image.repository + string + 
+victoriametrics/vmauth
+
+ +

Image repository

+ + + + vmauth.image.tag + string + 
+""
+
+ +

Image tag override Chart.AppVersion

+ + + + vmauth.image.variant + string + 
+""
+
+ + + + + vmauth.ingress.annotations + object + 
+{}
+
+ +

Ingress annotations

+ + + + vmauth.ingress.enabled + bool + 
+false
+
+ +

Enable deployment of ingress for vmauth component

+ + + + vmauth.ingress.extraLabels + object + 
+{}
+
+ + + + + vmauth.ingress.hosts + list + 
+[]
+
+ +

Array of host objects

+ + + + vmauth.ingress.pathType + string + 
+Prefix
+
+ +

pathType is only for k8s >= 1.1=

+ + + + vmauth.ingress.tls + list + 
+[]
+
+ +

Array of TLS objects

+ + + + vmauth.initContainers + list + 
+[]
+
+ + + + + vmauth.name + string + 
+""
+
+ +

vmauth container name

+ + + + vmauth.nodeSelector + object + 
+{}
+
+ +

Pod’s node selector. Details are here

+ + + + vmauth.podAnnotations + object + 
+{}
+
+ +

Pod’s annotations

+ + + + vmauth.podDisruptionBudget.enabled + bool + 
+false
+
+ +

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

+ + + + vmauth.podDisruptionBudget.labels + object + 
+{}
+
+ + + + + vmauth.podLabels + object + 
+{}
+
+ + + + + vmauth.podSecurityContext.enabled + bool + 
+false
+
+ + + + + vmauth.ports.name string 
-cluster.local
+http
-

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

+ + + + vmauth.priorityClassName + string + 
+""
+
+ +

Name of Priority Class

- extraObjects - list + vmauth.probe.liveness + object 
-[]
+failureThreshold: 3
+initialDelaySeconds: 5
+periodSeconds: 15
+tcpSocket: {}
+timeoutSeconds: 5
-

Add extra specs dynamically to this chart

+

vmauth liveness probe

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

vmauth readiness probe

+ + + + vmauth.probe.startup + object + 
+{}
+
+ +

vmauth startup probe

+ + + + vmauth.replicaCount + int + 
+2
+
+ +

Count of vmauth pods

+ + + + vmauth.resources + object + 
+{}
+
+ +

Resource object

+ + + + vmauth.securityContext + object + 
+enabled: false
+
+ +

Pod’s security context. Details are here

+ + + + vmauth.service.annotations + object + 
+{}
+
+ +

Service annotations

+ + + + vmauth.service.clusterIP + string + 
+""
+
+ +

Service ClusterIP

+ + + + vmauth.service.enabled + bool + 
+true
+
+ + + + + vmauth.service.externalIPs list 
 []
- +

Service External IPs. Details are here

+ - global.compatibility.openshift.adaptSecurityContext + vmauth.service.externalTrafficPolicy string 
-auto
+""
- global.image.registry + vmauth.service.extraPorts + list + 
+[]
+
+ +

Extra service ports

+ + + + vmauth.service.healthCheckNodePort string 
 ""
@@ -166,7 +838,7 @@ auto
       
     
     
-      global.imagePullSecrets
+      vmauth.service.ipFamilies
       list
       
 []
@@ -175,115 +847,156 @@ auto
       
     
     
-      license
+      vmauth.service.ipFamilyPolicy
+      string
+      
+""
+

+
+      
+    
+    
+      vmauth.service.labels
       object
       
-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

+      
Service labels

 
     
     
-      license.key
+      vmauth.service.loadBalancerIP
       string
       
 ""
 

 
-      
License key

+      
Service load balancer IP

 
     
     
-      license.secret
-      object
+      vmauth.service.loadBalancerSourceRanges
+      list
       
-key: ""
-name: ""
+[]
 

 
-      
Use existing secret with license key

+      
Load balancer source range

 
     
     
-      license.secret.key
-      string
+      vmauth.service.servicePort
+      int
       
-""
+8427
 

 
-      
Key in secret with license key

+      
Service port

 
     
     
-      license.secret.name
+      vmauth.service.targetPort
       string
       
-""
+http
 

 
-      
Existing secret name

+      
Target port

 
     
     
-      printNotes
-      bool
+      vmauth.service.type
+      string
       
-true
+ClusterIP
 

 
-      
+      
Service type

+
     
     
-      rbac.create
+      vmauth.service.udp
       bool
       
-true
+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/

+
     
     
-      rbac.extraLabels
+      vmauth.serviceMonitor.annotations
       object
       
 {}
 

 
-      
+      
Service Monitor annotations

+
     
     
-      rbac.namespaced
+      vmauth.serviceMonitor.basicAuth
+      object
+      
+{}
+

+
+      
Basic auth params for Service Monitor

+
+    
+    
+      vmauth.serviceMonitor.enabled
       bool
       
 false
 

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

+
     
     
-      serviceAccount.automountToken
-      bool
-      
-true
+      vmauth.serviceMonitor.extraLabels
+      object
+      
+{}
 

 
-      
+      
Service Monitor labels

+
     
     
-      serviceAccount.create
-      bool
+      vmauth.serviceMonitor.metricRelabelings
+      list
+      
+[]
+

+
+      
Service Monitor metricRelabelings

+
+    
+    
+      vmauth.serviceMonitor.namespace
+      string
       
-true
+""
 

 
-      
+      
Target namespace of ServiceMonitor manifest

+
     
     
-      serviceAccount.extraLabels
+      vmauth.serviceMonitor.relabelings
+      list
+      
+[]
+

+
+      
Service Monitor relabelings

+
+    
+    
+      vmauth.strategy
       object
       
 {}
@@ -291,6 +1004,36 @@ true
 
       
     
+    
+      vmauth.suppressStorageFQDNsRender
+      bool
+      
+false
+

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

+
+    
+    
+      vmauth.tolerations
+      list
+      
+[]
+

+
+      
Array of tolerations object. Details are here

+
+    
+    
+      vmauth.topologySpreadConstraints
+      list
+      
+[]
+

+
+      
Pod topologySpreadConstraints

+
+    
     
       vminsert.affinity
       object
@@ -602,7 +1345,7 @@ Prefix
       vminsert.name
       string
       
-vminsert
+""
 

 
       
vminsert container name

@@ -1358,7 +2101,7 @@ Prefix
       vmselect.name
       string
       
-vmselect
+""
 

 
       
Vmselect container name

@@ -2136,7 +2879,7 @@ cluster
       vmstorage.name
       string
       
-vmstorage
+""
 

 
       
vmstorage container name

diff --git a/charts/victoria-metrics-single/README.md b/charts/victoria-metrics-single/README.md
index 5480b70f8..34058e627 100644
--- a/charts/victoria-metrics-single/README.md
+++ b/charts/victoria-metrics-single/README.md
@@ -633,7 +633,7 @@ true
 
     
     
-      server.persistentVolume.storageClass
+      server.persistentVolume.storageClassName
       string
       
 ""