ceph/doc/mgr/rgw.rst

   1 .. _mgr-rgw-module:
   2
   3 RGW Module
   4 ============
   5 The rgw module helps with bootstraping and configuring RGW realm
   6 and the different related entities.
   7
   8 Enabling
   9 --------
  10
  11 The *rgw* module is enabled with::
  12
  13   ceph mgr module enable rgw
  14
  15
  16 RGW Realm Operations
  17 -----------------------
  18
  19 Bootstrapping RGW realm creates a new RGW realm entity, a new zonegroup,
  20 and a new zone. It configures a new system user that can be used for
  21 multisite sync operations, and returns a corresponding token. It sets
  22 up new RGW instances via the orchestrator.
  23
  24 It is also possible to create a new zone that connects to the master
  25 zone and synchronizes data to/from it.
  26
  27
  28 Realm Credentials Token
  29 -----------------------
  30 A new token is created when bootstrapping a new realm, and also
  31 when creating one explicitly.  The token encapsulates
  32 the master zone endpoint, and a set of credentials that are associated
  33 with a system user.
  34 Removal of this token would remove the credentials, and if the corresponding
  35 system user has no more access keys, it is removed.
  36
  37
  38 Commands
  39 --------
  40 ::
  41
  42   ceph rgw realm bootstrap
  43
  44 Create a new realm + zonegroup + zone and deploy rgw daemons via the
  45 orchestrator.  Command returns a realm token that allows new zones to easily
  46 join this realm
  47
  48 ::
  49
  50   ceph rgw zone create
  51
  52 Create a new zone and join existing realm (using the realm token)
  53
  54 ::
  55
  56   ceph rgw zone-creds create
  57
  58 Create new credentials and return a token for new zone connection
  59
  60 ::
  61
  62   ceph rgw zone-creds remove
  63
  64 Remove credentials and/or user that are associated with the specified
  65 token
  66
  67 ::
  68
  69   ceph rgw realm reconcile
  70
  71 Update the realm configuration to match the orchestrator deployment
  72
  73 ::
  74
  75   ceph rgw admin [*]
  76
  77 RGW admin command