From 5f42f62138e751666b89fa15ed93aab75b909dc6 Mon Sep 17 00:00:00 2001 From: Andrii Chubatiuk Date: Sat, 31 Aug 2024 22:34:05 +0300 Subject: [PATCH] updated docs --- charts/victoria-logs-single/README.md | 50 ++++---- charts/victoria-logs-single/values.yaml | 18 +-- charts/victoria-metrics-agent/README.md | 110 ++++++++--------- charts/victoria-metrics-agent/values.yaml | 42 ++++--- charts/victoria-metrics-alert/README.md | 115 +++++++++--------- charts/victoria-metrics-alert/values.yaml | 36 +++--- charts/victoria-metrics-anomaly/README.md | 48 +++----- charts/victoria-metrics-anomaly/values.yaml | 8 +- charts/victoria-metrics-cluster/README.md | 21 ++-- charts/victoria-metrics-cluster/values.yaml | 18 +-- charts/victoria-metrics-gateway/README.md | 39 ++---- charts/victoria-metrics-gateway/values.yaml | 2 +- charts/victoria-metrics-k8s-stack/values.yaml | 2 +- charts/victoria-metrics-operator/README.md | 49 +++----- charts/victoria-metrics-operator/values.yaml | 5 +- 15 files changed, 251 insertions(+), 312 deletions(-) diff --git a/charts/victoria-logs-single/README.md b/charts/victoria-logs-single/README.md index b0dddcfdd..f53f713c3 100644 --- a/charts/victoria-logs-single/README.md +++ b/charts/victoria-logs-single/README.md @@ -127,7 +127,8 @@ Change the values according to the need of the environment in ``victoria-logs-si [] - +

Add extra specs dynamically to this chart

+ fluent-bit.config.filters @@ -388,7 +389,8 @@ true {} - +

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

+ server.enabled @@ -420,31 +422,16 @@ true - server.extraArgs."envflag.enable" - string - 
-"true"
-
- - - - - server.extraArgs."envflag.prefix" - string - 
-VM_
+      server.extraArgs
+      object
+      
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
 

 
-      
-    
-    
-      server.extraArgs.loggerFormat
-      string
-      
-json
-

+      
Extra command line arguments for container of component

 
-      
     
     
       server.extraContainers
@@ -453,7 +440,8 @@ json
 []
- +

Extra containers to run in a pod with Victoria Logs container

+ server.extraHostPathMounts @@ -462,7 +450,8 @@ json [] - +

Additional hostPath mounts

+ server.extraLabels @@ -481,7 +470,8 @@ json [] - +

Extra Volume Mounts for the container

+ server.extraVolumes @@ -490,7 +480,8 @@ json [] - +

Extra Volumes for the pod

+ server.image.pullPolicy @@ -617,7 +608,8 @@ Prefix [] - +

Init containers for Victoria Logs Pod

+ server.nodeSelector diff --git a/charts/victoria-logs-single/values.yaml b/charts/victoria-logs-single/values.yaml index dbc21af98..f7b73dd08 100644 --- a/charts/victoria-logs-single/values.yaml +++ b/charts/victoria-logs-single/values.yaml @@ -46,13 +46,13 @@ server: priorityClassName: "" # -- Data retention period in month retentionPeriod: 1 - # Extra command line arguments for container of component + # -- Extra command line arguments for container of component extraArgs: envflag.enable: "true" envflag.prefix: VM_ loggerFormat: json - # Additional hostPath mounts + # -- Additional hostPath mounts extraHostPathMounts: [] #- name: certs-dir @@ -61,24 +61,26 @@ server: # hostPath: /etc/kubernetes/certs # readOnly: true - # 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 # mountPath: /example + # -- Extra containers to run in a pod with Victoria Logs container extraContainers: [] #- name: config-reloader # image: reloader-image + # -- Init containers for Victoria Logs Pod initContainers: [] @@ -108,9 +110,9 @@ server: # -- Container workdir containerWorkingDir: "" - ## Use an alternate scheduler, e.g. "stork". - ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/ - ## + # -- Use an alternate scheduler, e.g. "stork". + # ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/ + # # schedulerName: emptyDir: {} @@ -338,5 +340,5 @@ fluent-bit: Nested_under kubernetes Add_prefix kubernetes_ -# Add extra specs dynamically to this chart +# -- Add extra specs dynamically to this chart extraObjects: [] diff --git a/charts/victoria-metrics-agent/README.md b/charts/victoria-metrics-agent/README.md index 5e9fd47e7..9570e3e64 100644 --- a/charts/victoria-metrics-agent/README.md +++ b/charts/victoria-metrics-agent/README.md @@ -119,7 +119,8 @@ Change the values according to the need of the environment in ``victoria-metrics {} - +

