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

Commit 9718c06

Browse files
committed
reviewer request
1 parent 2edf50b commit 9718c06

File tree

6 files changed

+13
-1
lines changed

6 files changed

+13
-1
lines changed

source/about-mongosync.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ 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+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
23+
2224
``mongosync`` keeps track of its current actions through
2325
:ref:`states <c2c-states>`. ``mongosync`` enters different states depending on
2426
the requests it receives. The current ``mongosync`` state determines which API

source/faq.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,5 +240,5 @@ Can I use ``mongosync`` to set up a Disaster Recovery cluster?
240240
--------------------------------------------------------------
241241

242242
No, you can't currently set up a Disaster Recovery cluster with ``mongosync``,
243-
since ``mongosync`` must commit in order to safely accept traffic to the
243+
since ``mongosync`` **must commit** in order to safely accept traffic to the
244244
destination cluster. For more information, see :ref:`c2c-faq-reads-writes-mongosync`.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Until you've called 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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ 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+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
17+
1618
To get started with ``mongosync``, refer to the :ref:`Quick Start Guide
1719
<c2c-quickstart>`. For more detailed information, refer to the
1820
:ref:`c2c-install` or :ref:`c2c-connecting` page that best fits your

source/quickstart.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ 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+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
45+
4446
Follow the instructions below to set up {+c2c-product-name+}, connect
4547
your clusters, and synchronize your data.
4648

source/reference/mongosync/mongosync-behavior.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,8 @@ For any continuous synchronization use cases with ``mongosync``, ensure that
219219
``mongosync`` commits before cutting over from the source to the
220220
destination.
221221

222+
.. include:: /includes/fact-no-mongosync-disaster-recovery.rst
223+
222224
If the source cluster shuts down before ``mongosync`` can commit, such as in
223225
a disaster scenario, the destination cluster might not have a consistent
224226
snapshot of the source data. To learn more, see :ref:`c2c-behavior-consistency`.

0 commit comments

Comments
 (0)