Skip to content

Commit a5c8a0e

Browse files
authored
DOCSP-44803-pause-and-crash-behavior (#577) (#587)
* DOCSP-44803--pause-or-crash-behavior * DOCSP-44803-pause-and-crash-behavior * DOCSP-44803-pause-and-crash-behavior * DOCSP-44803-pause-and-crash-behavior * DOCSP-44803-pause-and-crash-behavior * DOCSP-44803-pause-and-crash-behavior * DOCSP-44803 copy edit * DOCSP-44803 copy edit * DOCSP-44803 copy edit * DOCSP-44803 tech edits (cherry picked from commit a7ba507)
1 parent 6cda014 commit a5c8a0e

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

source/reference/api/pause.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,9 @@ Behavior
7878
cluster. To learn more, see :ref:`Frequently Asked Questions
7979
<c2c-faq-increase-oplog>`.
8080

81+
For more information on the ``PAUSED`` state, see :ref:`Paused Sync
82+
Behavior <c2c-pause-behavior>`.
83+
8184
Endpoint Protection
8285
~~~~~~~~~~~~~~~~~~~
8386

source/reference/mongosync/mongosync-behavior.txt

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -394,6 +394,44 @@ Latency between the nodes of any replica set on the source or destination cluste
394394
sets. If the majority of these nodes aren't in the same region, there
395395
will be negative performance implications.
396396

397+
Interruptions During Sync
398+
-------------------------
399+
400+
The following considerations pertain to interruptions during the
401+
``mongosync`` process.
402+
403+
Errors and Crashes
404+
~~~~~~~~~~~~~~~~~~
405+
406+
If ``mongosync`` encounters an error or becomes unavailable during
407+
synchronization, or you can resume your ``mongosync`` operation from where
408+
it stopped. The ``mongosync`` binary is stateless and stores the
409+
metadata for a restart on the destination cluster.
410+
411+
To continue sync, restart ``mongosync`` once it becomes available again
412+
and use the same parameters as your interupted sync. Once you restart
413+
``mongosync``, the process resumes from where it stopped.
414+
415+
Cluster Availability
416+
~~~~~~~~~~~~~~~~~~~~
417+
418+
If your source or destination cluster crashes unexpectedly, you can safely
419+
restart ``mongosync`` from where it left off. Once your cluster is available
420+
again, restart ``mongosync`` and use the same parameters as your interupted
421+
sync.
422+
423+
.. _c2c-pause-behavior:
424+
425+
Paused Sync
426+
~~~~~~~~~~~
427+
428+
If ``mongosync`` is in the :ref:`PAUSED <c2c-state-paused>` state,
429+
``mongosync`` does not support the following actions:
430+
431+
- Upgrading the MongoDB version of the source or destination cluster
432+
- Enabling and then disabling the balancer
433+
434+
You can upgrade ``mongosync`` while it is in the ``PAUSED`` state.
397435

398436
Learn More
399437
----------

0 commit comments

Comments
 (0)