diff --git a/source/faq.txt b/source/faq.txt index 3becd22d0..dd6c15db7 100644 --- a/source/faq.txt +++ b/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? ------------------------------------------------------------- diff --git a/source/includes/fact-restart-resume-delay.rst b/source/includes/fact-restart-resume-delay.rst new file mode 100644 index 000000000..ddf0a0ff1 --- /dev/null +++ b/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. diff --git a/source/reference/api/progress.txt b/source/reference/api/progress.txt index 8e53cdc7d..00406f5db 100644 --- a/source/reference/api/progress.txt +++ b/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 ~~~~~~~~~~~~~~~~~~~ diff --git a/source/reference/api/resume.txt b/source/reference/api/resume.txt index 334c0b0fd..32e63177a 100644 --- a/source/reference/api/resume.txt +++ b/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 ~~~~~~~~~~~~~~~~~~~ diff --git a/source/reference/mongosync-states.txt b/source/reference/mongosync-states.txt index 0b69d69f9..174fbe49b 100644 --- a/source/reference/mongosync-states.txt +++ b/source/reference/mongosync-states.txt @@ -26,6 +26,8 @@ To view the current state of ``mongosync``, use the :ref:`/progress `. endpoint. The :ref:`/progress ` endpoint returns the state in the ``state`` field. +.. include:: /includes/fact-restart-resume-delay.rst + .. _c2c-states-descriptions: State Descriptions diff --git a/source/release-notes.txt b/source/release-notes.txt index 5047706f5..4ffade3d7 100644 --- a/source/release-notes.txt +++ b/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 diff --git a/source/release-notes/1.7.txt b/source/release-notes/1.7.txt index 34113e303..83c88ca65 100644 --- a/source/release-notes/1.7.txt +++ b/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