Annotations to be added to the deployment

+ config.global.scrape_interval @@ -385,7 +386,8 @@ Change the values according to the need of the environment in ``victoria-metrics "" - +

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

+ containerWorkingDir @@ -397,22 +399,15 @@ Change the values according to the need of the environment in ``victoria-metrics - deployment.enabled - bool - 
-true
-
- - - - - deployment.strategy + deployment object 
-{}
+enabled: true
+strategy: {}
- +

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

+ emptyDir @@ -470,7 +465,8 @@ loggerFormat: json [] - +

Additional hostPath mounts

+ extraLabels @@ -479,7 +475,8 @@ loggerFormat: json {} - +

extra Labels for Pods, Deployment and Statefulset

+ extraObjects @@ -488,7 +485,8 @@ loggerFormat: json [] - +

Add extra specs dynamically to this chart

+ extraScrapeConfigs @@ -507,7 +505,8 @@ loggerFormat: json [] - +

Extra Volume Mounts for the container

+ extraVolumes @@ -516,7 +515,8 @@ loggerFormat: json [] - +

Extra Volumes for the pod

+ fullnameOverride @@ -623,7 +623,8 @@ IfNotPresent "" - +

Image registry

+ image.repository @@ -632,7 +633,8 @@ IfNotPresent victoriametrics/vmagent - +

Image repository

+ image.tag @@ -641,7 +643,8 @@ victoriametrics/vmagent "" - +

Image tag, set to Chart.AppVersion by default

+ image.variant @@ -650,7 +653,8 @@ victoriametrics/vmagent "" - +

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

+ imagePullSecrets @@ -877,25 +881,19 @@ false {} - - - - podDisruptionBudget.enabled - bool - 
-false
-
+

Annotations to be added to pod

- - podDisruptionBudget.labels + podDisruptionBudget object 
-{}
+enabled: false
+labels: {}
- +

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

+ podLabels @@ -904,7 +902,8 @@ false {} - +

extra Labels for Pods only

+ podSecurityContext.enabled @@ -1004,7 +1003,8 @@ false [] - +

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

+ replicaCount @@ -1157,7 +1157,8 @@ ClusterIP {} - +

Annotations to add to the service account

+ serviceAccount.create @@ -1166,7 +1167,8 @@ ClusterIP true - +

Specifies whether a service account should be created

+ serviceAccount.name @@ -1175,7 +1177,8 @@ true null - +

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

+ serviceMonitor.annotations @@ -1238,23 +1241,27 @@ false - statefulset.clusterMode - bool - 
-false
+      statefulset
+      object
+      
+clusterMode: false
+enabled: false
+replicationFactor: 1
+updateStrategy: {}
 

 
-      
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

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

 
     
     
-      statefulset.enabled
+      statefulset.clusterMode
       bool
       
 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

+
     
     
       statefulset.replicationFactor
@@ -1266,15 +1273,6 @@ false
       
replication factor for vmagent in cluster mode

 
     
-    
-      statefulset.updateStrategy
-      object
-      
-{}
-

-
-      
-    
     
       tolerations
       list
diff --git a/charts/victoria-metrics-agent/values.yaml b/charts/victoria-metrics-agent/values.yaml
index ed7995e4f..e4f2179dd 100644
--- a/charts/victoria-metrics-agent/values.yaml
+++ b/charts/victoria-metrics-agent/values.yaml
@@ -11,17 +11,17 @@ global:
       
 replicaCount: 1
 
-# ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
+# -- ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
 deployment:
   enabled: true
-  # ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy
+  # ref: -- https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy
   strategy: {}
    # rollingUpdate:
    #  maxSurge: 25%
    #  maxUnavailable: 25%
    # type: RollingUpdate
 
-# ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/
+# -- ref: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/
 statefulset:
   enabled: false
   # -- create cluster of vmagents. See https://docs.victoriametrics.com/vmagent#scraping-big-number-of-targets
@@ -34,10 +34,13 @@ statefulset:
     # type: RollingUpdate
 
 image:
+  # -- Image registry
   registry: ""
+  # -- Image repository
   repository: victoriametrics/vmagent
