DOCSP-45263-adding-reverse-tutorial #481

ltran-mdb2 · 2024-11-13T16:44:43Z

DESCRIPTION

Adds tutorial on reversing sync

STAGING

https://deploy-preview-481--docs-cluster-to-cluster-sync.netlify.app/reverse-sync/
https://deploy-preview-481--docs-cluster-to-cluster-sync.netlify.app/reference/api/reverse/
https://deploy-preview-481--docs-cluster-to-cluster-sync.netlify.app/topologies/multiple-mongosyncs/#reverse-the-synchronization-direction
https://deploy-preview-481--docs-cluster-to-cluster-sync.netlify.app/reference/cutover-process/

JIRA

https://jira.mongodb.org/browse/DOCSP-45263

SELF-REVIEW CHECKLIST

Does each file have 3-5 taxonomy facet tags?
See the taxonomy tagging instructions and this example PR
Is this free of any warnings or errors in the RST?
Is this free of spelling errors?
Is this free of grammatical errors?
Is this free of staging / rendering issues?
Are all the links working?

EXTERNAL REVIEW REQUIREMENTS

What's expected of an external reviewer?

netlify · 2024-11-13T16:44:59Z

✅ Deploy Preview for docs-cluster-to-cluster-sync ready!

Name	Link
🔨 Latest commit	`559f690`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-cluster-to-cluster-sync/deploys/67570cac3fcd270008375823
😎 Deploy Preview	https://deploy-preview-481--docs-cluster-to-cluster-sync.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jmd-mongo

Thanks for you work on this, @ltran-mdb2! This is a great start. I've left some comments and questions for you.

Thanks,
Joe

jmd-mongo · 2024-11-13T18:44:30Z

source/reverse-sync.txt

+.. procedure::
+   :style: normal
+
+   .. step:: Verify the status of the ``mongosync`` process.


[comment]

I think we can remove the styling backticks around mongosync in this title.

jmd-mongo · 2024-11-13T18:44:52Z

source/reverse-sync.txt

+
+      - ``lagTimeSeconds`` is small (near ``0``).
+
+        If ``lagTimeSeconds`` isn't close to ``0`` when the cutover


[question]

Can we get more specific about how close?

I will check in with the tech reviewer on this!

@ajayvijayakumar123 do you have more information on this?

I'm not sure if we have a better recommendation to give. I think for now this should be sufficient

jmd-mongo · 2024-11-13T18:45:35Z

source/reverse-sync.txt

+
+   .. step:: Stop any write operations to the synced collections on the source.
+
+      - If you started ``mongosync`` with ``enableUserWriteBlocking``


[tense]

Update to present tense. "If you start...".

jmd-mongo · 2024-11-13T18:45:50Z

source/reverse-sync.txt

+      - If you started ``mongosync`` with ``enableUserWriteBlocking``
+        set to ``true``, ``mongosync`` blocks all write operations on
+        the entire source cluster during the commit (step 4) for you.
+      - If you didn't start ``mongosync`` with


Similar comment as above re tense.

jmd-mongo · 2024-11-13T18:46:09Z

source/reverse-sync.txt

+
+   .. step:: Send a :ref:`commit <c2c-api-commit>` request to ``mongosync``.
+
+      If you started multiple ``mongosync`` instances for your


Similar comments as above re tense.

jmd-mongo · 2024-11-13T18:49:57Z

source/reverse-sync.txt

+
+      Call the ``reverse`` endpoint to reverse the direction of your sync 
+      operation. Your original source cluster becomes your new destination cluster 
+      and vice versa. 


[suggestion]

Consider rewording this. I don't think we want to use "vice versa" or other latin terms in the docs unless totally necessary.

ltran-mdb2 · 2024-11-14T16:12:50Z

Thanks for your feedback @jmd-mongo ! This should be ready for another review.

jmd-mongo

Thanks for these updates, @ltran-mdb2! This one LGTM at this point.

Thanks,
Joe

ajayvijayakumar123

