Add read-only filesystem option for Beats on Docker (elastic#40092)

* Add read-only filesystem option for Beats on Docker * Update libbeat/docs/shared-docker.asciidoc Co-authored-by: Blake Rouse <[email protected]> --------- Co-authored-by: Blake Rouse <[email protected]>
cmacknz · Jul 10, 2024 · 1ce8443 · 1ce8443
1 parent b5c2796
commit 1ce8443
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/libbeat/docs/shared-docker.asciidoc b/libbeat/docs/shared-docker.asciidoc
@@ -137,6 +137,24 @@ using this syntax:
 
 endif::apm-server[]
 
+==== Run {beatname_uc} on a read-only file system
+
+If you'd like to run {beatname_uc} in a Docker container on a read-only file 
+system, you can do so by specifying the `--read-only` option.
+{beatname_uc} requires a stateful directory to store application data, so
+with the `--read-only` option you also need to use the `--mount` option to
+specify a path to where that data can be stored.
+
+For example:
+
+["source", "sh", subs="attributes"]
+--------------------------------------------
+docker run \
+  --mount type=source=$(pwd}/data,destination=/usr/share/{beatname_lc}/data
+  --read-only
+  {dockerimage}
+--------------------------------------------
+
 ==== Configure {beatname_uc} on Docker
 
 The Docker image provides several methods for configuring {beatname_uc}. The