+  # -- Image tag, set to `Chart.AppVersion` by default
   tag: "" # rewrites Chart.AppVersion
-  # Variant of the image to use.
+  # -- Variant of the image to use.
   # e.g. enterprise, scratch
   variant: ""
   pullPolicy: IfNotPresent
@@ -57,23 +60,23 @@ rbac:
   namespaced: false
 
 serviceAccount:
-  # Specifies whether a service account should be created
+  # -- Specifies whether a service account should be created
   create: true
-  # Annotations to add to the service account
+  # -- Annotations to add to the service account
   annotations: {}
-  # The name of the service account to use.
+  # -- The name of the service account to use.
   # If not set and create is true, a name is generated using the fullname template
   name:
 
-## See `kubectl explain poddisruptionbudget.spec` for more
-## ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/
+# -- See `kubectl explain poddisruptionbudget.spec` for more
+# ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/
 podDisruptionBudget:
   enabled: false
   # minAvailable: 1
   # maxUnavailable: 1
   labels: {}
 
-# WARN: need to specify at least one remote write url or one multi tenant url
+# -- WARN: need to specify at least one remote write url or one multi tenant url
 remoteWriteUrls: []
 # remoteWriteUrls:
 #   - http://vm-insert:8480/insert/0/prometheus
@@ -112,13 +115,13 @@ envFrom:
   #- configMapRef:
   #    name: special-config
 
-# extra Labels for Pods, Deployment and Statefulset
+# -- extra Labels for Pods, Deployment and Statefulset
 extraLabels: {}
 
-# extra Labels for Pods only
+# -- extra Labels for Pods only
 podLabels: {}
 
-# Additional hostPath mounts
+# -- Additional hostPath mounts
 extraHostPathMounts:
   []
   # - name: certs-dir
@@ -127,14 +130,14 @@ extraHostPathMounts:
   #   hostPath: /etc/kubernetes/certs
   #   readOnly: true
 
-# 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
@@ -213,10 +216,10 @@ resources:
   #   cpu: 100m
   #   memory: 128Mi
 
-# Annotations to be added to the deployment
+# -- Annotations to be added to the deployment
 annotations: {}
 
-# Annotations to be added to pod
+# -- Annotations to be added to pod
 podAnnotations: {}
 
 nodeSelector: {}
@@ -230,9 +233,8 @@ topologySpreadConstraints: []
 
 affinity: {}
 
-# vmagent scraping configuration:
+# -- 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
 configMap: ""
@@ -625,7 +627,7 @@ probe:
   # -- startup probe
   startup: {}
 
-# Add extra specs dynamically to this chart
+# -- Add extra specs dynamically to this chart
 extraObjects: []
 
 # -- Enterprise license key configuration for VictoriaMetrics enterprise.
diff --git a/charts/victoria-metrics-alert/README.md b/charts/victoria-metrics-alert/README.md
index ab650edca..77556d936 100644
--- a/charts/victoria-metrics-alert/README.md
+++ b/charts/victoria-metrics-alert/README.md
@@ -117,7 +117,8 @@ Change the values according to the need of the environment in ``victoria-metrics
 ""
- +

external URL, that alertmanager will expose to receivers

+ alertmanager.baseURLPrefix @@ -126,7 +127,8 @@ Change the values according to the need of the environment in ``victoria-metrics "" - +

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

+ alertmanager.config.global.resolve_timeout @@ -198,7 +200,8 @@ devnull "" - +

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

+ alertmanager.emptyDir @@ -252,7 +255,8 @@ false [] - +

Additional hostPath mounts

+ alertmanager.extraVolumeMounts @@ -261,7 +265,8 @@ false [] - +

Extra Volume Mounts for the container

+ alertmanager.extraVolumes @@ -270,7 +275,8 @@ false [] - +

Extra Volumes for the pod

+ alertmanager.image @@ -835,7 +841,8 @@ false {} - +

Annotations to be added to the deployment

+ server.config.alerts.groups @@ -853,7 +860,24 @@ false "" - +

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

+ + + + server.datasource + object + 
+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.

+ server.datasource.basicAuth @@ -886,15 +910,6 @@ username: ""

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

- - server.datasource.url - string - 
-""
-
- - - server.enabled bool @@ -1084,7 +1099,8 @@ Prefix {} - +

labels to be added to the deployment

+ server.minReadySeconds @@ -1093,7 +1109,8 @@ Prefix 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