A couple of questions!

source/reference/api/reverse.txt

source/reverse-sync.txt

source/reference/api/reverse.txt

source/reverse-sync.txt

ajayvijayakumar123

LGTM! Checking if @mvankeulen94 has any comments

mvankeulen94

thanks! a few notes from my end

mvankeulen94 · 2024-12-03T21:30:53Z

source/includes/commit-process.rst

+   - If ``mongosync`` uses filtered sync, it's not necessary to
+      disable writes to the entire source cluster. However, you must ensure
+      that you stop write operations for the collections that the
+      filter includes.


Can we remove this bullet since filtered sync isn't supported with reverse mode? CC @ajayvijayakumar123

Fair point. I initially made the suggestion to consolidate the common steps between the reverse and commit pages. If we want to only include the note about filtered sync on the commit page, I think we'd need to do a bit of tweaking. I imagine we can remove this note out of the common commit-process page and only add it for the commit process page.

Alternatively, we could just make the reverse sync tutorial be something like:

follow the steps from the cutover process tutorial.

Call the reverse endpoint to reverse the direction of your sync operation ... mongosync replicates all writes that you performed on your new source cluster after you unblocked writes to the new destination cluster.

That way we would just have the cutover steps on the cutover tutorial. I think I'm in favor of this option now. (Apologies for the back and forth). @ltran-mdb2 @mvankeulen94 thoughts?

Alternatively, we could just make the reverse sync tutorial be something like:

follow the steps from the cutover process tutorial.

Call the reverse endpoint to reverse the direction of your sync operation ... mongosync replicates all writes that you performed on your new source cluster after you unblocked writes to the new destination cluster.

That way we would just have the cutover steps on the cutover tutorial. I think I'm in favor of this option now. (Apologies for the back and forth). @ltran-mdb2 @mvankeulen94 thoughts?

I think this setup makes sense and am also in favor of this for clarity + minimalism. @mvankeulen94 does this work for you?

mvankeulen94 · 2024-12-03T21:35:29Z

source/includes/commit-process.rst

+      :copyable: false
+      :emphasize-lines: 5, 8
+
+.. step:: Stop any write operations to the synced collections on the source.


Can we clarify how this tutorial compares with the Finalize Cutover Process tutorial? It'd be helpful given the overlap between these two

just to add a bit more info - the major differences are:

reverse requires write blocking

reverse does not work with filtered sync

besides that, steps 1-7 should be the exactly same

If we move forward with linking to the cutover process, I will add these considerations to the reverse sync page

mvankeulen94 · 2024-12-03T21:36:50Z

source/reverse-sync.txt

+   :class: singlecol
+   :depth: 1
+
+To reverse the direction of a sync operation, use the following


it'd be helpful to add a note on why one might use reverse. E.g., the note we have here https://www.mongodb.com/docs/cluster-to-cluster-sync/current/reference/mongosync/mongosync-behavior/#considerations-for-continuous-sync

ltran-mdb2 · 2024-12-06T19:58:54Z

Hi @ajayvijayakumar123 and @mvankeulen94 thanks for all your feedback! I updated the PR based on our discussion - could you take another look when you get a chance?

ajayvijayakumar123

LGTM!

mvankeulen94

lgtm!

* DOCSP-45263-adding-reverse-tutorial * DOCSP-45263-adding-reverse-tutorial * DOCSP-45263-adding-reverse-tutorial * DOCSP-45263-adding-reverse-tutorial * DOCSP-45263-adding-reverse-tutorial * DOCSP-45263-adding-reverse-tutorial * DOCSP-45263-adding-reverse-tutorial * DOCSP-45263 copy edits * DOCSP-45263 copy edits * DOCSP-45263 adding note on multiple mongosyncs page * DOCSP-45263 tech edit * DOCSP-45263 tech edit * DOCSP-45263 linking reverse to cutover

ltran-mdb2 added 3 commits November 13, 2024 11:36

DOCSP-45263-adding-reverse-tutorial

