Skip to content

Commit a7dcc3c

Browse files
committed
doc/radosgw: Improve formatting in layout.rst
Signed-off-by: Anthony D'Atri <[email protected]>
1 parent ef76103 commit a7dcc3c

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

doc/radosgw/layout.rst

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ new developers get up to speed with the implementation details.
99
Introduction
1010
------------
1111

12-
Swift offers something called a *container*, which we use interchangeably with
13-
the S3 term *bucket*, so we say that RGW's buckets implement Swift containers.
12+
Swift collects user objects into *containers*, which we use interchangeably with
13+
the S3 term *buckets*, so we say that RGW's buckets implement Swift containers.
1414

15-
This document does not consider how RGW _operates_ on these structures,
15+
This document does not consider how RGW *operates* on these structures,
1616
e.g. the use of ``encode()`` and ``decode()`` methods for serialization.
1717

1818
Conceptual View
@@ -25,8 +25,22 @@ metadata, bucket indexes, and (payload) data.
2525
Metadata
2626
^^^^^^^^
2727

28-
We have three 'sections' of metadata: 'user', 'bucket', and 'bucket.instance'.
29-
You can use the following commands to inspect metadata entries: ::
28+
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::
30+
31+
$ bin/radosgw-admin metadata list
32+
[
33+
"account",
34+
"bucket",
35+
"bucket.instance",
36+
"group",
37+
"otp",
38+
"roles",
39+
"topic",
40+
"user"
41+
]
42+
43+
Use commands of the following forms to inspect metadata entries: ::
3044

3145
$ radosgw-admin metadata list
3246
$ radosgw-admin metadata list bucket
@@ -37,15 +51,16 @@ You can use the following commands to inspect metadata entries: ::
3751
$ radosgw-admin metadata get bucket.instance:<bucket>:<bucket_id>
3852
$ radosgw-admin metadata get user:<user> # get or set
3953
40-
Some variables have been used in above commands, they are:
54+
Variables are used in above command examples; when issuing commands you must
55+
substitute your specific values:
4156

42-
- _user_: Holds user information
43-
- _bucket_: Holds a mapping between bucket name and bucket instance id
44-
- _bucket.instance_: Holds bucket instance information[2]
57+
- ``user``: Holds user information
58+
- ``bucket``: Holds a mapping between bucket name and bucket instance id
59+
- ``bucket.instance``: Holds bucket instance information[2]
4560

4661
Each metadata entry is kept on a single RADOS object. See below for implementation details.
4762

48-
Note that the metadata is not indexed. When listing a metadata section we do a
63+
Note that this metadata is not indexed. When listing a metadata section we do a
4964
RADOS ``pgls`` operation on the containing pool.
5065

5166
Bucket Index

0 commit comments

Comments
 (0)