22
33RGW Module
44============
5- The rgw module provides a simple interface to deploy RGW multisite.
5+ The `` rgw `` module provides a simple interface to deploy RGW :ref: ` multisite ` .
66It helps with bootstrapping and configuring RGW realm, zonegroup and
77the different related entities.
88
@@ -17,19 +17,19 @@ To enable the ``rgw`` module, run the following command:
1717
1818
1919RGW Realm Operations
20- -----------------------
20+ --------------------
2121
2222Bootstrapping RGW realm creates a new RGW realm entity, a new zonegroup,
2323and a new zone. It configures a new system user that can be used for
2424multisite sync operations. Under the hood this module instructs the
2525orchestrator to create and deploy the corresponding RGW daemons. The module
26- supports both passing the arguments through the cmd line or as a spec file:
26+ supports passing the arguments through the command line or as a spec file:
2727
2828.. prompt :: bash #
2929
3030 ceph rgw realm bootstrap [--realm-name] [--zonegroup-name] [--zone-name] [--port] [--placement] [--start-radosgw]
3131
32- The command supports providing the configuration through a spec file (`-i option` ):
32+ The command supports configuration through a spec file (`` -i `` option):
3333
3434.. prompt :: bash #
3535
@@ -49,11 +49,12 @@ Following is an example of RGW multisite spec file:
4949 spec :
5050 rgw_frontend_port : 5500
5151
52- .. note :: The spec file used by RGW has the same format as the one used by the orchestrator. Thus,
53- the user can provide any orchestration supported rgw parameters including advanced
54- configuration features such as SSL certificates etc.
52+ .. note :: RGW multisite spec files follow the same format as cephadm
53+ orchestrator spec files. Thus the user can specify any supported RGW
54+ parameters including advanced configuration features such as SSL
55+ certificates etc.
5556
56- Users can also specify custom zone endpoints in the spec (or through the cmd line). In this case, no
57+ Users can also specify custom zone endpoints in the spec (or through the command line). In this case, no
5758cephadm daemons will be launched. Following is an example RGW spec file with zone endpoints:
5859
5960.. code-block :: yaml
@@ -91,7 +92,7 @@ the ``ceph rgw realm tokens`` output:
9192
9293 User can use the token to pull a realm to create secondary zone on a
9394different cluster that syncs with the master zone on the primary cluster
94- by using `ceph rgw zone create ` command and providing the corresponding token.
95+ by using `` ceph rgw zone create ` ` command and providing the corresponding token.
9596
9697Following is an example of zone spec file:
9798
@@ -112,7 +113,7 @@ Following is an example of zone spec file:
112113 ceph rgw zone create -i zone-spec.yaml
113114
114115.. note :: The spec file used by RGW has the same format as the one used by the orchestrator. Thus,
115- the user can provide any orchestration supported rgw parameters including advanced
116+ the user can provide any orchestration supported RGW parameters including advanced
116117 configuration features such as SSL certificates etc.
117118
118119Commands
@@ -122,7 +123,7 @@ Commands
122123
123124 ceph rgw realm bootstrap -i spec.yaml
124125
125- Create a new realm + zonegroup + zone and deploy rgw daemons via the
126+ Create a new realm + zonegroup + zone and deploy RGW daemons via the
126127orchestrator using the information specified in the YAML file.
127128
128129.. prompt :: bash #
@@ -141,21 +142,19 @@ Join an existing realm by creating a new secondary zone (using the realm token)
141142
142143 ceph rgw admin [*]
143144
144- RGW admin command
145-
146- Upgrading root ca certificates
145+ Upgrading Root CA Certificates
147146------------------------------
148147
149148#. Make sure that the RGW service is running.
150149#. Make sure that the RGW service is up.
151150#. Make sure that the RGW service has been upgraded to the latest release.
152- #. From the Primary cluster on the Manager node, run the following command:
151+ #. From the primary cluster on the Manager node, run the following command:
153152
154153 .. prompt :: bash #
155154
156155 ceph orch cert-store get cert cephadm_root_ca_cert
157156
158- #. On the node where the RGW service is running, store the certificate on the
157+ #. On the nodes where the RGW service is running, store the certificate on the
159158 following path::
160159
161160 /etc/pki/ca-trust/source/anchors/<cert_name>.crt
@@ -166,8 +165,8 @@ Upgrading root ca certificates
166165
167166 openssl x509 -in <cert_name>.crt -noout -text
168167
169- #. Perform the above steps on the MGR node and on the RGW node of all secondary
170- clusters.
168+ #. Perform the above steps on the Manager node and on the RGW nodes of all
169+ secondary clusters.
171170
172171#. After the certificates have been validated on all clusters, run the
173172 following command on all clusters that generate certificates:
@@ -176,7 +175,7 @@ Upgrading root ca certificates
176175
177176 update-ca-trust
178177
179- #. From the primary node , ensure that the ``curl `` command can be run by the
178+ #. From the primary cluster , ensure that the ``curl `` command can be run by the
180179 user:
181180
182181 .. prompt :: bash [user@primary-node]$
0 commit comments