-
Notifications
You must be signed in to change notification settings - Fork 38
DOCSP-47288: Rename some enableUserWriteBlocking
internal-only options and disallow live upgrade to 1.12
#611
Conversation
✅ Deploy Preview for docs-cluster-to-cluster-sync ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this 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
There was a problem hiding this 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
source/includes/live-upgrade.rst
Outdated
|
||
.. important:: | ||
|
||
``mongosync`` does not support live upgrades to version 1.11. | ||
``mongosync`` does not support live upgrades to version 1.11 or 1.12. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
``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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure, that sgtm
There was a problem hiding this comment.
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?
@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. |
There was a problem hiding this 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.
source/reference/api/start.txt
Outdated
- ``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"``. |
There was a problem hiding this comment.
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:
- ``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. |
source/reference/api/start.txt
Outdated
you cannot set ``enableUserWriteBlocking`` to ``true`` or | ||
``"sourceAndDestination"``. | ||
|
||
- ``false`` or ``"none"``: no write blocking occurs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- ``false`` or ``"none"``: no write blocking occurs. | |
- ``"none"``: no write blocking occurs. | |
For legacy compatibility, ``false`` is another way to express this option. |
source/reference/api/start.txt
Outdated
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to ``true`` or ``"sourceAndDestination"``. To allow the source cluster | |
to ``"sourceAndDestination"``. To allow the source cluster |
There was a problem hiding this 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.
- You can't set the ``enableUserWriteBlocking`` option to ``true`` or | ||
``"sourceAndDestination"`` in the ``/start`` request, so dual write-blocking | ||
is not supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These options are identical to the old `true` and `false` values. The old values remain for backward compatibility. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks!
Adds
enableUserWriteBlocking
params and disallows live upgrade to 1.12. Also updates most mentions ofenableUserWriteBlocking
params to use the strings.https://jira.mongodb.org/browse/DOCSP-47288
Staging: