Skip to content

Commit 6d0064c

Browse files
authored
DOCSP-44528-cutover-failure-warnings (#485)
* DOCSP-44528-cutover-failure-warnings' * DOCSP-44528-cutover-failure-warnings' * DOCSP-44528 adding disaster warning * DOCSP-44528 adding disaster warning * DOCSP-44528 copy edit * DOCSP-44528 Maria comments
1 parent bac3c5f commit 6d0064c

File tree

3 files changed

+30
-11
lines changed

3 files changed

+30
-11
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
If the source cluster shuts down before ``mongosync`` can commit, such as in
2+
a disaster scenario, the destination cluster might not have a consistent
3+
snapshot of the source data. To learn more, see :ref:`c2c-behavior-consistency`.

source/reference/cutover-process.txt

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,32 @@ You can finalize a migration and transfer your application
1616
workload from the source to the destination cluster using the
1717
:ref:`mongosync <c2c-mongosync>` cutover process.
1818

19-
``mongosync`` should remain active until it reaches the
20-
:ref:`COMMITTED <c2c-state-committed>` state. This allows ``mongosync`` to sync
21-
any additional writes that occur during the migration.
22-
2319
.. note::
2420

2521
Before you switch your application workload to the
2622
destination cluster, you should always verify a successful sync.
2723
For more information, see :ref:`c2c-verification`.
2824

25+
``mongosync`` should remain active until it reaches the
26+
:ref:`COMMITTED <c2c-state-committed>` state. This allows ``mongosync`` to sync
27+
any additional writes that occur during the migration.
28+
29+
.. warning::
30+
31+
If you do not properly cutover from your source to your
32+
destination, you may face the following issues:
33+
34+
- Inaccurate data on the destination cluster
35+
- Unrecoverable and undiagnosable ``mongosync`` errors
36+
- Reduced application availability, especially if there is
37+
application-side enforcement of document schema or other
38+
characteristics
39+
- Incomplete transactions on the destination cluster
40+
- Other unexpected cluster behavior
41+
42+
Use the following steps to safely finalize your cutover process and achieve
43+
expected ``mongosync`` behavior.
44+
2945
Steps
3046
-----
3147

@@ -115,11 +131,13 @@ Steps
115131
:language: json
116132
:copyable: false
117133

118-
.. note::
134+
After you submit a ``commit`` request, call the ``progress`` endpoint
135+
to ensure that the ``mongosync`` state is ``COMMITTING`` or
136+
``COMMITTED``.
137+
138+
.. warning::
119139

120-
After you submit a ``commit`` request, call the ``progress`` endpoint
121-
to ensure that the ``mongosync`` state is ``COMMITTING`` or
122-
``COMMITTED``.
140+
.. include:: /includes/cluster-shutdown-warning
123141

124142
.. step:: Wait until you can perform writes on the destination cluster.
125143

source/reference/mongosync/mongosync-behavior.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,9 +218,7 @@ For any continuous synchronization use cases with ``mongosync``, ensure that
218218
``mongosync`` commits before cutting over from the source to the
219219
destination.
220220

221-
If the source cluster shuts down before ``mongosync`` can commit, such as in
222-
a disaster scenario, the destination cluster might not have a consistent
223-
snapshot of the source data. To learn more, see :ref:`c2c-behavior-consistency`.
221+
.. include:: /includes/cluster-shutdown-warning
224222

225223
.. note::
226224

0 commit comments

Comments
 (0)