From 6e6010a31352ecce2c4c0fdd6ed11fba43165b6b Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Sun, 19 Feb 2023 23:50:43 +1000 Subject: [PATCH] doc/rgw: refine "Setting a Zonegroup" Streamline the "Setting a Zonegroup" section by separating out the necessary prerequisite reading from the procedure itself. I also corrected a typo in the word "following" in an unrelated section. Co-authored-by: Anthony D'Atri Signed-off-by: Zac Dover --- doc/radosgw/multisite.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/radosgw/multisite.rst b/doc/radosgw/multisite.rst index df2bdb10535..6ca5ce605e7 100644 --- a/doc/radosgw/multisite.rst +++ b/doc/radosgw/multisite.rst @@ -958,7 +958,7 @@ Making a Zonegroup the Default One zonegroup in the list of zonegroups must be the default zonegroup. There can be only one default zonegroup. In the case that there is only one zonegroup which was not designated the default zonegroup when it was created, use the -folloiwng command to make it the default zonegroup. Commands of this form can +following command to make it the default zonegroup. Commands of this form can be used to change which zonegroup is the default. #. Designate a zonegroup as the default zonegroup: @@ -1131,8 +1131,8 @@ The zonegroup configuration looks like this: Setting a Zonegroup ~~~~~~~~~~~~~~~~~~~~ -The process of defining a zonegroup consists of creating a JSON object and, at -a minimum, specifying the required settings: +The process of defining a zonegroup consists of creating a JSON object and +specifying the required settings. Here is a list of the required settings: 1. ``name``: The name of the zonegroup. Required. @@ -1170,26 +1170,26 @@ a minimum, specifying the required settings: object data. Set to ``default-placement`` by default. It is also possible to set a per-user default placement in the user info for each user. -To set a zonegroup, create a JSON object that contains the required fields, -save the object to a file (e.g., ``zonegroup.json``), and run the following -command: +Setting a Zonegroup - Procedure +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. prompt:: bash # +#. To set a zonegroup, create a JSON object that contains the required fields, + save the object to a file (for example, ``zonegroup.json``), and run the + following command: + + .. prompt:: bash # - radosgw-admin zonegroup set --infile zonegroup.json + radosgw-admin zonegroup set --infile zonegroup.json -Where ``zonegroup.json`` is the JSON file you created. + Where ``zonegroup.json`` is the JSON file you created. -.. important:: The ``default`` zonegroup ``is_master`` setting is ``true`` by - default. If you create a new zonegroup and want to make it the master - zonegroup, you must either set the ``default`` zonegroup ``is_master`` - setting to ``false``, or delete the ``default`` zonegroup. + .. important:: The ``default`` zonegroup ``is_master`` setting is ``true`` by default. If you create an additional zonegroup and want to make it the master zonegroup, you must either set the ``default`` zonegroup ``is_master`` setting to ``false`` or delete the ``default`` zonegroup. -Finally, update the period: +#. Update the period: -.. prompt:: bash # + .. prompt:: bash # - radosgw-admin period update --commit + radosgw-admin period update --commit Setting a Zonegroup Map ~~~~~~~~~~~~~~~~~~~~~~~~