consolidate rs stepdown include files

Author: kay-kim

source/includes/extracts-rs-stepdown.yaml

@@ -12,4 +12,55 @@ content: |
       election. The stepped down primary does not wait for the effects
       of the handoff. For more information, see
       :parameter:`enableElectionHandoff`.
+---
+ref: rs-stepdown-write-fail
+content: |
+   .. note::
+
+      All writes to the primary fail during the period starting when the
+      |command-method-name| |command-method| is received until either a new
+      primary is elected, or if there are no electable secondaries, the
+      original primary resumes normal operation. The time period where
+      writes fail is at maximum:
+
+      ``secondaryCatchUpPeriodSecs`` (10s by default) +
+      :rsconf:`~settings.electionTimeoutMillis` (10s by default).
+---
+ref: rs-stepdown-concurrent-ops
+content: |
+
+   The |command-method-name| |command-method| attempts to
+   terminate long running user operations that block the primary
+   from stepping down, such as an index build, a write operation or a
+   map-reduce job.
+---
+ref: rs-stepdown-eligible-secondaries
+content: |
+   The |command-method| then initiates a catchup period where it waits up to
+   ``secondaryCatchUpPeriodSeconds``, by default 10 seconds, for a
+   secondary to become up-to-date with the primary. The primary only steps
+   down if a secondary is up-to-date with the primary during the
+   catchup period to prevent :doc:`rollbacks </core/replica-set-rollbacks>`.
+
+   If no electable secondary meets this criterion by the end of the waiting
+   period, the primary does not step down and the |command-method| errors.
+   |force-option|
+
+   Once the primary steps down successfully, that node cannot become the
+   primary for the remainder of the |stepdown-secs| period,
+   which began when the node received the |command-method|.
+---
+ref: rs-stepdown-client-connections
+content: |
+   The |command-method-name| |command-method| forces all clients currently
+   connected to the database to disconnect. This helps ensure that the
+   clients maintain an accurate view of the replica set.
+
+   Because the disconnect includes the connection used to run the
+   |command-method|, you cannot retrieve the return status of the
+   |command-method| if the |command-method| completes successfully. You can
+   only retrieve the return status of the |command-method| if it errors.
+   When running the |command-method| in a script, the script should account
+   for this behavior.
+
 ...

source/includes/fact-stepdown-write-fail.rst

@@ -45,12 +45,28 @@ Behavior
 
 .. |command-method-name| replace:: :dbcommand:`replSetStepDown`
 
-.. include:: /includes/stepdown-behavior.rst
+Concurrent Operations
+~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/rs-stepdown-concurrent-ops.rst
+
+Availability of Eligible Secondaries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/rs-stepdown-eligible-secondaries.rst
+
+
+
+Client Connections
+~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/rs-stepdown-client-connections.rst
+
 
 Writes During Stepdown
 ~~~~~~~~~~~~~~~~~~~~~~
 
-.. include:: /includes/fact-stepdown-write-fail.rst
+.. include:: /includes/extracts/rs-stepdown-write-fail.rst
 
 Election Handoff
 ~~~~~~~~~~~~~~~~
@@ -70,7 +86,7 @@ The operation waits up to the default ``10`` seconds for a
 secondary to catch up. If no suitable secondary exists, the primary
 does not step down and the command errors.
 
-.. include:: /includes/fact-stepdown-write-fail.rst
+.. include:: /includes/extracts/rs-stepdown-write-fail.rst
 
 .. class:: copyable-code
 .. code-block:: javascript
@@ -85,7 +101,7 @@ down the member for ``120`` seconds, waiting up to ``15`` seconds for
 an electable secondary to catch up. If no suitable secondary exists,
 the primary does not step down and the command errors.
 
-.. include:: /includes/fact-stepdown-write-fail.rst
+.. include:: /includes/extracts/rs-stepdown-write-fail.rst
 
 .. class:: copyable-code
 .. code-block:: javascript
@@ -100,7 +116,7 @@ down the member for ``120`` seconds, waiting up to ``15`` seconds for
 an electable secondary to catch up. Because of the ``force: true``
 option, the primary steps down even if no suitable secondary exists.
 
-.. include:: /includes/fact-stepdown-write-fail.rst
+.. include:: /includes/extracts/rs-stepdown-write-fail.rst
 
 .. class:: copyable-code
 .. code-block:: javascript

source/includes/stepdown-behavior.rst

@@ -37,12 +37,27 @@ Behavior
 
 .. |command-method-name| replace:: :method:`rs.stepDown()`
 
-.. include:: /includes/stepdown-behavior.rst
+
+Concurrent Operations
+~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/rs-stepdown-concurrent-ops.rst
+
+Availability of Eligible Secondaries
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/rs-stepdown-eligible-secondaries.rst
+
+
+Client Connections
+~~~~~~~~~~~~~~~~~~
+
+.. include:: /includes/extracts/rs-stepdown-client-connections.rst
 
 Writes During Stepdown
 ~~~~~~~~~~~~~~~~~~~~~~
 
-.. include:: /includes/fact-stepdown-write-fail.rst
+.. include:: /includes/extracts/rs-stepdown-write-fail.rst
 
 Election Handoff
 ~~~~~~~~~~~~~~~~