From: Yehuda Sadeh <yehuda@redhat.com>
Date: Tue, 2 Nov 2021 14:13:55 +0000 (-0700)
Subject: docs: document mgr/rgw module
X-Git-Tag: v17.1.0~340^2~4
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=af402c41e3140af10b0022de2e3c58bb55d3c675;p=ceph-ci.git

docs: document mgr/rgw module

Signed-off-by: Yehuda Sadeh <yehuda@redhat.com>
---

diff --git a/doc/cephadm/services/rgw.rst b/doc/cephadm/services/rgw.rst
index 47017139b76..a0b66b216c5 100644
--- a/doc/cephadm/services/rgw.rst
+++ b/doc/cephadm/services/rgw.rst
@@ -287,3 +287,4 @@ Further Reading
 ===============
 
 * :ref:`object-gateway`
+* :ref:`mgr-rgw-module`
diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst
index 7d431f22d27..5e7fcb77f93 100644
--- a/doc/mgr/index.rst
+++ b/doc/mgr/index.rst
@@ -45,6 +45,7 @@ sensible.
     Insights module <insights>
     Orchestrator module <orchestrator>
     Rook module <rook>
+    RGW module <rgw>
     MDS Autoscaler module <mds_autoscaler>
     NFS module <nfs>
     Progress Module <progress>
diff --git a/doc/mgr/rgw.rst b/doc/mgr/rgw.rst
new file mode 100644
index 00000000000..82778e5775a
--- /dev/null
+++ b/doc/mgr/rgw.rst
@@ -0,0 +1,77 @@
+.. _mgr-rgw-module:
+
+RGW Module
+============
+The rgw module helps with bootstraping and configuring RGW realm
+and the different related entities.
+
+Enabling
+--------
+
+The *rgw* module is enabled with::
+
+  ceph mgr module enable rgw
+
+
+RGW Realm Operations
+-----------------------
+
+Bootstrapping RGW realm creates a new RGW realm entity, a new zonegroup,
+and a new zone. It configures a new system user that can be used for
+multisite sync operations, and returns a corresponding token. It sets
+up new RGW instances via the orchestrator.
+
+It is also possible to create a new zone that connects to the master
+zone and synchronizes data to/from it.
+
+
+Realm Credentials Token
+-----------------------
+A new token is created when bootstrapping a new realm, and also
+when creating one explicitly.  The token encapsulates
+the master zone endpoint, and a set of credentials that are associated
+with a system user.
+Removal of this token would remove the credentials, and if the corresponding
+system user has no more access keys, it is removed.
+
+
+Commands
+--------
+::
+
+  ceph rgw realm bootstrap
+
+Create a new realm + zonegroup + zone and deploy rgw daemons via the
+orchestrator.  Command returns a realm token that allows new zones to easily
+join this realm
+
+::
+
+  ceph rgw zone create
+
+Create a new zone and join existing realm (using the realm token)
+
+::
+
+  ceph rgw zone-creds create
+
+Create new credentials and return a token for new zone connection
+
+::
+
+  ceph rgw zone-creds remove
+ 
+Remove credentials and/or user that are associated with the specified
+token
+
+::
+
+  ceph rgw realm reconcile
+
+Update the realm configuration to match the orchestrator deployment
+
+::
+
+  ceph rgw admin [*]
+
+RGW admin command