]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rbd: refine "Create a Block Device User" 49301/head
authorZac Dover <zac.dover@gmail.com>
Tue, 6 Dec 2022 14:20:24 +0000 (00:20 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 7 Dec 2022 11:30:08 +0000 (21:30 +1000)
Refine "Create a Block Device User" in doc/rbd/rados-rbd-cmds.rst.

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 51bc43845f03956b26c2a65fbd89a5654b860093)

doc/rbd/rados-rbd-cmds.rst

index d74efe7099f5769a6c130c9d46fdfb124b0aece2..69b6e73bcedbe334ad75492f97e4902b980f11d2 100644 (file)
@@ -28,26 +28,33 @@ Create a Block Device Pool
 Create a Block Device User
 ==========================
 
-Unless specified, the ``rbd`` command will access the Ceph cluster using the ID
-``admin``. This ID allows full administrative access to the cluster. It is
-recommended that you utilize a more restricted user wherever possible.
+Unless otherwise specified, the ``rbd`` command uses the Ceph user ID ``admin``
+to access the Ceph cluster. The ``admin`` Ceph user ID allows full
+administrative access to the cluster. We recommend that you acess the Ceph
+cluster with a Ceph user ID that has fewer permissions than the ``admin`` Ceph
+user ID does. We call this non-``admin`` Ceph user ID a "block device user" or
+"Ceph user".
 
-To `create a Ceph user`_, with ``ceph`` specify the ``auth get-or-create``
-command, user name, monitor caps, and OSD caps::
+To `create a Ceph user`_, use the ``ceph auth get-or-create`` command to
+specify user name, monitor caps (capabilities), and OSD caps (capabilities):
 
-        ceph auth get-or-create client.{ID} mon 'profile rbd' osd 'profile {profile name} [pool={pool-name}][, profile ...]' mgr 'profile rbd [pool={pool-name}]'
+.. prompt:: bash $
 
-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``, execute the
-following::
+   ceph auth get-or-create client.{ID} mon 'profile rbd' osd 'profile {profile name} [pool={pool-name}][, profile ...]' mgr 'profile rbd [pool={pool-name}]'
 
-       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'
+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
+following command:
 
-The output from the ``ceph auth get-or-create`` command will be the keyring for
-the specified user, which can be written to ``/etc/ceph/ceph.client.{ID}.keyring``.
+.. prompt:: bash $
 
-.. note:: The user ID can be specified when using the ``rbd`` command by
-        providing the ``--id {id}`` optional argument.
+   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``.
+
+.. note:: Specify the user ID by providing the ``--id {id} argument when using
+   the ``rbd`` command. This argument is optional. 
 
 Creating a Block Device Image
 =============================