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

Conversation

@ltran-mdb2
Copy link
Collaborator

@ltran-mdb2 ltran-mdb2 commented Nov 13, 2024

DESCRIPTION

Adding cutover warnings

STAGING

https://deploy-preview-485--docs-cluster-to-cluster-sync.netlify.app/reference/cutover-process/
https://deploy-preview-485--docs-cluster-to-cluster-sync.netlify.app/reference/mongosync/mongosync-behavior/#considerations-for-continuous-sync

JIRA

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

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
Copy link

netlify bot commented Nov 13, 2024

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

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/docs-cluster-to-cluster-sync/deploys/673b5d379722923112c86d34
😎 Deploy Preview https://deploy-preview-485--docs-cluster-to-cluster-sync.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Collaborator

@jmd-mongo jmd-mongo left a comment

Choose a reason for hiding this comment

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

Thanks for this issue, @ltran-mdb2! This is a great start. I left a question and noted a typo.

Thanks!
Joe

If you do not properly cutover from your source to your
destination, you may face the following issues:

- Garbage data on the destination cluster
Copy link
Collaborator

Choose a reason for hiding this comment

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

[question]

Can we find a different term to use here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I changed to "unstructured and unneeded data" but also sent a slack message to Maria (ticket creator) for more clarity about what she meant by "garbage data"

- Garbage data on the destination cluster
- Commit failures with no option to rollback the sync
- Unrecoverable and undiagnosable ``mongosync`` errors
- Reduced application availibility, especially if there is
Copy link
Collaborator

Choose a reason for hiding this comment

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

[typo]

This ought to be "availability" on line 37.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed!

@ltran-mdb2 ltran-mdb2 requested a review from jmd-mongo November 14, 2024 15:33
Copy link
Collaborator

@jmd-mongo jmd-mongo left a comment

Choose a reason for hiding this comment

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

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

Thanks,
Joe

Copy link

@mvankeulen94 mvankeulen94 left a comment

Choose a reason for hiding this comment

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

thank you! a few changes from my end

If you do not properly cutover from your source to your
destination, you may face the following issues:

- Unstructured or unneeded data on the destination cluster

Choose a reason for hiding this comment

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

I think we can rephrase to "inaccurate data"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

destination, you may face the following issues:

- Unstructured or unneeded data on the destination cluster
- Commit failures with no option to rollback the sync

Choose a reason for hiding this comment

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

I think we can delete the "commit failures with no option [...]" bullet in favor of the unrecoverable and undiagnosable errors bullet below

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

- Reduced application availability, especially if there is
application-side enforcement of document schema or other
characteristics
- Missing transactions on the destination cluster

Choose a reason for hiding this comment

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

missing -> incomplete

After you submit a ``commit`` request, call the ``progress`` endpoint
to ensure that the ``mongosync`` state is ``COMMITTING`` or
``COMMITTED``.
If the source cluster shuts down before mongosync can commit, such

Choose a reason for hiding this comment

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

can we make this a repeatable snippet so we don't have the same text copied over in 2 places?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

- Missing transactions on the destination cluster
- Other unexpected cluster behavior

You must use the following steps to safely finalize your cutover process and achieve

Choose a reason for hiding this comment

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

I suggest rephrasing "You must use the following steps" to "The following steps describe how to safely finalize your cutover process [...]"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

@ltran-mdb2 ltran-mdb2 changed the title DOCSP-44528-cutover-failure-warnings' DOCSP-44528-cutover-failure-warnings Nov 18, 2024
Copy link
Contributor

@edobranov edobranov left a comment

Choose a reason for hiding this comment

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

LGTM!

@ltran-mdb2 ltran-mdb2 merged commit 6d0064c into mongodb:master Nov 18, 2024
0 of 4 checks passed
ltran-mdb2 added a commit to ltran-mdb2/docs-cluster-to-cluster-sync that referenced this pull request Nov 18, 2024
* 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

(cherry picked from commit 6d0064c)
ltran-mdb2 added a commit to ltran-mdb2/docs-cluster-to-cluster-sync that referenced this pull request Nov 18, 2024
* 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

(cherry picked from commit 6d0064c)
@ltran-mdb2
Copy link
Collaborator Author

💚 All backports created successfully

Status Branch Result
v1.9
v1.8

Questions ?

Please refer to the Backport tool documentation

ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
* 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

(cherry picked from commit 6d0064c)
ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
* 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

(cherry picked from commit 6d0064c)
ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
ltran-mdb2 added a commit that referenced this pull request Nov 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants