Skip to content

Commit 9885129

Browse files
Merge pull request ceph#63472 from zdover23/wip-doc-2025-05-26-mgr-rgw-62782-followup
doc/mgr: edit rgw.rst
2 parents 3c8f796 + e7f2a4b commit 9885129

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

doc/mgr/rgw.rst

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ the different related entities.
99
Enabling
1010
--------
1111

12-
The *rgw* module is enabled with::
12+
To enable the ``rgw`` module, run the following command:
1313

14-
ceph mgr module enable rgw
14+
.. prompt:: bash #
15+
16+
ceph mgr module enable rgw
1517

1618

1719
RGW Realm Operations
@@ -25,13 +27,13 @@ supports both passing the arguments through the cmd line or as a spec file:
2527

2628
.. prompt:: bash #
2729

28-
ceph rgw realm bootstrap [--realm-name] [--zonegroup-name] [--zone-name] [--port] [--placement] [--start-radosgw]
30+
ceph rgw realm bootstrap [--realm-name] [--zonegroup-name] [--zone-name] [--port] [--placement] [--start-radosgw]
2931

3032
The command supports providing the configuration through a spec file (`-i option`):
3133

3234
.. prompt:: bash #
3335

34-
ceph rgw realm bootstrap -i myrgw.yaml
36+
ceph rgw realm bootstrap -i myrgw.yaml
3537

3638
Following is an example of RGW multisite spec file:
3739

@@ -68,11 +70,11 @@ Realm Credentials Token
6870
Users can list the available tokens for the created (or already existing) realms.
6971
The token is a base64 string that encapsulates the realm information and its
7072
master zone endpoint authentication data. Following is an example of
71-
the `ceph rgw realm tokens` output:
73+
the ``ceph rgw realm tokens`` output:
7274

7375
.. prompt:: bash #
7476

75-
ceph rgw realm tokens | jq
77+
ceph rgw realm tokens | jq
7678

7779
.. code-block:: json
7880
@@ -115,28 +117,29 @@ Following is an example of zone spec file:
115117

116118
Commands
117119
--------
118-
::
119120

120-
ceph rgw realm bootstrap -i spec.yaml
121+
.. prompt:: bash #
122+
123+
ceph rgw realm bootstrap -i spec.yaml
121124

122125
Create a new realm + zonegroup + zone and deploy rgw daemons via the
123126
orchestrator using the information specified in the YAML file.
124127

125-
::
128+
.. prompt:: bash #
126129

127-
ceph rgw realm tokens
130+
ceph rgw realm tokens
128131

129132
List the tokens of all the available realms
130133

131-
::
134+
.. prompt:: bash #
132135

133-
ceph rgw zone create -i spec.yaml
136+
ceph rgw zone create -i spec.yaml
134137

135138
Join an existing realm by creating a new secondary zone (using the realm token)
136139

137-
::
140+
.. prompt:: bash #
138141

139-
ceph rgw admin [*]
142+
ceph rgw admin [*]
140143

141144
RGW admin command
142145

@@ -176,6 +179,6 @@ Upgrading root ca certificates
176179
#. From the primary node, ensure that the ``curl`` command can be run by the
177180
user:
178181

179-
.. prompt:: bash [root@primary-node]#
182+
.. prompt:: bash [user@primary-node]$
180183

181184
curl https://<host_ip>:443

0 commit comments

Comments
 (0)