DOCSP-38149 Add documentation for mongosync cutover processs #292

kanchana-mongodb · 2024-04-03T15:15:45Z

tdq45gj

I left some comments. We swapped step 3 and step 4 in the draft doc on Monday. Sorry if it caused confusion!

tdq45gj · 2024-04-03T16:04:57Z

source/reference/cutover-process.txt

+         Ensure that the ``mongosync`` process response for the
+         ``commit`` request indicates that the ``mongosync`` state is
+         ``COMMITTING`` or ``COMMITTED``. 


Should we clarify in the note that the state is COMMITTING or COMMITTED after sending the commit request?

tdq45gj · 2024-04-03T16:10:24Z

source/reference/cutover-process.txt

+      Call the :ref:`progress <c2c-api-progress>` endpoint to determine
+      if ``canWrite`` is ``true``. If ``canWrite`` is ``false``, wait
+      until :ref:`progress <c2c-api-progress>` shows ``canWrite`` is
+      ``true``. 


The purpose of this step (checking canWrite=true) is to check the prerequisite to enable application writes. Enable application writes on the destination cluster should be immediately after this step.

tdq45gj · 2024-04-03T17:19:02Z

source/reference/cutover-process.txt

+
+      When the ``mongosync`` progress response indicates that the 
+      ``mongosync`` state is ``COMMITTED``, the cutover process is
+      complete. You can now :ref:`reverse <c2c-api-reverse>` the sync


Reverse is not a step of the cutover process. It's an option for users to fall back to use the source after the cutover process. Most users wouldn't need it. Right now it seems to be a required action in step 6. Can we clarify that it's an option after the cutover process, not a necessary step, or remove this information if you feel it doesn't fit into this page?

tdq45gj

The current sequence of steps still doesn't seem correct to me. The sequence should be:

Verify the status of the mongosync process.
Stop any write operations to the synced collections on the source
Send a commit request to mongosync.
Wait for canWrite to become true
Enable application writes on the destination cluster.
Call the progress endpoint to determine the status of the mongosync process.

tdq45gj · 2024-04-03T18:22:22Z

source/reference/cutover-process.txt

+        that write operations are stopped for the collections included
+        by the filter. 
+
+   .. step:: Call the :ref:`progress <c2c-api-progress>` endpoint.


Suggested change: Wait for canWrite to become true.

tdq45gj

LGTM, thank you!

jmd-mongo

Thank you for this addition, @kanchana-mongodb! I've left some suggestions and a question for your consideration.

Thank you!
Joe

jmd-mongo · 2024-04-04T14:20:19Z

source/reference/cutover-process.txt

+
+   .. step:: Wait until you can perform writes on the destination cluster.
+
+      Call the :ref:`progress <c2c-api-progress>` endpoint to determine


[linking suggestion]

Consider using backticks around "progress" instead of linking as this is already linked above.

jmd-mongo · 2024-04-04T14:20:29Z

source/reference/cutover-process.txt

+
+   .. step:: Enable application writes on the destination cluster.
+
+   .. step:: Call the :ref:`progress <c2c-api-progress>` endpoint to determine the status of the ``mongosync`` process.


Similar comment as on line 67.

jmd-mongo · 2024-04-04T14:20:53Z

source/reference/cutover-process.txt

+
+      Call the :ref:`progress <c2c-api-progress>` endpoint to determine
+      if ``canWrite`` is ``true``. If ``canWrite`` is ``false``, wait
+      until :ref:`progress <c2c-api-progress>` shows ``canWrite`` is


Simliar comment as on line 67.

jmd-mongo · 2024-04-04T14:24:36Z

source/reference/cutover-process.txt

+      until :ref:`progress <c2c-api-progress>` shows ``canWrite`` is
+      ``true``. 
+
+   .. step:: Enable application writes on the destination cluster.


[question]

Should there be a code example or blurb here showing how to enable writes on the destination cluster?

jmd-mongo

Thank you for these changes, @kanchana-mongodb! This issue LGTM mod a minor code formatting nit.

Thank you!
Joe

jmd-mongo · 2024-04-04T18:21:51Z

source/reference/cutover-process.txt

+
+      .. code-block:: javascript
+
+         db.adminCommand(


[code formatting suggestion]

I recommend using formatting similar to the following. It's a minor change to be less indented.

db.adminCommand( { setUserWriteBlockMode: 1, global: false } )

jmd-mongo · 2024-04-04T18:23:03Z

source/reference/cutover-process.txt

+      until :ref:`progress <c2c-api-progress>` shows ``canWrite`` is
+      ``true``. 
+
+   .. step:: Enable application writes on the destination cluster.


kanchana-mongodb force-pushed the DOCSP-38149 branch from 1eef645 to 2a455bf Compare April 3, 2024 15:23

DOCSP-38149 Add documentation for mongosync cutover processs

e1f0226

kanchana-mongodb force-pushed the DOCSP-38149 branch from 2a455bf to e1f0226 Compare April 3, 2024 15:29

tdq45gj suggested changes Apr 3, 2024

View reviewed changes

DOCSP-38149 updates for feedback

08d00cf

kanchana-mongodb force-pushed the DOCSP-38149 branch from d8cc841 to 08d00cf Compare April 3, 2024 17:58

kanchana-mongodb requested a review from tdq45gj April 3, 2024 17:59

tdq45gj suggested changes Apr 3, 2024

View reviewed changes

DOCSP-38149 updates for feedback

4e47d89

kanchana-mongodb requested a review from tdq45gj April 3, 2024 20:52

tdq45gj approved these changes Apr 4, 2024

View reviewed changes

jmd-mongo self-requested a review April 4, 2024 14:06

jmd-mongo reviewed Apr 4, 2024

View reviewed changes

kanchana-mongodb requested a review from jmd-mongo April 4, 2024 17:27

jmd-mongo approved these changes Apr 4, 2024

View reviewed changes

DOCSP-38149 updates for JD's copy feedback

57d14e7

kanchana-mongodb force-pushed the DOCSP-38149 branch from 2979c8e to 57d14e7 Compare April 4, 2024 18:49

mdb-ashley merged commit 3074037 into mongodb:master Apr 4, 2024


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

		Call the :ref:`progress <c2c-api-progress>` endpoint to determine


		.. step:: Enable application writes on the destination cluster.

		.. step:: Call the :ref:`progress <c2c-api-progress>` endpoint to determine the status of the ``mongosync`` process.

DOCSP-38149 Add documentation for mongosync cutover processs #292

DOCSP-38149 Add documentation for mongosync cutover processs #292

Uh oh!

Conversation

kanchana-mongodb commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tdq45gj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tdq45gj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tdq45gj left a comment

Choose a reason for hiding this comment

Uh oh!

jmd-mongo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmd-mongo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kanchana-mongodb commented Apr 3, 2024 •

edited

Loading