]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: Adding --cluster option to rbd man page.
authorVikhyat Umrao <vumrao@redhat.com>
Mon, 19 Oct 2015 12:27:15 +0000 (17:57 +0530)
committerJosh Durgin <jdurgin@redhat.com>
Wed, 11 Nov 2015 06:05:59 +0000 (22:05 -0800)
Fixes #13457
Signed-off-by: Vikhyat Umrao <vumrao@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
doc/man/8/rbd.rst

index d7eb72d7c9d2295a5674eafaa6bab58ff5e1a39a..826120fa1f2ccbb4d76e445ec5db639d0fb0b3f1 100644 (file)
@@ -9,8 +9,8 @@
 Synopsis
 ========
 
-| **rbd** [ -c *ceph.conf* ] [ -m *monaddr* ] [ -p | --pool *pool* ] [
-  --size *size* ] [ --order *bits* ] [ *command* ... ]
+| **rbd** [ -c *ceph.conf* ] [ -m *monaddr* ] [--cluster *cluster name*]
+  [ -p | --pool *pool* ] [--size *size* ] [ --order *bits* ] [ *command* ... ] 
 
 
 Description
@@ -35,6 +35,10 @@ Options
 
    Connect to specified monitor (instead of looking through ceph.conf).
 
+.. option:: --cluster cluster name
+
+   Use different cluster name as compared to default cluster name *ceph*.
+
 .. option:: -p pool-name, --pool pool-name
 
    Interact with the given pool. Required by most commands.
@@ -478,6 +482,10 @@ To map an image via the kernel with cephx enabled::
 
        rbd map mypool/myimage --id admin --keyfile secretfile
 
+To map an image via the kernel with different cluster name other than default *ceph*.
+
+       rbd map mypool/myimage --cluster *cluster name*
+
 To unmap an image::
 
        rbd unmap /dev/rbd0