+ server.name @@ -1187,25 +1204,19 @@ username: "" {} - - - - server.podDisruptionBudget.enabled - bool - 
-false
-
+

Annotations to be added to pod

- - server.podDisruptionBudget.labels + server.podDisruptionBudget object 
-{}
+enabled: false
+labels: {}
- +

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

+ server.podLabels @@ -1499,31 +1510,17 @@ ClusterIP - server.strategy.rollingUpdate.maxSurge - string - 
-25%
-
- - - - - server.strategy.rollingUpdate.maxUnavailable - string - 
-25%
+      server.strategy
+      object
+      
+rollingUpdate:
+    maxSurge: 25%
+    maxUnavailable: 25%
+type: RollingUpdate
 

 
-      
-    
-    
-      server.strategy.type
-      string
-      
-RollingUpdate
-

+      
deployment strategy, set to standard k8s default

 
-      
     
     
       server.tolerations
@@ -1561,7 +1558,8 @@ false
 {}
- +

Annotations to add to the service account

+ serviceAccount.automountToken @@ -1570,7 +1568,8 @@ false true - +

mount API token to pod directly

+ serviceAccount.create @@ -1579,7 +1578,8 @@ true true - +

Specifies whether a service account should be created

+ serviceAccount.name @@ -1588,7 +1588,8 @@ true null - +

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

+ serviceMonitor.annotations diff --git a/charts/victoria-metrics-alert/values.yaml b/charts/victoria-metrics-alert/values.yaml index 5751b8da1..475d2d750 100644 --- a/charts/victoria-metrics-alert/values.yaml +++ b/charts/victoria-metrics-alert/values.yaml @@ -10,14 +10,14 @@ global: adaptSecurityContext: "auto" serviceAccount: - # Specifies whether a service account should be created + # -- Specifies whether a service account should be created create: true - # Annotations to add to the service account + # -- Annotations to add to the service account annotations: {} - # The name of the service account to use. + # -- The name of the service account to use. # If not set and create is true, a name is generated using the fullname template name: - # mount API token to pod directly + # -- mount API token to pod directly automountToken: true rbac: @@ -42,7 +42,7 @@ server: fullnameOverride: "" imagePullSecrets: [] - ## -- See `kubectl explain poddisruptionbudget.spec` for more. Or check [docs](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) + # -- See `kubectl explain poddisruptionbudget.spec` for more. Or check [docs](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) podDisruptionBudget: enabled: false # minAvailable: 1 @@ -83,18 +83,18 @@ server: replicaCount: 1 - # deployment strategy, set to standard k8s default + # -- deployment strategy, set to standard k8s default strategy: type: RollingUpdate rollingUpdate: maxSurge: 25% maxUnavailable: 25% - # specifies the minimum number of seconds for which a newly created Pod should be ready without any of its containers crashing/terminating + # -- 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 minReadySeconds: 0 - # vmalert reads metrics from source, next section represents its configuration. It can be any service which supports + # -- vmalert reads metrics from source, next section represents its configuration. It can be any service which supports # MetricsQL or PromQL. datasource: url: "" @@ -263,12 +263,12 @@ server: # cpu: 100m # memory: 128Mi - # Annotations to be added to the deployment + # -- Annotations to be added to the deployment annotations: {} - # labels to be added to the deployment + # -- labels to be added to the deployment labels: {} - # Annotations to be added to pod + # -- Annotations to be added to pod podAnnotations: {} podLabels: {} @@ -281,7 +281,7 @@ server: affinity: {} - # vmalert alert rules configuration configuration: + # -- vmalert alert rules configuration configuration: # use existing configmap if specified # otherwise .config values will be used configMap: "" @@ -370,11 +370,11 @@ alertmanager: extraArgs: {} # key: value envFrom: [] - # external URL, that alertmanager will expose to receivers + # -- external URL, that alertmanager will expose to receivers baseURL: "" - # external URL Prefix, Prefix for the internal routes of web endpoints + # -- external URL Prefix, Prefix for the internal routes of web endpoints baseURLPrefix: "" - # use existing configmap if specified + # -- use existing configmap if specified # otherwise .config values will be used configMap: "" config: @@ -454,7 +454,7 @@ alertmanager: # -- Size of the volume. Better to set the same as resource limit memory property. size: 50Mi - # Additional hostPath mounts + # -- Additional hostPath mounts extraHostPathMounts: [] # - name: certs-dir @@ -463,14 +463,14 @@ alertmanager: # hostPath: /etc/kubernetes/certs # readOnly: true - # 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 diff --git a/charts/victoria-metrics-anomaly/README.md b/charts/victoria-metrics-anomaly/README.md index 7be71426a..583ac6228 100644 --- a/charts/victoria-metrics-anomaly/README.md +++ b/charts/victoria-metrics-anomaly/README.md @@ -692,40 +692,17 @@ true - securityContext.enabled - bool - 
-true
-
- - - - - securityContext.runAsGroup - int - 
-1000
-
- - - - - securityContext.runAsNonRoot - bool - 
-true
+      securityContext
+      object
+      
+enabled: true
+runAsGroup: 1000
+runAsNonRoot: true
+runAsUser: 1000
 

 
-      
-    
-    
-      securityContext.runAsUser
-      int
-      
-1000
-

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

 
-      
     
     
       serviceAccount.annotations
@@ -734,7 +711,8 @@ true
 {}
- +

Annotations to add to the service account

+ serviceAccount.create @@ -743,7 +721,8 @@ true true - +

Specifies whether a service account should be created

+ serviceAccount.name @@ -752,7 +731,8 @@ true null - +

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

+ tolerations diff --git a/charts/victoria-metrics-anomaly/values.yaml b/charts/victoria-metrics-anomaly/values.yaml index ea8514d0a..fd622de3e 100644 --- a/charts/victoria-metrics-anomaly/values.yaml +++ b/charts/victoria-metrics-anomaly/values.yaml @@ -26,11 +26,11 @@ fullnameOverride: "" containerWorkingDir: "/vmanomaly" serviceAccount: - # Specifies whether a service account should be created + # -- Specifies whether a service account should be created create: true - # Annotations to add to the service account + # -- 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 + # -- The name of the service account to use. If not set and create is true, a name is generated using the fullname template name: # -- See `kubectl explain poddisruptionbudget.spec` for more. Details are [here](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) @@ -77,7 +77,7 @@ podSecurityContext: enabled: true # fsGroup: 2000 -## Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ +# -- Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ securityContext: enabled: true runAsNonRoot: true diff --git a/charts/victoria-metrics-cluster/README.md b/charts/victoria-metrics-cluster/README.md index 7ceef3263..efc1c52c2 100644 --- a/charts/victoria-metrics-cluster/README.md +++ b/charts/victoria-metrics-cluster/README.md @@ -1118,7 +1118,8 @@ json [] - +

Additional hostPath mounts

+ vmselect.extraLabels @@ -1136,7 +1137,8 @@ json [] - +

Extra Volume Mounts for the container

+ vmselect.extraVolumes @@ -1145,7 +1147,8 @@ json [] - +

Extra Volumes for the pod

+ vmselect.fullnameOverride @@ -1849,7 +1852,8 @@ true {} - +

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

+ vmstorage.enabled @@ -1923,7 +1927,8 @@ json [] - +

Additional hostPath mounts

+ vmstorage.extraLabels @@ -1950,7 +1955,8 @@ json [] - +

Extra Volume Mounts for the container

+ vmstorage.extraVolumes @@ -1959,7 +1965,8 @@ json [] - +

Extra Volumes for the pod

+ vmstorage.fullnameOverride diff --git a/charts/victoria-metrics-cluster/values.yaml b/charts/victoria-metrics-cluster/values.yaml index 97f56ba3f..cd40f1f89 100644 --- a/charts/victoria-metrics-cluster/values.yaml +++ b/charts/victoria-metrics-cluster/values.yaml @@ -113,7 +113,7 @@ vmselect: # -- Behavior settings for scaling by the HPA behavior: {} - # Additional hostPath mounts + # -- Additional hostPath mounts extraHostPathMounts: [] # - name: certs-dir @@ -122,14 +122,14 @@ vmselect: # hostPath: /etc/kubernetes/certs # readOnly: true - # 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 @@ -544,7 +544,7 @@ vmstorage: envflag.prefix: VM_ loggerFormat: json - # Additional hostPath mounts + # -- Additional hostPath mounts extraHostPathMounts: [] # - name: certs-dir @@ -553,14 +553,14 @@ vmstorage: # hostPath: /etc/kubernetes/certs # readOnly: true - # 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 @@ -618,9 +618,9 @@ vmstorage: topologySpreadConstraints: [] - ## Use an alternate scheduler, e.g. "stork". - ## ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/ - ## + # -- Use an alternate scheduler, e.g. "stork". + # ref: https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/ + # # schedulerName: emptyDir: {} diff --git a/charts/victoria-metrics-gateway/README.md b/charts/victoria-metrics-gateway/README.md index dcee49fd7..4bb6ca971 100644 --- a/charts/victoria-metrics-gateway/README.md +++ b/charts/victoria-metrics-gateway/README.md @@ -675,40 +675,17 @@ false - securityContext.enabled - bool - 
-true
-
- - - - - securityContext.runAsGroup - int - 
-1000
-
- - - - - securityContext.runAsNonRoot - bool - 
-true
+      securityContext
+      object
+      
+enabled: true
+runAsGroup: 1000
+runAsNonRoot: true
+runAsUser: 1000
 

 
-      
-    
-    
-      securityContext.runAsUser
-      int
-      
-1000
-

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

 
-      
     
     
       service.annotations
