]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rados/operations: Address suggestions for stretch-mode.rst 63848/head
authorAnthony D'Atri <anthonyeleven@users.noreply.github.com>
Mon, 9 Jun 2025 15:02:04 +0000 (11:02 -0400)
committerZac Dover <zac.dover@proton.me>
Tue, 10 Jun 2025 12:53:12 +0000 (22:53 +1000)
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
fixup

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 3f5bf8dedd18f2f6d4afc0583be124be879667f2)
(cherry picked from commit 660d163271fd6a984be15524df6652f6aeb4b5c0)

doc/rados/operations/stretch-mode.rst

index 2e01d1c88edf75071b64a872e71debf7d3549c7e..f5d89e3517346c27ea6e07916182df9a396b340f 100644 (file)
@@ -17,8 +17,9 @@ one-third to one-half of the total cluster).
 
 Ceph is designed with the expectation that all parts of its network and cluster
 will be reliable and that failures will be distributed randomly across the
-CRUSH map. Even if a switch goes down and causes the loss of many OSDs, Ceph is
-designed so that the remaining OSDs and monitors will route around such a loss. 
+CRUSH topology. When a host or network switch goes down, many OSDs will
+become unavailable. Ceph is designed so that the remaining OSDs and
+Monitors will maintain access to data.
 
 Sometimes this cannot be relied upon. If you have a "stretched-cluster"
 deployment in which much of your cluster is behind a single network component,
@@ -28,13 +29,13 @@ We will here consider two standard configurations: a configuration with two
 data centers (or, in clouds, two availability zones), and a configuration with
 three data centers (or, in clouds, three availability zones).
 
-In the two-site configuration, Ceph expects each of the sites to hold a copy of
-the data, and Ceph also expects there to be a third site that has a tiebreaker
-monitor. This tiebreaker monitor picks a winner if the network connection fails
-and both data centers remain alive.
+In the two-site configuration, Ceph arranges for each site to hold a copy of
+the data. A third site houses a tiebreaker (arbiter, witness)
+Monitor. This tiebreaker Monitor picks a winner when a network connection
+between sites fails and both data centers remain alive.
 
-The tiebreaker monitor can be a VM. It can also have high latency relative to
-the two main sites.
+The tiebreaker monitor can be a VM. It can also have higher network latency
+to the OSD site(s) than OSD site(s) can have to each other.
 
 The standard Ceph configuration is able to survive MANY network failures or
 data-center failures without ever compromising data availability. If enough
@@ -56,8 +57,8 @@ without operator intervention.
 
 Ceph does not permit the compromise of data integrity or data consistency, but
 there are situations in which *data availability* is compromised. These
-situations can occur even though there are enough clusters available to satisfy
-Ceph's consistency and sizing constraints. In some situations, you might
+situations can occur even though there are sufficient replicas of data available to satisfy
+consistency and sizing constraints. In some situations, you might
 discover that your cluster does not satisfy those constraints.
 
 The first category of these failures that we will discuss involves inconsistent
@@ -83,10 +84,9 @@ situation is surprisingly difficult to avoid using only standard CRUSH rules.
 
 Individual Stretch Pools
 ========================
-Setting individual ``stretch pool`` is an option that allows for the configuration
-of specific pools to be distributed across ``two or more data centers``.
-This is achieved by executing the ``ceph osd pool stretch set`` command on each desired pool,
-as opposed to applying a cluster-wide configuration ``with stretch mode``.
+Setting individual ``stretch pool`` attributes allows for
+specific pools to be distributed across two or more data centers.
+This is done by executing the ``ceph osd pool stretch set`` command on each desired pool.
 See :ref:`setting_values_for_a_stretch_pool`
 
 Use ``stretch mode`` when you have exactly ``two data centers`` and require a uniform
@@ -181,8 +181,8 @@ your CRUSH map. This procedure shows how to do this.
              step emit
      }
 
-   .. warning:: If a CRUSH rule is defined for a stretch mode cluster and the
-      rule has multiple "takes" in it, then ``MAX AVAIL`` for the pools
+   .. warning:: When a CRUSH rule is defined in a stretch mode cluster and the
+      rule has multiple ``take`` steps, ``MAX AVAIL`` for the pools
       associated with the CRUSH rule will report that the available size is all
       of the available space from the datacenter, not the available space for
       the pools associated with the CRUSH rule.
@@ -258,12 +258,12 @@ your CRUSH map. This procedure shows how to do this.
       ceph mon enable_stretch_mode e stretch_rule datacenter
 
 When stretch mode is enabled, PGs will become active only when they peer
-across data centers (or across whichever CRUSH bucket type was specified),
-assuming both are alive. Pools will increase in size from the default ``3`` to
-``4``, and two copies will be expected in each site. OSDs will be allowed to
-connect to monitors only if they are in the same data center as the monitors.
-New monitors will not be allowed to join the cluster if they do not specify a
-location.
+across CRUSH ``datacenter``s (or across whichever CRUSH bucket type was specified),
+assuming both are available. Pools will increase in size from the default ``3`` to
+``4``, and two replicas will be placed at each site. OSDs will be allowed to
+connect to Monitors only if they are in the same data center as the Monitors.
+New Monitors will not be allowed to join the cluster if they do not specify a
+CRUSH location.
 
 If all OSDs and monitors in one of the data centers become inaccessible at once,
 the surviving data center enters a "degraded stretch mode". A warning will be
@@ -297,22 +297,21 @@ To exit stretch mode, run the following command:
 
 .. describe:: {crush_rule}
 
-   The CRUSH rule that the user wants all pools to move back to. If this
-   is not specified, the pools will move back to the default CRUSH rule.
+   The non-stretch CRUSH rule to use for all pools. If this
+   is not specified, the pools will move to the default CRUSH rule.
 
    :Type: String
    :Required: No.
 
-The command will move the cluster back to normal mode,
-and the cluster will no longer be in stretch mode.
-All pools will move its ``size`` and ``min_size``
-back to the default values it started with.
-At this point the user is responsible for scaling down the cluster
-to the desired number of OSDs if they choose to operate with less number of OSDs.
+This command moves the cluster back to normal mode;
+the cluster will no longer be in stretch mode.
+All pools will be set with their prior ``size`` and ``min_size``
+values. At this point the user is responsible for scaling down the cluster
+to the desired number of OSDs if they choose to operate with fewer OSDs.
 
-Please note that the command will not execute when the cluster is in
-``recovery stretch mode``. The command will only execute when the cluster
-is in ``degraded stretch mode`` or ``healthy stretch mode``.
+Note that the command will not execute when the cluster is in
+recovery stretch mode. The command executes only when the cluster
+is in degraded stretch mode or healthy stretch mode.
 
 Limitations of Stretch Mode 
 ===========================