]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: cephfs: fix misleading "ceph fs volume create" command
authorNathan Cutler <ncutler@suse.com>
Thu, 16 Jul 2020 12:19:29 +0000 (14:19 +0200)
committerNathan Cutler <ncutler@suse.com>
Tue, 8 Sep 2020 06:34:29 +0000 (08:34 +0200)
The "ceph fs volume create" command takes a placement string,
just like "ceph nfs cluster create" does. Align the documentation
so the placement string is explained in the same manner in both
places.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
doc/cephfs/fs-volumes.rst

index 689ad0b0fd4df871cc6ae442ffd2e74fb4b73219..3eb2a7a8fbae3ebb0e4a54a3c658659a372576a5 100644 (file)
@@ -45,9 +45,29 @@ Create a volume using::
 
     $ ceph fs volume create <vol_name> [<placement>]
 
-This creates a CephFS file system and its data and metadata pools. It also tries
-to create MDSes for the filesystem using the enabled ceph-mgr orchestrator
-module  (see :doc:`/mgr/orchestrator`) , e.g., rook.
+This creates a CephFS file system and its data and metadata pools. It can also
+try to create MDSes for the filesystem using the enabled ceph-mgr orchestrator
+module (see :doc:`/mgr/orchestrator`), e.g. rook.
+
+<vol_name> is the volume name (an arbitrary string), and
+
+<placement> is an optional string signifying which hosts should have NFS Ganesha
+daemon containers running on them and, optionally, the total number of NFS
+Ganesha daemons the cluster (should you want to have more than one NFS Ganesha
+daemon running per node). For example, the following placement string means
+"deploy NFS Ganesha daemons on nodes host1 and host2 (one daemon per host):
+
+    "host1,host2"
+
+and this placement specification says to deploy two NFS Ganesha daemons each
+on nodes host1 and host2 (for a total of four NFS Ganesha daemons in the
+cluster):
+
+    "4 host1,host2"
+
+For more details on placement specification refer to the `orchestrator doc
+<https://docs.ceph.com/docs/master/mgr/orchestrator/#placement-specification>`_
+but keep in mind that specifying the placement via a YAML file is not supported.
 
 Remove a volume using::