DOCSP-32690 multiple mongosync endpoint note (#264) (#267)

* DOCSP-32690 multiple mongosync endpoint note

* DOCSP-32690 splitting up notes

* DOCSP-32690 adding links to multiple mongosyncs sections

* DOCSP-32690 tech edits

Author: ltran-mdb2

source/includes/api/facts/multiple-mongosync-endpoints.rst

@@ -0,0 +1,3 @@
+When you configure multiple ``mongosync`` instances to sync between
+sharded clusters, you must send identical API endpoint commands to each
+``mongosync`` instance. 

source/multiple-mongosyncs.txt

@@ -44,6 +44,8 @@ the source cluster. You must use the same version of ``mongosync``
 between all instances. For a replica set source, you can only use one
 ``mongosync`` instance. 
 
+.. include:: /includes/api/facts/multiple-mongosync-endpoints
+
 To configure multiple ``mongosync`` instances:
 
 #. :ref:`Verify cluster configuration <c2c-shard-config-verify>`
@@ -147,7 +149,6 @@ To configure multiple ``mongosync`` instances:
         Consider designating a range of ports to simplify scripting
         {+c2c-product-name+} operations.
 
-
 .. _c2c-sharded-start:
 
 Start Multiple ``mongosync`` Instances

source/reference/api/commit.txt

@@ -55,8 +55,6 @@ Before using the ``commit`` endpoint:
 - Use the :ref:`progress <c2c-api-progress>` endpoint to confirm the
   following values:
 
-  - ``state: "RUNNING"``
-  - ``canCommit: true``
   - ``lagTimeSeconds`` is near ``0`` (*Recommended, but not required*)
 
     .. note:: lagTimeSeconds
@@ -70,6 +68,15 @@ Before using the ``commit`` endpoint:
        When ``lagTimeSeconds`` is ``0``, the source and destination
        clusters are in a consistent state.
 
+  - ``state: "RUNNING"``
+  - ``canCommit: true``
+
+.. note::
+
+   .. include:: /includes/api/facts/multiple-mongosync-endpoints
+
+   For more information, see :ref:`c2c-sharded-commit`. 
+
 Request
 -------
 

source/reference/api/pause.txt

@@ -24,6 +24,13 @@ Requirement
 To use the ``pause`` endpoint, ``mongosync`` must be in the ``RUNNING``
 state.
 
+.. note::
+
+   .. include:: /includes/api/facts/multiple-mongosync-endpoints
+
+   For more information, see :ref:`Pause Multiple Mongosyncs
+   <c2c-sharded-pause>`. 
+
 Request
 -------
 

source/reference/api/resume.txt

@@ -25,6 +25,13 @@ Requirement
 To use the ``resume`` endpoint, ``mongosync`` must be in the ``PAUSED``
 state.
 
+.. note::
+
+   .. include:: /includes/api/facts/multiple-mongosync-endpoints
+
+   For more information, see :ref:`Resume Multiple Mongosyncs
+   <c2c-sharded-resume>`. 
+
 Request
 -------
 

source/reference/api/reverse.txt

@@ -52,6 +52,13 @@ To use the ``reverse`` endpoint:
 - .. include:: /includes/fact-reverse-limitation.rst
 - .. include:: /includes/fact-permissions-body.rst
 
+.. note::
+
+   .. include:: /includes/api/facts/multiple-mongosync-endpoints
+
+   For more information, see :ref:`Reverse Multiple Mongosyncs
+   <c2c-sharded-reverse>`. 
+
 .. _c2c-validate-unique-index:
 
 Validate Unique Indexes

source/reference/api/start.txt

@@ -60,6 +60,13 @@ Ensure that you use this configured ``mongosync`` user in the connection
 strings for the :setting:`cluster0` or :setting:`cluster1` settings when
 you start ``mongosync``. 
 
+.. note::
+
+   .. include:: /includes/api/facts/multiple-mongosync-endpoints
+
+   For more information, see :ref:`Start Multiple Mongosyncs
+   <c2c-sharded-start>`. 
+
 Request
 -------