d8673da

DOCSP-45263-adding-reverse-tutorial

ceb4b3c

DOCSP-45263-adding-reverse-tutorial

f6f5903

ltran-mdb2 added 4 commits November 13, 2024 11:49

DOCSP-45263-adding-reverse-tutorial

ad919d4

DOCSP-45263-adding-reverse-tutorial

83980b5

DOCSP-45263-adding-reverse-tutorial

bb5d6f0

DOCSP-45263-adding-reverse-tutorial

4fd575a

jmd-mongo reviewed Nov 13, 2024

View reviewed changes

ltran-mdb2 added 2 commits November 14, 2024 10:54

DOCSP-45263 copy edits

70787c3

DOCSP-45263 copy edits

0d1c329

ltran-mdb2 requested a review from jmd-mongo November 14, 2024 16:12

DOCSP-45263 adding note on multiple mongosyncs page

f5a0451

jmd-mongo approved these changes Nov 18, 2024

View reviewed changes

ajayvijayakumar123 suggested changes Nov 18, 2024

View reviewed changes

source/reference/api/reverse.txt Outdated Show resolved Hide resolved

source/reverse-sync.txt Outdated Show resolved Hide resolved

source/reference/api/reverse.txt Show resolved Hide resolved

source/reverse-sync.txt Outdated Show resolved Hide resolved

ltran-mdb2 added 2 commits November 20, 2024 09:41

DOCSP-45263 tech edit

0c6e22b

DOCSP-45263 tech edit

9e73662

ltran-mdb2 requested a review from ajayvijayakumar123 November 20, 2024 19:46

ajayvijayakumar123 approved these changes Nov 21, 2024

View reviewed changes

mvankeulen94 suggested changes Dec 3, 2024

View reviewed changes

DOCSP-45263 linking reverse to cutover

b2c86d0

ajayvijayakumar123 self-requested a review December 6, 2024 21:53

ajayvijayakumar123 approved these changes Dec 6, 2024

View reviewed changes

mvankeulen94 approved these changes Dec 6, 2024

View reviewed changes

DOCSP-45263 fixing build

559f690

ltran-mdb2 merged commit 14a154a into mongodb:v1.9 Dec 9, 2024
4 checks passed

ltran-mdb2 mentioned this pull request Dec 9, 2024

DOCSP-45263-adding-reverse-tutorial (#481) #515

Merged

ltran-mdb2 mentioned this pull request Dec 9, 2024

DOCSP-45263-adding-reverse-tutorial (#481) #516

Merged


		- ``lagTimeSeconds`` is small (near ``0``).

		If ``lagTimeSeconds`` isn't close to ``0`` when the cutover


		.. step:: Stop any write operations to the synced collections on the source.

		- If you started ``mongosync`` with ``enableUserWriteBlocking``


		.. step:: Send a :ref:`commit <c2c-api-commit>` request to ``mongosync``.

		If you started multiple ``mongosync`` instances for your

DOCSP-45263-adding-reverse-tutorial #481

DOCSP-45263-adding-reverse-tutorial #481

Uh oh!

Conversation

ltran-mdb2 commented Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIPTION

STAGING

JIRA

SELF-REVIEW CHECKLIST

EXTERNAL REVIEW REQUIREMENTS

Uh oh!

netlify bot commented Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-cluster-to-cluster-sync ready!

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!

ajayvijayakumar123 Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

ltran-mdb2 commented Nov 14, 2024

Uh oh!

jmd-mongo left a comment

Choose a reason for hiding this comment

Uh oh!

ajayvijayakumar123 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ajayvijayakumar123 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mvankeulen94 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!

Choose a reason for hiding this comment

Uh oh!

ltran-mdb2 commented Nov 13, 2024 •

edited

Loading

netlify bot commented Nov 13, 2024 •

edited

Loading

ajayvijayakumar123 Nov 21, 2024 •

edited

Loading

ajayvijayakumar123 left a comment •

edited

Loading