DOCSP-40138-Mongosync-Delay-After-Resume-Restart (#343)

* DOCSP-40138-Mongosync-Delay-After-Resume-Restart

* add 1.8 to toc

* *

* *

* JA feedback

* add retry bit

Author: ajhuh-mdb

source/faq.txt

@@ -102,6 +102,8 @@ available again, restart the ``mongosync`` process with the same
 parameters. ``mongosync`` resumes the operation from where it stopped
 when ``mongosync`` became unavailable.
 
+.. include:: /includes/fact-restart-resume-delay.rst
+
 Can the source or destination be a replica set with arbiters? 
 -------------------------------------------------------------
 

source/includes/fact-restart-resume-delay.rst

@@ -0,0 +1,6 @@
+.. note:: 
+   
+   Starting in ``mongosync`` 1.7.3, ``mongosync`` can take at least two minutes 
+   to respond when you resume or restart a sync operation. During this time, 
+   any calls to the :ref:`c2c-api-progress` endpoint might fail. If a 
+   ``progress`` call fails, it is safe to retry.

source/reference/api/progress.txt

@@ -64,6 +64,8 @@ Behavior
 
 - The endpoint does not auto-refresh. To get updated status, call the
   ``progress`` endpoint again.
+  
+  .. include:: /includes/fact-restart-resume-delay.rst
 
 Endpoint Protection
 ~~~~~~~~~~~~~~~~~~~

source/reference/api/resume.txt

@@ -71,12 +71,13 @@ Response
 Behavior
 --------
 
+- When you send a ``resume`` request, ``mongosync`` might take at least two 
+  minutes before resuming the migration. To see if the migration resumed, you 
+  can call the :ref:`c2c-api-progress` endpoint.
+
 - If the ``resume`` request is successful, ``mongosync`` enters the
   ``RUNNING`` state.
 
-- When you send a ``resume`` request, there may be a delay of up to a
-  few minutes before ``mongosync`` resumes the migration.
-
 Endpoint Protection
 ~~~~~~~~~~~~~~~~~~~
 

source/reference/mongosync-states.txt

@@ -26,6 +26,8 @@ To view the current state of ``mongosync``, use the :ref:`/progress
 <c2c-api-progress>`. endpoint. The :ref:`/progress <c2c-api-progress>`
 endpoint returns the state in the ``state`` field.
 
+.. include:: /includes/fact-restart-resume-delay.rst
+
 .. _c2c-states-descriptions:
 
 State Descriptions

source/release-notes.txt

@@ -38,6 +38,7 @@ Previous Rapid Releases
 .. toctree::
    :titlesonly: 
 
+   /release-notes/1.8
    /release-notes/1.7
    /release-notes/1.6
    /release-notes/1.5

source/release-notes/1.7.txt

@@ -70,6 +70,10 @@ Issues Fixed:
   events when mongosync is interrupted and resumed. This is an unlikely
   edge case.
 
+Other Changes:
+
+- Adds a two minute delay when restarting and resuming sync operations.
+
 Limitations:
 
 - You must stop the balancer on both the source and destination sharded