Adds notes about using disk-buffer in containers/kubernetes

content/headless/disk-buffer-in-container.md

@@ -0,0 +1,11 @@
+## How to use disk-buffers in containers and Kubernetes {#disk-buffer-container-kubernetes}
+
+When you are running {{% param "product_name" %}} in a container or in Kubernetes, and you want to use disk-buffers, there are some additional things to configure.
+
+- Make sure to mount the disk-buffer files and the persist file (by default, both are stored in `/var/lib/syslog-ng`) in a way they are not lost when the pod or container is restarted.
+    - In Kubernetes, add a persistent volume to your pod and store the disk buffer files (`/var/lib/syslog-ng`) there.
+    - In a container, mount the disk-buffer directory from the host, or store it on a local volume.
+- Use a reliable disk-buffer only if your storage is fast enough. For example, a low-speed persistent volume in Kubernetes can cause a significant performance degradation for {{% param "product_name" %}}.
+- Use the latest available version of {{% param "product_name" %}}, as many related improvements  and performance improvements (for example, disk-buffer related metrics) are only supported in recent versions.
+
+If you are using `syslog-ng` without disk-buffering configured, `syslog-ng` stores everything in memory, which results in great performance. If you enable disk-buffering, the performance decreases. Make sure to size your observability pipeline appropriately.

content/install/docker/_index.md

@@ -10,4 +10,6 @@ command: docker
 
 {{< readfile "/headless/docker-install-image.md" >}}
 
+{{< include-headless "disk-buffer-in-container.md" >}}
+
 {{< readfile "/headless/docker-expose-port.md" >}}

content/install/helm/_index.md

@@ -32,7 +32,7 @@ To install the `axosyslog-collector` charts, complete the following steps.
     helm repo update
     ```
 
-1. Install the chart. The following command installs `axosyslog-collector` into the `default` namespace. For the list of configurable parameters and their default values, see {{% xref "/install/helm/helm-chart-parameters.md" %}}.
+1. Install the chart. The following command installs `axosyslog-collector` into the `default` namespace. For the list of configurable parameters and their default values, see {{% xref "/install/helm/helm-chart-parameters.md" %}}. If you want to use disk-buffers, see also [How to use disk-buffers in containers and Kubernetes]({{< relref "#disk-buffer-container-kubernetes" >}}).
 
     ```bash
     helm install --generate-name axosyslog/axosyslog-collector
@@ -63,6 +63,8 @@ To install the `axosyslog-collector` charts, complete the following steps.
     axosyslog-collector-1683469360-tptfb   1/1     Running   0          28s
     ```
 
+{{< include-headless "disk-buffer-in-container.md" >}}
+
 ## Uninstall
 
 > **Tip**: List all installed releases using `helm list`.

content/install/podman/_index.md

@@ -10,4 +10,6 @@ command: podman
 
 {{< readfile "/headless/docker-install-image.md" >}}
 
+{{< include-headless "disk-buffer-in-container.md" >}}
+
 {{< readfile "/headless/docker-expose-port.md" >}}