RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-03-11 02:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/rbd: refine "Retrieving Image Information"

Browse Source 
Refine the text and prompts in "Retrieving Image Information" in
doc/rbd/rados-rbd-cmds.rst.

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>
This commit is contained in:
Zac Dover 2022-12-09 10:25:55 +10:00
parent dc61eb4372
commit d418037b38
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/rbd/rados-rbd-cmds.rst
View File

@ -118,24 +118,39 @@ For example::
Retrieving Image Information
============================
To retrieve information from a particular image, execute the following,
but replace ``{image-name}`` with the name for the image::
To retrieve information from a particular image, run the following command, but
replace ``{image-name}`` with the name for the image:
rbd info {image-name}
.. prompt:: bash $
rbd info {image-name}
For example::
For example:
rbd info foo
.. prompt:: bash $
rbd info foo
To retrieve information from an image within a pool, execute the following,
but replace ``{image-name}`` with the name of the image and replace ``{pool-name}``
with the name of the pool::
To retrieve information from an image within a pool, run the following command,
but replace ``{image-name}`` with the name of the image and replace
``{pool-name}`` with the name of the pool:
rbd info {pool-name}/{image-name}
.. prompt:: bash $
For example::
rbd info {pool-name}/{image-name}
rbd info swimmingpool/bar
For example:
.. prompt:: bash $
rbd info swimmingpool/bar
.. note:: Other naming conventions are possible, and might conflict with the
naming convention described here. For example, ``userid/<uuid>`` is a
possible name for an RBD image, and such a name might (at the least) be
confusing. In the intrest of helping the reader of this documentation to
form a clear idea of the way that RBD images are named, we offer this
syntax: ``rbd -p {pool-name} | info {image-name}``.
Resizing a Block Device Image
=============================