updated readme formatting

charts/victoria-logs-single/README.md.gotmpl

@@ -111,4 +111,23 @@ The following tables lists the configurable parameters of the chart and their de
 
 Change the values according to the need of the environment in ``victoria-logs-single/values.yaml`` file.
 
-{{ template "chart.valuesTable" . }}
+{{ define "chart.valueDefaultColumnRender" }}
+{{- $defaultValue := (default .Default .AutoDefault)  -}}
+{{- $notationType := .NotationType }}
+{{- if and (hasPrefix "`" $defaultValue) (hasSuffix "`" $defaultValue) -}}
+{{- $defaultValue = (toYaml (fromJson (trimAll "`" (default .Default .AutoDefault) ) ) ) -}}
+{{- if has .Type (list "list" "object" "map") -}}
+{{- $notationType = "plaintext" }}
+{{- end -}}
+{{- end -}}
+<pre lang="{{ $notationType }}">
+{{- if (eq $notationType "tpl" ) }}
+{{ .Key }}: |
+{{- $defaultValue | nindent 2 }}
+{{- else }}
+{{ $defaultValue }}
+{{- end }}
+</pre>
+{{ end }}
+
+{{ template "chart.valuesTableHtml" . }}

charts/victoria-logs-single/values.yaml

@@ -21,7 +21,7 @@ global:
 printNotes: true
 
 podDisruptionBudget:
-  # -- See `kubectl explain poddisruptionbudget.spec` for more. Ref: [https://kubernetes.io/docs/tasks/run-application/configure-pdb/](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)
+  # -- See `kubectl explain poddisruptionbudget.spec` for more. Details are [here](https://kubernetes.io/docs/tasks/run-application/configure-pdb/)
   enabled: false
   #  minAvailable: 1
   #  maxUnavailable: 1
@@ -82,15 +82,15 @@ server:
   initContainers:
     []
 
-  # -- Node tolerations for server scheduling to nodes with taints. Ref: [https://kubernetes.io/docs/concepts/configuration/assign-pod-node/](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
+  # -- Node tolerations for server scheduling to nodes with taints. Details are [here](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/)
   tolerations:
     []
     # - key: "key"
     #   operator: "Equal|Exists"
     #   value: "value"
     #   effect: "NoSchedule|PreferNoSchedule"
 
-  # -- Pod's node selector. Ref: [https://kubernetes.io/docs/user-guide/node-selection/](https://kubernetes.io/docs/user-guide/node-selection/)
+  # -- Pod's node selector. Details are [here](https://kubernetes.io/docs/user-guide/node-selection/)
   nodeSelector: {}
 
   # -- Pod affinity
@@ -118,7 +118,7 @@ server:
     # -- Create/use Persistent Volume Claim for server component. Empty dir if false
     enabled: false
 
-    # -- Array of access modes. Must match those of existing PV or dynamic provisioner. Ref: [http://kubernetes.io/docs/user-guide/persistent-volumes/](http://kubernetes.io/docs/user-guide/persistent-volumes/)
+    # -- Array of access modes. Must match those of existing PV or dynamic provisioner. Details are [here](http://kubernetes.io/docs/user-guide/persistent-volumes/)
     accessModes:
       - ReadWriteOnce
     # -- Persistant volume annotations
@@ -149,7 +149,7 @@ server:
   # -- Pod's management policy
   podManagementPolicy: OrderedReady
 
-  # -- Resource object. Ref: [http://kubernetes.io/docs/user-guide/compute-resources/](http://kubernetes.io/docs/user-guide/compute-resources/
+  # -- Resource object. Details are [here](http://kubernetes.io/docs/user-guide/compute-resources/)
   resources:
     {}
     # limits:
@@ -160,23 +160,23 @@ server:
     #   memory: 512Mi
 
   probe:
-    # Indicates whether the Container is ready to service requests. If the readiness probe fails, the endpoints controller removes the Pod's IP address from the endpoints of all Services that match the Pod. The default state of readiness before the initial delay is Failure. If a Container does not provide a readiness probe, the default state is Success.
+    # -- Indicates whether the Container is ready to service requests. If the readiness probe fails, the endpoints controller removes the Pod's IP address from the endpoints of all Services that match the Pod. The default state of readiness before the initial delay is Failure. If a Container does not provide a readiness probe, the default state is Success.
     readiness:
       httpGet: {}
       initialDelaySeconds: 5
       periodSeconds: 15
       timeoutSeconds: 5
       failureThreshold: 3
 
-    # Indicates whether the Container is running. If the liveness probe fails, the kubelet kills the Container, and the Container is subjected to its restart policy. If a Container does not provide a liveness probe, the default state is Success.
+    # -- Indicates whether the Container is running. If the liveness probe fails, the kubelet kills the Container, and the Container is subjected to its restart policy. If a Container does not provide a liveness probe, the default state is Success.
     liveness:
       tcpSocket: {}
       initialDelaySeconds: 30
       periodSeconds: 30
       timeoutSeconds: 5
       failureThreshold: 10
 
-    # Indicates whether the Container is done with potentially costly initialization. If set it is executed first. If it fails Container is restarted. If it succeeds liveness and readiness probes takes over.
+    # -- Indicates whether the Container is done with potentially costly initialization. If set it is executed first. If it fails Container is restarted. If it succeeds liveness and readiness probes takes over.
     startup: {}
      # tcpSocket: {}
      # failureThreshold: 30
@@ -193,7 +193,7 @@ server:
         - ALL
     readOnlyRootFilesystem: true
 
-  # -- Pod's security context. Ref: [https://kubernetes.io/docs/tasks/configure-pod-container/security-context/](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)
+  # -- Pod's security context. Details are [here](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/)
   podSecurityContext:
     enabled: true
     fsGroup: 2000
@@ -235,7 +235,7 @@ server:
     labels: {}
     # -- Service ClusterIP
     clusterIP: ""
-    # -- Service External IPs. Ref: [https://kubernetes.io/docs/user-guide/services/#external-ips]( https://kubernetes.io/docs/user-guide/services/#external-ips)
+    # -- Service External IPs. Details are [here]( https://kubernetes.io/docs/user-guide/services/#external-ips)
     externalIPs: []
     # -- Service load balacner IP
     loadBalancerIP: ""
@@ -307,6 +307,7 @@ fluent-bit:
   config:
     # -- Note that Host must be replaced to match your VictoriaLogs service name
     # Default format points to VictoriaLogs service.
+    # @notationType -- tpl
     outputs: |
       [OUTPUT]
           Name http
@@ -319,6 +320,8 @@ fluent-bit:
           json_date_format iso8601
           header AccountID 0
           header ProjectID 0
+    # -- FluentBit configuration filters
+    # @notationType -- tpl
     filters: |
       [FILTER]
           Name kubernetes