Skip to content

Commit 15e963b

Browse files
committed
docs: add victoria-logs description into readme
1 parent ca8197e commit 15e963b

File tree

2 files changed

+47
-2
lines changed

2 files changed

+47
-2
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Persistence is enabled by default and controlled under `persistence`:
166166
- `packagesDir`: software packages
167167
For each you can set `existingClaim` to use existing PersistentVolumeClaim instead of automatic PVC creation for service
168168
Also you can alter `size` and `storageClass`.
169-
- **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.
169+
- **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.
170170
- **FS data libraries**: each entry in `dataLibrary.fs` can create or reuse a PVC and is mounted at its `path`.
171171

172172
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
534534
]
535535
}
536536
```
537+
538+
539+
### VictoriaLogs (optional)
540+
541+
VictoriaLogs can be installed alongside Platforma for log storage and search.
542+
543+
- **Reference values**: `charts/platforma/values-victoria-logs.yaml`
544+
- **Docs**: `https://docs.victoriametrics.com/helm/victoria-logs-single/`
545+
546+
Install into the same namespace as your Platforma release:
547+
548+
```sh
549+
# Replace <namespace>
550+
helm repo add vm https://victoriametrics.github.io/helm-charts/
551+
552+
helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-single \
553+
--namespace <namespace> --wait \
554+
--values charts/platforma/values-victoria-logs.yaml
555+
556+
helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-collector \
557+
--namespace <namespace> \
558+
--values charts/platforma/values-victoria-logs.yaml
559+
```

charts/platforma/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Persistence is enabled by default and controlled under `persistence`:
166166
- `packagesDir`: software packages
167167
For each you can set `existingClaim` to use existing PersistentVolumeClaim instead of automatic PVC creation for service
168168
Also you can alter `size` and `storageClass`.
169-
- **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.
169+
- **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.
170170
- **FS data libraries**: each entry in `dataLibrary.fs` can create or reuse a PVC and is mounted at its `path`.
171171

172172
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
534534
]
535535
}
536536
```
537+
538+
### VictoriaLogs (optional)
539+
540+
VictoriaLogs can be installed alongside Platforma for log storage and search.
541+
542+
- **Reference values**: `charts/platforma/values-victoria-logs.yaml`
543+
- **Docs**: `https://docs.victoriametrics.com/helm/victoria-logs-single/`
544+
545+
Install into the same namespace as your Platforma release:
546+
547+
```sh
548+
# Replace <namespace>
549+
helm repo add vm https://victoriametrics.github.io/helm-charts/
550+
551+
helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-single \
552+
--namespace <namespace> --wait \
553+
--values charts/platforma/values-victoria-logs.yaml
554+
555+
helm install oci://ghcr.io/victoriametrics/helm-charts/victoria-logs-collector \
556+
--namespace <namespace> \
557+
--values charts/platforma/values-victoria-logs.yaml
558+
```

0 commit comments

Comments
 (0)