doc/radosgw: move the Zone Features section to its own page

Signed-off-by: Casey Bodley <cbodley@redhat.com>
(cherry picked from commit d5ac275694bce35d37d7226b2f63934e3c277cbd)

diff --git a/doc/radosgw/index.rst b/doc/radosgw/index.rst
index f53917ad59bc496f8fe8164ec80c384e7a83ed88..5afd5b676179635b826aefa111757b134b2d83e7 100644 (file)
--- a/doc/radosgw/index.rst
+++ b/doc/radosgw/index.rst
@@ -43,6 +43,7 @@ Cluster with one API and then retrieve that data with the other API.
 
    HTTP Frontends <frontends>
    Multisite Configuration <multisite>
+   Zone Features <zone-features>
    Pool Placement and Storage Classes <placement>
    Multisite Sync Policy Configuration <multisite-sync-policy>
    Configuring Pools <pools>

diff --git a/doc/radosgw/multisite.rst b/doc/radosgw/multisite.rst
index cbd664971e7184f38914926c29471571e9f6aebe..73b94e533b1be93e2725416bf06d7b75919bd4f6 100644 (file)
--- a/doc/radosgw/multisite.rst
+++ b/doc/radosgw/multisite.rst
@@ -1600,102 +1600,5 @@ 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 and some features (see table below) are enabled by default. After upgrading an existing multisite configuration, however, new features must be enabled manually.
-
-Supported Features
-------------------
-
-+-----------------------------------+---------+----------+
-| Feature                           | Release | Default  |
-+===================================+=========+==========+
-| :ref:`feature_resharding`         | Reef    | Enabled  |
-+-----------------------------------+---------+----------+
-| :ref:`feature_compress_encrypted` | Reef    | Disabled |
-+-----------------------------------+---------+----------+
-
-.. _feature_resharding:
-
-resharding
-~~~~~~~~~~
-
-This feature 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 manually 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 RGWs and OSDs have upgraded.
-
-.. note:: Dynamic resharding is not supported in multisite deployments prior to
-   the Reef release.
-
-
-.. _feature_compress_encrypted:
-
-compress-encrypted
-~~~~~~~~~~~~~~~~~~
-
-This feature enables support for combining `Server-Side Encryption`_ and
-`Compression`_ on the same object. Object data gets compressed before encryption.
-Prior to Reef, multisite would not replicate such objects correctly, so all zones
-must upgrade to Reef or later before enabling.
-
-.. warning:: The compression ratio may leak information about the encrypted data,
-   and allow attackers to distinguish whether two same-sized objects might contain
-   the same data. Due to these security considerations, this feature is disabled
-   by default.
-
-Commands
---------
-
-Add support for a zone feature
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-On the cluster that contains the given zone:
-
-.. prompt:: bash $
-
-   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:
-
-.. prompt:: bash $
-
-   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:
-
-.. prompt:: bash $
-
-   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:
-
-.. prompt:: bash $
-
-   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
-.. _`Server-Side Encryption`: ../encryption
-.. _`Compression`: ../compression

diff --git a/doc/radosgw/zone-features.rst b/doc/radosgw/zone-features.rst
new file mode 100644 (file)
index 0000000..d397af9
--- /dev/null
+++ b/doc/radosgw/zone-features.rst
@@ -0,0 +1,98 @@
+=============
+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 and some features (see table below) are enabled by default. After upgrading an existing multisite configuration, however, new features must be enabled manually.
+
+Supported Features
+------------------
+
++-----------------------------------+---------+----------+
+| Feature                           | Release | Default  |
++===================================+=========+==========+
+| :ref:`feature_resharding`         | Reef    | Enabled  |
++-----------------------------------+---------+----------+
+| :ref:`feature_compress_encrypted` | Reef    | Disabled |
++-----------------------------------+---------+----------+
+
+.. _feature_resharding:
+
+resharding
+~~~~~~~~~~
+
+This feature 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 manually 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 RGWs and OSDs have upgraded.
+
+.. note:: Dynamic resharding is not supported in multisite deployments prior to
+   the Reef release.
+
+
+.. _feature_compress_encrypted:
+
+compress-encrypted
+~~~~~~~~~~~~~~~~~~
+
+This feature enables support for combining `Server-Side Encryption`_ and
+`Compression`_ on the same object. Object data gets compressed before encryption.
+Prior to Reef, multisite would not replicate such objects correctly, so all zones
+must upgrade to Reef or later before enabling.
+
+.. warning:: The compression ratio may leak information about the encrypted data,
+   and allow attackers to distinguish whether two same-sized objects might contain
+   the same data. Due to these security considerations, this feature is disabled
+   by default.
+
+Commands
+--------
+
+Add support for a zone feature
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On the cluster that contains the given zone:
+
+.. prompt:: bash $
+
+   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:
+
+.. prompt:: bash $
+
+   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:
+
+.. prompt:: bash $
+
+   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:
+
+.. prompt:: bash $
+
+   radosgw-admin zonegroup modify --rgw-zonegroup={zonegroup-name} --disable-feature={feature-name}
+   radosgw-admin period update --commit
+
+
+.. _`Server-Side Encryption`: ../encryption
+.. _`Compression`: ../compression