updated docs

VictoriaMetrics · Sep 3, 2024 · 5f42f62 · 5f42f62
1 parent e1d2d92
commit 5f42f62
Show file tree

Hide file tree

Showing 15 changed files with 251 additions and 312 deletions.
diff --git 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
 []
 </pre>
 </td>
-      <td></td>
+      <td><p>Add extra specs dynamically to this chart</p>
+</td>
     </tr>
     <tr>
       <td>fluent-bit.config.filters</td>
@@ -388,7 +389,8 @@ true
 {}
 </pre>
 </td>
-      <td></td>
+      <td><p>Use an alternate scheduler, e.g. &ldquo;stork&rdquo;. ref: <a href="https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/" target="_blank">https://kubernetes.io/docs/tasks/administer-cluster/configure-multiple-schedulers/</a>  schedulerName:</p>
+</td>
     </tr>
     <tr>
       <td>server.enabled</td>
@@ -420,31 +422,16 @@ true
       <td></td>
     </tr>
     <tr>
-      <td>server.extraArgs."envflag.enable"</td>
-      <td>string</td>
-      <td><pre lang="">
-"true"
-</pre>
-</td>
-      <td></td>
-    </tr>
-    <tr>
-      <td>server.extraArgs."envflag.prefix"</td>
-      <td>string</td>
-      <td><pre lang="">
-VM_
+      <td>server.extraArgs</td>
+      <td>object</td>
+      <td><pre lang="plaintext">
+envflag.enable: "true"
+envflag.prefix: VM_
+loggerFormat: json
 </pre>
 </td>
-      <td></td>
-    </tr>
-    <tr>
-      <td>server.extraArgs.loggerFormat</td>
-      <td>string</td>
-      <td><pre lang="">
-json
-</pre>
+      <td><p>Extra command line arguments for container of component</p>
 </td>
-      <td></td>
     </tr>
     <tr>
       <td>server.extraContainers</td>
@@ -453,7 +440,8 @@ json
 []
 </pre>
 </td>
-      <td></td>
+      <td><p>Extra containers to run in a pod with Victoria Logs container</p>
+</td>
     </tr>
     <tr>
       <td>server.extraHostPathMounts</td>
@@ -462,7 +450,8 @@ json
 []
 </pre>
 </td>
-      <td></td>
+      <td><p>Additional hostPath mounts</p>
+</td>
     </tr>
     <tr>
       <td>server.extraLabels</td>
@@ -481,7 +470,8 @@ json
 []
 </pre>
 </td>
-      <td></td>
+      <td><p>Extra Volume Mounts for the container</p>
+</td>
     </tr>
     <tr>
       <td>server.extraVolumes</td>
@@ -490,7 +480,8 @@ json
 []
 </pre>
 </td>
-      <td></td>
+      <td><p>Extra Volumes for the pod</p>
+</td>
     </tr>
     <tr>
       <td>server.image.pullPolicy</td>
@@ -617,7 +608,8 @@ Prefix
 []
 </pre>
 </td>
-      <td></td>
+      <td><p>Init containers for Victoria Logs Pod</p>
+</td>
     </tr>
     <tr>
       <td>server.nodeSelector</td>

diff --git 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: []