]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr/orchestrator: Add hints related to custom containers to the docs 37454/head
authorVolker Theile <vtheile@suse.com>
Wed, 4 Nov 2020 13:39:40 +0000 (14:39 +0100)
committerVolker Theile <vtheile@suse.com>
Wed, 4 Nov 2020 13:39:44 +0000 (14:39 +0100)
Fixes: https://tracker.ceph.com/issues/48113
Signed-off-by: Volker Theile <vtheile@suse.com>
doc/mgr/orchestrator.rst

index 26daf96fccfd3a7b0ae46cd57dbb8bb74d9e430b..bb0a6bc68ef9a3c5735c88409306b34929b787d1 100644 (file)
@@ -446,8 +446,9 @@ A corresponding :ref:`orchestrator-cli-service-spec` must look like:
       - CONFIG_DIR
     files:
       CONFIG_DIR/foo.conf:
-          - refresh=true
-          - username=xyz
+        - refresh=true
+        - username=xyz
+        - "port: 1234"
 
 where the properties of a service specification are:
 
@@ -482,9 +483,11 @@ where the properties of a service specification are:
 * ``files``
     A dictionary, where the key is the relative path of the file and the
     value the file content. The content must be double quoted when using
-    a string. Use '\n' for line breaks in that case. Otherwise define
+    a string. Use '\\n' for line breaks in that case. Otherwise define
     multi-line content as list of strings. The given files will be created
     below the directory `/var/lib/ceph/<cluster-fsid>/<daemon-name>`.
+    The absolute path of the directory where the file will be created must
+    exist. Use the `dirs` property to create them if necessary.
 
 .. _orchestrator-cli-service-spec: