]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rbd: refine "Create a Block Device User" 49306/head
authorZac Dover <zac.dover@gmail.com>
Wed, 7 Dec 2022 14:43:31 +0000 (00:43 +1000)
committerZac Dover <zac.dover@gmail.com>
Thu, 8 Dec 2022 00:38:52 +0000 (10:38 +1000)
Refine "Create a Block Device User", after suggestions made by Ilya
Dryomov in https://github.com/ceph/ceph/pull/49301#pullrequestreview-1208285685

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/rbd/rados-rbd-cmds.rst

index 998dc722beaed39d46dd14a587529edda1f76c60..70def1089625e382c5ce33766f9bdbe379d60fd4 100644 (file)
@@ -39,14 +39,15 @@ user ID does. We call this non-``admin`` Ceph user ID a "block device user" or
 "Ceph user".
 
 To `create a Ceph user`_, use the ``ceph auth get-or-create`` command to
-specify user name, monitor caps (capabilities), and OSD caps (capabilities):
+specify the Ceph user ID name, monitor caps (capabilities), and OSD caps
+(capabilities):
 
 .. prompt:: bash $
 
    ceph auth get-or-create client.{ID} mon 'profile rbd' osd 'profile {profile name} [pool={pool-name}][, profile ...]' mgr 'profile rbd [pool={pool-name}]'
 
-For example: to create a user ID named ``qemu`` with read-write access to the
-pool ``vms`` and read-only access to the pool ``images``, run the
+For example: to create a Ceph user ID named ``qemu`` that has read-write access
+to the pool ``vms`` and read-only access to the pool ``images``, run the
 following command:
 
 .. prompt:: bash $
@@ -54,10 +55,11 @@ following command:
    ceph auth get-or-create client.qemu mon 'profile rbd' osd 'profile rbd pool=vms, profile rbd-read-only pool=images' mgr 'profile rbd pool=images'
 
 The output from the ``ceph auth get-or-create`` command is the keyring for the
-specified user, which can be written to ``/etc/ceph/ceph.client.{ID}.keyring``.
+specified Ceph user ID, which can be written to
+``/etc/ceph/ceph.client.{ID}.keyring``.
 
-.. note:: Specify the user ID by providing the ``--id {id} argument when using
-   the ``rbd`` command. This argument is optional. 
+.. note:: Specify the Ceph user ID by providing the ``--id {id} argument when
+   using the ``rbd`` command. This argument is optional. 
 
 Creating a Block Device Image
 =============================