diff --git a/charts/victoria-metrics-gateway/values.yaml b/charts/victoria-metrics-gateway/values.yaml
index 4b1172716..edd8a8152 100644
--- a/charts/victoria-metrics-gateway/values.yaml
+++ b/charts/victoria-metrics-gateway/values.yaml
@@ -88,7 +88,7 @@ podSecurityContext:
   enabled: true
 # fsGroup: 2000
 
-## Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+# -- Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
 securityContext:
   enabled: true
   runAsNonRoot: true
diff --git a/charts/victoria-metrics-k8s-stack/values.yaml b/charts/victoria-metrics-k8s-stack/values.yaml
index a600d7c44..0b1888f35 100644
--- a/charts/victoria-metrics-k8s-stack/values.yaml
+++ b/charts/victoria-metrics-k8s-stack/values.yaml
@@ -262,7 +262,7 @@ externalVM:
 
 ##############
 
-## -- Configures vmsingle params
+# Configures vmsingle params
 vmsingle:
   annotations: {}
   enabled: true
diff --git a/charts/victoria-metrics-operator/README.md b/charts/victoria-metrics-operator/README.md
index 64797bb3e..d0d6ffaf8 100644
--- a/charts/victoria-metrics-operator/README.md
+++ b/charts/victoria-metrics-operator/README.md
@@ -290,31 +290,16 @@ false
 
     
     
-      crd.cleanup.image.pullPolicy
-      string
-      
-IfNotPresent
-

-
-      
-    
-    
-      crd.cleanup.image.repository
-      string
-      
-bitnami/kubectl
+      crd.cleanup.image
+      object
+      
+pullPolicy: IfNotPresent
+repository: bitnami/kubectl
+tag: ""
 

 
-      
-    
-    
-      crd.cleanup.image.tag
-      string
-      
-""
-

+      
Image configuration for CRD cleanup Job

 
-      
     
     
       crd.create
@@ -586,22 +571,15 @@ false
 
     
     
-      podDisruptionBudget.enabled
-      bool
-      
-false
-

-
-      
-    
-    
-      podDisruptionBudget.labels
+      podDisruptionBudget
       object
       
-{}
+enabled: false
+labels: {}
 

 
-      
+      
See kubectl explain poddisruptionbudget.spec for more or check these docs

+
     
     
       podLabels
@@ -891,7 +869,8 @@ tlsConfig: {}
 []
 

 
-      
+      
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/charts/victoria-metrics-operator/values.yaml b/charts/victoria-metrics-operator/values.yaml
index 9547ebbda..38ae8c0bc 100644
--- a/charts/victoria-metrics-operator/values.yaml
+++ b/charts/victoria-metrics-operator/values.yaml
@@ -29,6 +29,7 @@ crd:
   cleanup:
     # -- Tells helm to clean up all the vm resources under this release's namespace when uninstalling
     enabled: false
+    # -- Image configuration for CRD cleanup Job
     image:
       repository: bitnami/kubectl
       # use image tag that matches k8s API version by default
@@ -85,7 +86,7 @@ operator:
   # It should reduce  vmagent and vmauth config sync-time and make it predictable.
   useCustomConfigReloader: false
 
-# By default, the operator will watch all the namespaces
+# -- 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.
 watchNamespaces: []
@@ -109,7 +110,7 @@ service:
   ipFamilyPolicy: ""
   ipFamilies: []
 
-## -- See `kubectl explain poddisruptionbudget.spec` for more or check [these docs](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)
+# -- See `kubectl explain poddisruptionbudget.spec` for more or check [these docs](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)
 podDisruptionBudget:
   enabled: false
   # minAvailable: 1