]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/glossary: add "realm" to glossary 50135/head
authorZac Dover <zac.dover@proton.me>
Wed, 15 Feb 2023 07:51:41 +0000 (17:51 +1000)
committerZac Dover <zac.dover@proton.me>
Wed, 15 Feb 2023 23:14:09 +0000 (09:14 +1000)
Add the term "Realm" to the glossary, and link to the section in the RGW
documentation that provides more information about realms.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 5e8aed3367060503c0d4c50f19e72b5ea4583a01)

doc/glossary.rst
doc/radosgw/multisite.rst

index 16594e6c2e14ce66dc896599446e19741a69b4b7..2149a76e6dab982f67c79be3bbbdec6810c44eb3 100644 (file)
                 The block storage component of Ceph. Also called "RADOS Block
                 Device" or :term:`Ceph Block Device`.
 
+        :ref:`Realm<rgw-realms>`
+                In the context of RADOS Gateway (RGW), a realm is a globally
+                unique namespace that consists of one or more zonegroups.
+
         Releases
 
                Ceph Interim Release
index dfa2fd3901f01697553b485af0d5006a8dd1745b..9728b7ce919afbe17f6803c811975962e24f689e 100644 (file)
@@ -751,6 +751,15 @@ Multi-Site Configuration Reference
 The following sections provide additional details and command-line
 usage for realms, periods, zone groups and zones.
 
+For more details on every available configuration option, please check out
+``src/common/options/rgw.yaml.in`` or go to the more comfortable :ref:`mgr-dashboard`
+configuration page (found under `Cluster`) where you can view and set all
+options easily. On the page, set the level to ``advanced`` and search for RGW,
+to see all basic and advanced configuration options with a short description.
+Expand the details of an option to reveal a longer description.
+
+.. _rgw-realms:
+
 Realms
 ------