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

DOCSP-47288: Rename some enableUserWriteBlocking internal-only options and disallow live upgrade to 1.12 #611

Merged
merged 7 commits into from
Feb 19, 2025

Conversation

mayaraman19
Copy link
Collaborator

@mayaraman19 mayaraman19 commented Feb 12, 2025

Copy link

netlify bot commented Feb 12, 2025

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

Name Link
🔨 Latest commit 2100245
🔍 Latest deploy log https://app.netlify.com/sites/docs-cluster-to-cluster-sync/deploys/67b63686a2bdd40008f71759
😎 Deploy Preview https://deploy-preview-611--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.

@nvillahermosa-mdb nvillahermosa-mdb self-requested a review February 12, 2025 20:29
Copy link
Collaborator

@nvillahermosa-mdb nvillahermosa-mdb left a comment

Choose a reason for hiding this comment

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

Thanks @mayaraman19 , LGTM with one question

Copy link
Collaborator

@ajayvijayakumar123 ajayvijayakumar123 left a comment

Choose a reason for hiding this comment

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

LGTM % one small suggestion! Also tagging @mvankeulen94 for input


.. important::

``mongosync`` does not support live upgrades to version 1.11.
``mongosync`` does not support live upgrades to version 1.11 or 1.12.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
``mongosync`` does not support live upgrades to version 1.11 or 1.12.
``mongosync`` does not support live upgrades to version 1.12.

I think this is simpler

Choose a reason for hiding this comment

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

sure, that sgtm

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@mvankeulen94 does this get a LGTM from you as well?

@nvillahermosa-mdb
Copy link
Collaborator

@mayaraman19 , I got approval from Felipe Gaspar via Slack for the main release notes PR. Since this PR already has a dev LGTM, and C2C 1.12 is due to release today, I think we're good to merge.

Copy link
Contributor

@FGasper FGasper left a comment

Choose a reason for hiding this comment

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

The documentation should only mention true/false for this parameter as an “oh, by the way, this also works”. It is not the way we want users to use it.

Comment on lines 122 to 131
- ``true`` or ``"sourceAndDestination"``: blocks writes on the destination
cluster while the migration is in progress, and unblocks writes right
before the :ref:`/progress <c2c-api-progress>` endpoint reports
that ``canWrite`` is ``true``. Blocks writes on the source
cluster after ``mongosync`` calls the :ref:`/commit <c2c-api-commit>`
endpoint.

:gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster,
you cannot set ``enableUserWriteBlocking`` to ``true`` or
``"sourceAndDestination"``.
Copy link
Contributor

Choose a reason for hiding this comment

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

We want people to use the string rather than the bool, which is just left in for backward compatibility.

Maybe:

Suggested change
- ``true`` or ``"sourceAndDestination"``: blocks writes on the destination
cluster while the migration is in progress, and unblocks writes right
before the :ref:`/progress <c2c-api-progress>` endpoint reports
that ``canWrite`` is ``true``. Blocks writes on the source
cluster after ``mongosync`` calls the :ref:`/commit <c2c-api-commit>`
endpoint.
:gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster,
you cannot set ``enableUserWriteBlocking`` to ``true`` or
``"sourceAndDestination"``.
- ``"sourceAndDestination"``: blocks writes on the destination
cluster while the migration is in progress, and unblocks writes right
before the :ref:`/progress <c2c-api-progress>` endpoint reports
that ``canWrite`` is ``true``. Blocks writes on the source
cluster after ``mongosync`` calls the :ref:`/commit <c2c-api-commit>`
endpoint.
:gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster,
you cannot set this value.
For legacy compatibility, ``true`` is another way to express this option.

you cannot set ``enableUserWriteBlocking`` to ``true`` or
``"sourceAndDestination"``.

- ``false`` or ``"none"``: no write blocking occurs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- ``false`` or ``"none"``: no write blocking occurs.
- ``"none"``: no write blocking occurs.
For legacy compatibility, ``false`` is another way to express this option.

to ``true``. To allow the source cluster to accept writes again,
for example after running migration tests, run the following
command:
to ``true`` or ``"sourceAndDestination"``. To allow the source cluster
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
to ``true`` or ``"sourceAndDestination"``. To allow the source cluster
to ``"sourceAndDestination"``. To allow the source cluster

@mayaraman19 mayaraman19 requested a review from FGasper February 19, 2025 16:11
Copy link
Contributor

@FGasper FGasper left a comment

Choose a reason for hiding this comment

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

A couple small things.

Comment on lines 31 to 33
- You can't set the ``enableUserWriteBlocking`` option to ``true`` or
``"sourceAndDestination"`` in the ``/start`` request, so dual write-blocking
is not supported.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- You can't set the ``enableUserWriteBlocking`` option to ``true`` or
``"sourceAndDestination"`` in the ``/start`` request, so dual write-blocking
is not supported.
- You can't set the ``enableUserWriteBlocking`` option to
``"sourceAndDestination"`` in the ``/start`` request, so dual write-blocking
is not supported.


- ``"sourceAndDestination"`` for dual write-blocking
- ``"none"`` for no write-blocking

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
These options are identical to the old `true` and `false` values. The old values remain for backward compatibility.

@mayaraman19 mayaraman19 requested a review from FGasper February 19, 2025 19:54
Copy link
Contributor

@FGasper FGasper left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@ajhuh-mdb ajhuh-mdb merged commit 6072eaf into mongodb:master Feb 19, 2025
4 checks passed
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.

6 participants