From: Adam King <adking@redhat.com>
Date: Wed, 7 Sep 2022 19:42:30 +0000 (-0400)
Subject: doc/cephadm: document recommended syntax for mounting files with ECA
X-Git-Tag: v18.0.0~45^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F48008%2Fhead;p=ceph.git

doc/cephadm: document recommended syntax for mounting files with ECA

Mounting files with extra container args seems to not
work with some of the more intuitive syntaxes.
See https://tracker.ceph.com/issues/57338

Signed-off-by: Adam King <adking@redhat.com>
---

diff --git a/doc/cephadm/services/index.rst b/doc/cephadm/services/index.rst
index 09257e947288..23440907cc06 100644
--- a/doc/cephadm/services/index.rst
+++ b/doc/cephadm/services/index.rst
@@ -519,10 +519,32 @@ a spec like
         - host2
         - host3
     extra_container_args:
-      -  "--cpus=2"
+      - "--cpus=2"
 
 which would cause each mon daemon to be deployed with `--cpus=2`.
 
+Mounting Files with Extra Container Arguments
+---------------------------------------------
+
+A common use case for extra container arguments is to mount additional
+files within the container. However, some intuitive formats for doing
+so can cause deployment to fail (see https://tracker.ceph.com/issues/57338).
+The recommended syntax for mounting a file with extra container arguments is:
+
+.. code-block:: yaml
+
+    extra_container_args:
+      - "-v"
+      - "/absolute/file/path/on/host:/absolute/file/path/in/container"
+
+For example:
+
+.. code-block:: yaml
+
+    extra_container_args:
+      - "-v"
+      - "/opt/ceph_cert/host.cert:/etc/grafana/certs/cert_file:ro"
+
 Custom Config Files
 ===================