From 565fa6d1893547a7354e6f6351f7bf5168ebf290 Mon Sep 17 00:00:00 2001 From: amalhotra-mdb <135728846+amalhotra-mdb@users.noreply.github.com> Date: Mon, 24 Mar 2025 09:38:20 -0400 Subject: [PATCH] DOCSP-48525-disaster-recovery-faq-entry (#679) * DOCSP-48525-disaster-recovery-faq-entry * wording * build error * reviewer request * add important * monospace * reviewer updates * render issue (cherry picked from commit 90363207ee0fecf2e01170232ac2d517cb2f7fba) --- source/about-mongosync.txt | 4 ++++ source/faq.txt | 10 ++++++++++ .../includes/fact-no-mongosync-disaster-recovery.rst | 4 ++++ source/index.txt | 4 ++++ source/quickstart.txt | 4 ++++ source/reference/mongosync/mongosync-behavior.txt | 6 +++--- 6 files changed, 29 insertions(+), 3 deletions(-) create mode 100644 source/includes/fact-no-mongosync-disaster-recovery.rst diff --git a/source/about-mongosync.txt b/source/about-mongosync.txt index dc241ab14..e6bb8e111 100644 --- a/source/about-mongosync.txt +++ b/source/about-mongosync.txt @@ -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 `. ``mongosync`` enters different states depending on the requests it receives. The current ``mongosync`` state determines which API diff --git a/source/faq.txt b/source/faq.txt index 319b2699a..4d0df4923 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -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? --------------------------------------------------------------------------------------- @@ -52,6 +54,14 @@ To learn more about permissable reads and writes during synchronization, see Index builds on the destination cluster are treated as writes while ``mongosync`` is syncing. +Can I use ``mongosync`` to maintain a Disaster Recovery cluster? +---------------------------------------------------------------- + +No, you can't currently maintain a Disaster Recovery cluster with ``mongosync``, +since ``mongosync`` must :ref:`c2c-api-commit` in order to +safely accept traffic to the destination cluster. +For more information, see :ref:`c2c-faq-reads-writes-mongosync`. + Why are the destination cluster indexes larger than the source cluster indexes? ------------------------------------------------------------------------------- diff --git a/source/includes/fact-no-mongosync-disaster-recovery.rst b/source/includes/fact-no-mongosync-disaster-recovery.rst new file mode 100644 index 000000000..5fa1f7b1a --- /dev/null +++ b/source/includes/fact-no-mongosync-disaster-recovery.rst @@ -0,0 +1,4 @@ +Until you've called :ref:`c2c-api-commit` on ``mongosync`` and ``canWrite`` successfully +returns ``true``, the destination cluster cannot be used to accept +application read or write traffic. +Do not use ``mongosync`` for maintaining Disaster Recovery clusters. \ No newline at end of file diff --git a/source/index.txt b/source/index.txt index a2d64d517..44d71e2c2 100644 --- a/source/index.txt +++ b/source/index.txt @@ -13,6 +13,10 @@ enable {+c2c-product-name+} with the :ref:`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 `. For more detailed information, refer to the :ref:`c2c-install` or :ref:`c2c-connecting` page that best fits your diff --git a/source/quickstart.txt b/source/quickstart.txt index f805aa177..13608abe4 100644 --- a/source/quickstart.txt +++ b/source/quickstart.txt @@ -37,6 +37,10 @@ the rest of the {+c2c-product-name+} documentation. meet the minimum patch :ref:`version requirements `. +.. 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. diff --git a/source/reference/mongosync/mongosync-behavior.txt b/source/reference/mongosync/mongosync-behavior.txt index 1019637c4..c0dcc4277 100644 --- a/source/reference/mongosync/mongosync-behavior.txt +++ b/source/reference/mongosync/mongosync-behavior.txt @@ -172,9 +172,9 @@ see :ref:`connections-read-preference`. Considerations for Continuous Sync ---------------------------------- -For any continuous synchronization use cases with ``mongosync``, ensure that -``mongosync`` commits before cutting over from the source to the -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