Skip to content

Commit 452585e

Browse files
Merge pull request ceph#63005 from bluikko/doc-layout-formatting-radosgw
doc/radosgw: Promptify CLI commands and fix formatting in layout.rst
2 parents 406a8e8 + 6783245 commit 452585e

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

doc/radosgw/layout.rst

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,14 @@ Metadata
2626
^^^^^^^^
2727

2828
RGW stores multiple types of metadata. The list of types can be shown
29-
with the below command. The types as of 2025 April are shown below::
29+
with the below command. The types as of 2025 April are shown below:
30+
31+
.. prompt:: bash #
32+
33+
radosgw-admin metadata list
34+
35+
::
3036

31-
$ bin/radosgw-admin metadata list
3237
[
3338
"account",
3439
"bucket",
@@ -40,16 +45,17 @@ with the below command. The types as of 2025 April are shown below::
4045
"user"
4146
]
4247

43-
Use commands of the following forms to inspect metadata entries: ::
48+
Use commands of the following forms to inspect metadata entries:
4449

45-
$ radosgw-admin metadata list
46-
$ radosgw-admin metadata list bucket
47-
$ radosgw-admin metadata list bucket.instance
48-
$ radosgw-admin metadata list user
50+
.. prompt:: bash #
4951

50-
$ radosgw-admin metadata get bucket:<bucket>
51-
$ radosgw-admin metadata get bucket.instance:<bucket>:<bucket_id>
52-
$ radosgw-admin metadata get user:<user> # get or set
52+
radosgw-admin metadata list
53+
radosgw-admin metadata list bucket
54+
radosgw-admin metadata list bucket.instance
55+
radosgw-admin metadata list user
56+
radosgw-admin metadata get bucket:<bucket>
57+
radosgw-admin metadata get bucket.instance:<bucket>:<bucket_id>
58+
radosgw-admin metadata get user:<user> # get or set
5359

5460
Variables are used in above command examples; when issuing commands you must
5561
substitute your specific values:
@@ -119,7 +125,7 @@ is controlled by a 'policy' setting.[3]
119125
An RGW object may comprise multiple RADOS objects, the first of which
120126
is the ``HEAD`` that contains metadata including manifest, ACLs, content type,
121127
ETag, and user-defined metadata. The metadata is stored in xattrs.
122-
The ``HEAD` object may also inline up to :confval:`rgw_max_chunk_size` of object data, for efficiency
128+
The ``HEAD`` object may also inline up to :confval:`rgw_max_chunk_size` of object data, for efficiency
123129
and atomicity. This enables a convenenient tiering strategy: index pools
124130
are necessarily replicated (cannot be EC) and should be placed on fast SSD
125131
OSDs. With a mix of small/hot RGW objects and larger, warm/cold RGW
@@ -194,7 +200,7 @@ Known pools:
194200
testcont
195201

196202
namespace: ``users.uid``
197-
Contains _both_ per-user information (RGWUserInfo) in "<user>" objects
203+
Contains *both* per-user information (RGWUserInfo) in "<user>" objects
198204
and per-user lists of buckets in omaps of "<user>.buckets" objects.
199205
The "<user>" may contain the tenant if non-empty, for example::
200206

@@ -223,7 +229,7 @@ Known pools:
223229
example: ``default.7593.4__shadow_.488urDFerTYXavx4yAd-Op8mxehnvTI_1``
224230
<marker>_<key>
225231

226-
An example of a marker would be ``default.16004.1`` or `default.7593.4``.
232+
An example of a marker would be ``default.16004.1`` or ``default.7593.4``.
227233
The current format is ``<zone>.<instance_id>.<bucket_id>``. But once
228234
generated, a marker is not parsed again, so its format may change
229235
freely in the future.

0 commit comments

Comments
 (0)