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

DOCSP-48525-disaster-recovery-faq-entry #679

Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions source/about-mongosync.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ destination cluster and keeps the clusters in continuous sync until you
In addition to continuous data synchronization, ``mongosync`` can also
perform a one time data migration between clusters.

.. important::

.. include:: /includes/fact-no-mongosync-disaster-recovery.rst

``mongosync`` keeps track of its current actions through
:ref:`states <c2c-states>`. ``mongosync`` enters different states depending on
the requests it receives. The current ``mongosync`` state determines which API
Expand Down
11 changes: 10 additions & 1 deletion source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Can I change the load level while ``mongosync`` is syncing?
Yes, you can adjust the cluster workload level during a migration by
following the steps in :ref:`c2c-reconfigure-mid-migration`.

.. _c2c-faq-reads-writes-mongosync:

Can I perform reads or writes to my destination cluster while ``mongosync`` is syncing?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add this as the question right under "Can I perform reads or writes to my destination cluster while mongosync is syncing?" ?

---------------------------------------------------------------------------------------

Expand Down Expand Up @@ -232,4 +234,11 @@ Can I customize chunk distributions when syncing into a sharded cluster?
No, you can't configure ``mongosync`` to customize chunk distributions
on a destination sharded cluster. ``mongosync`` samples each collection
during initialization to determine how to distribute documents
efficiently across the destination cluster’s shards after migration.
efficiently across the destination cluster’s shards after migration.

Can I use ``mongosync`` to set up a Disaster Recovery cluster?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on second thought, it's better to say "maintain" instead of "set up" here, since the key issue is the lack of an ability to keep the cluster up to date with the source

--------------------------------------------------------------

No, you can't currently set up a Disaster Recovery cluster with ``mongosync``,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"set up" -> "maintain"

since ``mongosync`` **must commit** in order to safely accept traffic to the

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

destination cluster. For more information, see :ref:`c2c-faq-reads-writes-mongosync`.
4 changes: 4 additions & 0 deletions source/includes/fact-no-mongosync-disaster-recovery.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Until you've called commit on ``mongosync`` and ``canWrite`` successfully

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

returns ``true``, the destination cluster cannot be used to accept
application read or write traffic.
Do not use ``mongosync`` for maintaining Disaster Recovery clusters.
4 changes: 4 additions & 0 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ enable {+c2c-product-name+} with the :ref:`mongosync <c2c-mongosync>` utility.

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

.. important::

.. include:: /includes/fact-no-mongosync-disaster-recovery.rst

To get started with ``mongosync``, refer to the :ref:`Quick Start Guide
<c2c-quickstart>`. For more detailed information, refer to the
:ref:`c2c-install` or :ref:`c2c-connecting` page that best fits your
Expand Down
4 changes: 4 additions & 0 deletions source/quickstart.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ the rest of the {+c2c-product-name+} documentation.
``mongosync`` syncs writes on the source cluster for the
duration of the migration until commit is called.

.. important::

.. include:: /includes/fact-no-mongosync-disaster-recovery.rst

Follow the instructions below to set up {+c2c-product-name+}, connect
your clusters, and synchronize your data.

Expand Down
4 changes: 4 additions & 0 deletions source/reference/mongosync/mongosync-behavior.txt
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,10 @@ For any continuous synchronization use cases with ``mongosync``, ensure that
``mongosync`` commits before cutting over from the source to the

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line starting with "For any continuous synchronization" is now redundant with the new textbox so we can remove it.

destination.

.. important::

.. include:: /includes/fact-no-mongosync-disaster-recovery.rst

If the source cluster shuts down before ``mongosync`` can commit, such as in
a disaster scenario, the destination cluster might not have a consistent
snapshot of the source data. To learn more, see :ref:`c2c-behavior-consistency`.
Expand Down