MILAB-3993-victoria-logs-in-helm-charts

.gitignore

@@ -1,3 +1,5 @@
 # Helm resources
 charts/*/charts/*.tgz
 charts/*/Chart.lock
+
+.vscode/

README.md

@@ -166,7 +166,7 @@ Persistence is enabled by default and controlled under `persistence`:
   - `packagesDir`: software packages
   For each you can set `existingClaim` to use existing PersistentVolumeClaim instead of automatic PVC creation for service 
   Also you can alter `size` and `storageClass`.
-- **Logging persistence**: when `logging.destination` is `dir://` or `file://`, you can persist logs with `logging.persistence.enabled`. Configuration rules are the same as for other persistent volumes.
+- **Logging persistence**: when `logging.destination` is `dir://` or `file://`, you can persist logs with `logging.persistence` in `values.yaml`, which will create a PersistentVolumeClaim (PVC) to store the log files. Configuration rules are the same as for other persistent volumes.
 - **FS data libraries**: each entry in `dataLibrary.fs` can create or reuse a PVC and is mounted at its `path`.
 
 Tip: set `existingClaim` to reuse an existing volume; otherwise set `createPvc: true` and specify `size` (and `storageClass` if needed).
@@ -534,3 +534,26 @@ Attach an IAM policy similar to the following to the role mapped via IRSA. Subst
   ]
 }
 ```
+
+
+### VictoriaLogs (optional)
+
+VictoriaLogs can be installed alongside Platforma for log storage and search.
+
+- **Reference values**: `charts/platforma/values-victoria-logs.yaml`
+- **Docs**: `https://docs.victoriametrics.com/helm/victoria-logs-single/`
+
+Install into the same namespace as your Platforma release:
+
+```sh
+# Replace <namespace>
+helm repo add vm https://victoriametrics.github.io/helm-charts/
+
+helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-single \
+  --namespace <namespace> --wait \
+  --values charts/platforma/values-victoria-logs.yaml
+
+helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-collector \
+  --namespace <namespace> \
+  --values charts/platforma/values-victoria-logs.yaml
+```

charts/platforma/Chart.yaml

@@ -20,4 +20,4 @@ annotations:
     - name: Charts repository
       url: https://github.com/milaboratory/platforma-helm-charts
     - name: Docs
-      url: https://docs.platforma.bio/
+      url: https://docs.platforma.bio/

charts/platforma/README.md

@@ -166,7 +166,7 @@ Persistence is enabled by default and controlled under `persistence`:
   - `packagesDir`: software packages
   For each you can set `existingClaim` to use existing PersistentVolumeClaim instead of automatic PVC creation for service 
   Also you can alter `size` and `storageClass`.
-- **Logging persistence**: when `logging.destination` is `dir://` or `file://`, you can persist logs with `logging.persistence.enabled`. Configuration rules are the same as for other persistent volumes.
+- **Logging persistence**: when `logging.destination` is `dir://` or `file://`, you can persist logs with `logging.persistence` in `values.yaml`, which will create a PersistentVolumeClaim (PVC) to store the log files. Configuration rules are the same as for other persistent volumes.
 - **FS data libraries**: each entry in `dataLibrary.fs` can create or reuse a PVC and is mounted at its `path`.
 
 Tip: set `existingClaim` to reuse an existing volume; otherwise set `createPvc: true` and specify `size` (and `storageClass` if needed).
@@ -534,3 +534,25 @@ Attach an IAM policy similar to the following to the role mapped via IRSA. Subst
   ]
 }
 ```
+
+### VictoriaLogs (optional)
+
+VictoriaLogs can be installed alongside Platforma for log storage and search.
+
+- **Reference values**: `charts/platforma/values-victoria-logs.yaml`
+- **Docs**: `https://docs.victoriametrics.com/helm/victoria-logs-single/`
+
+Install into the same namespace as your Platforma release:
+
+```sh
+# Replace <namespace>
+helm repo add vm https://victoriametrics.github.io/helm-charts/
+
+helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-single \
+  --namespace <namespace> --wait \
+  --values charts/platforma/values-victoria-logs.yaml
+
+helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-collector \
+  --namespace <namespace> \
+  --values charts/platforma/values-victoria-logs.yaml
+```

charts/platforma/values-victoria-logs.yaml

@@ -0,0 +1,31 @@
+
+# -- VictoriaLogs configuration
+#
+# See: https://docs.victoriametrics.com/helm/victoria-logs-single/
+victoria-logs:
+  enabled: false
+  retentionPeriod: 7d
+  persistentVolume:
+    size: 100Gi
+  fullnameOverride: victoria-logs
+  resources:
+    limits:
+      cpu: 1000m
+      memory: 2Gi
+
+victoria-logs-collector:
+  enabled: false
+  remoteWrite:
+    - url: http://victoria-logs-server:9428
+      msgField: 
+       - message.msg
+      ignoreFields:
+       - kubernetes.node_labels*
+       - kubernetes.pod_annotations*
+  resources:
+    limits:
+      cpu: 500m
+      memory: 1Gi
+    requests:
+      cpu: 250m
+      memory: 512Mi

charts/platforma/values.yaml

@@ -601,6 +601,7 @@ debug:
     # -- Annotations for the debug service.
     annotations: {}
 
+
 # =============================================================================
 # Kubernetes Resource Configuration
 # =============================================================================