doc/rgw: document zone features

Signed-off-by: Casey Bodley <cbodley@redhat.com>
This commit is contained in:
Casey Bodley 2021-03-08 12:48:13 -05:00
parent ab964c5e0a
commit 24ecdeab1f

View File

@ -1489,5 +1489,65 @@ instance.
+-------------------------------------+-----------------------------------+---------+-----------------------+
Zone Features
=============
Some multisite features require support from all zones before they can be enabled. Each zone lists its ``supported_features``, and each zonegroup lists its ``enabled_features``. Before a feature can be enabled in the zonegroup, it must be supported by all of its zones.
On creation of new zones and zonegroups, all known features are supported/enabled. After upgrading an existing multisite configuration, however, new features must be enabled manually.
Supported Features
------------------
+---------------------------+---------+
| Feature | Release |
+===========================+=========+
| :ref:`feature_resharding` | Quincy |
+---------------------------+---------+
.. _feature_resharding:
resharding
~~~~~~~~~~
Allows buckets to be resharded in a multisite configuration without interrupting the replication of their objects. When ``rgw_dynamic_resharding`` is enabled, it runs on each zone independently, and zones may choose different shard counts for the same bucket. When buckets are resharded manunally with ``radosgw-admin bucket reshard``, only that zone's bucket is modified. A zone feature should only be marked as supported after all of its radosgws and osds have upgraded.
Commands
-----------------
Add support for a zone feature
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
On the cluster that contains the given zone::
$ radosgw-admin zone modify --rgw-zone={zone-name} --enable-feature={feature-name}
$ radosgw-admin period update --commit
Remove support for a zone feature
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
On the cluster that contains the given zone::
$ radosgw-admin zone modify --rgw-zone={zone-name} --disable-feature={feature-name}
$ radosgw-admin period update --commit
Enable a zonegroup feature
~~~~~~~~~~~~~~~~~~~~~~~~~~
On any cluster in the realm::
$ radosgw-admin zonegroup modify --rgw-zonegroup={zonegroup-name} --enable-feature={feature-name}
$ radosgw-admin period update --commit
Disable a zonegroup feature
~~~~~~~~~~~~~~~~~~~~~~~~~~~
On any cluster in the realm::
$ radosgw-admin zonegroup modify --rgw-zonegroup={zonegroup-name} --disable-feature={feature-name}
$ radosgw-admin period update --commit
.. _`Pools`: ../pools
.. _`Sync Policy Config`: ../multisite-sync-policy