Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

Commit 72bcad2

Browse files
DOCSP-48525-disaster-recovery-faq-entry (#679) (#697)
* DOCSP-48525-disaster-recovery-faq-entry * wording * build error * reviewer request * add important * monospace * reviewer updates * render issue
1 parent 9407332 commit 72bcad2

File tree

6 files changed

+29
-3
lines changed

6 files changed

+29
-3
lines changed

source/about-mongosync.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ destination cluster and keeps the clusters in continuous sync until you
1919
In addition to continuous data synchronization, ``mongosync`` can also
2020
perform a one time data migration between clusters.
2121

22+
.. important::
23+
24+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
25+
2226
``mongosync`` keeps track of its current actions through
2327
:ref:`states <c2c-states>`. ``mongosync`` enters different states depending on
2428
the requests it receives. The current ``mongosync`` state determines which API

source/faq.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Can I change the load level while ``mongosync`` is syncing?
2323
Yes, you can adjust the cluster workload level during a migration by
2424
following the steps in :ref:`c2c-reconfigure-mid-migration`.
2525

26+
.. _c2c-faq-reads-writes-mongosync:
27+
2628
Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing?
2729
---------------------------------------------------------------------------------------
2830

@@ -52,6 +54,14 @@ To learn more about permissable reads and writes during synchronization, see
5254
Index builds on the destination cluster are treated as writes
5355
while ``mongosync`` is syncing.
5456

57+
Can I use ``mongosync`` to maintain a Disaster Recovery cluster?
58+
----------------------------------------------------------------
59+
60+
No, you can't currently maintain a Disaster Recovery cluster with ``mongosync``,
61+
since ``mongosync`` must :ref:`c2c-api-commit` in order to
62+
safely accept traffic to the destination cluster.
63+
For more information, see :ref:`c2c-faq-reads-writes-mongosync`.
64+
5565
Why are the destination cluster indexes larger than the source cluster indexes?
5666
-------------------------------------------------------------------------------
5767

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Until you've called :ref:`c2c-api-commit` on ``mongosync`` and ``canWrite`` successfully
2+
returns ``true``, the destination cluster cannot be used to accept
3+
application read or write traffic.
4+
Do not use ``mongosync`` for maintaining Disaster Recovery clusters.

source/index.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ enable {+c2c-product-name+} with the :ref:`mongosync <c2c-mongosync>` utility.
1313

1414
For an overview of the ``mongosync`` process, see :ref:`about-mongosync`.
1515

16+
.. important::
17+
18+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
19+
1620
To get started with ``mongosync``, refer to the :ref:`Quick Start Guide
1721
<c2c-quickstart>`. For more detailed information, refer to the
1822
:ref:`c2c-install` or :ref:`c2c-connecting` page that best fits your

source/quickstart.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ the rest of the {+c2c-product-name+} documentation.
4141
``mongosync`` syncs writes on the source cluster for the
4242
duration of the migration until commit is called.
4343

44+
.. important::
45+
46+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
47+
4448
Follow the instructions below to set up {+c2c-product-name+}, connect
4549
your clusters, and synchronize your data.
4650

source/reference/mongosync/mongosync-behavior.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,9 @@ invalid index options on the destination.
215215
Considerations for Continuous Sync
216216
----------------------------------
217217

218-
For any continuous synchronization use cases with ``mongosync``, ensure that
219-
``mongosync`` commits before cutting over from the source to the
220-
destination.
218+
.. important::
219+
220+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
221221

222222
If the source cluster shuts down before ``mongosync`` can commit, such as in
223223
a disaster scenario, the destination cluster might not have a consistent

0 commit comments

Comments
 (0)