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
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2c394d9
write blocking params
mayaraman19 Feb 12, 2025
71ec342
release notes
mayaraman19 Feb 12, 2025
54b99dc
live upgrade fix
mayaraman19 Feb 12, 2025
2df16b7
simplifying
mayaraman19 Feb 13, 2025
d36505c
sourceanddestination
mayaraman19 Feb 19, 2025
787010c
mod
mayaraman19 Feb 19, 2025
2100245
style
mayaraman19 Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions source/includes/live-upgrade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Starting in ``mongosync`` 1.7.0, you can upgrade ``mongosync`` without
restarting data synchronization operations from the beginning. You can
only live upgrade to ``mongosync`` 1.7.3 or later from ``mongosync``
1.7.2 or later.
restarting data synchronization operations from the beginning.

.. 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

Copy link

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?

39 changes: 21 additions & 18 deletions source/reference/api/start.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,26 +117,29 @@ Request Body Parameters
* - ``enableUserWriteBlocking``
- boolean or string
- Optional
- If set to ``true``, 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.

If set to ``false``, no write blocking occurs.

If set to ``"destinationOnly"``, blocks writes on the destination
cluster while migration is in progress, and unblocks writes right
before ``canWrite`` is ``true``.

:gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster,
you cannot set ``enableUserWriteBlocking`` to ``true``.
- Supported options:

- ``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.


- ``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.


- ``"destinationOnly"``: blocks writes on the destination
cluster while migration is in progress, and unblocks writes right
before ``canWrite`` is ``true``.

To reverse sync, the ``enableUserWriteBlocking`` field must be set
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

to accept writes again, for example after running migration tests,
run the following command:

.. code-block:: shell

Expand Down
7 changes: 1 addition & 6 deletions source/reference/versioning.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,7 @@ Live Upgrade

.. versionadded:: 1.7.0

Starting in ``mongosync`` 1.7.0, you can upgrade ``mongosync`` without
restarting data synchronization operations from the beginning.

.. important::

``mongosync`` does not support live upgrades to version 1.11.
.. include:: /includes/live-upgrade.rst

After the live upgrade, ``mongosync`` continues operations that were in
progress before the upgrade.
Expand Down
4 changes: 3 additions & 1 deletion source/release-notes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ release notes.
Current Stable Release
~~~~~~~~~~~~~~~~~~~~~~

- :ref:`c2c-release-notes-1.11`
- :ref:`c2c-release-notes-1.12`

Previous Releases
~~~~~~~~~~~~~~~~~

- :ref:`c2c-release-notes-1.11`
- :ref:`c2c-release-notes-1.10`
- :ref:`c2c-release-notes-1.9`
- :ref:`c2c-release-notes-1.8`
Expand All @@ -37,6 +38,7 @@ Previous Releases
.. toctree::
:titlesonly:

1.12 </release-notes/1.12>
1.11 </release-notes/1.11>
1.10 </release-notes/1.10>
1.9 </release-notes/1.9>
Expand Down
38 changes: 38 additions & 0 deletions source/release-notes/1.12.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.. _c2c-release-notes-1.12:

================================
Release Notes for mongosync 1.12
================================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

This page describes changes and new features introduced in
{+c2c-full-product-name+} 1.12.

.. _1.12.0-c2c-release-notes:

1.12.0 Release
--------------

``enableUserWriteBlocking`` parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``enableUserWriteBlocking`` parameter in the
:ref:`/start <c2c-api-start>` API now accepts the following string options:

- ``"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.

See :ref:`c2c-api-start-params`.

Live Upgrades
~~~~~~~~~~~~~

:ref:`Live upgrades <c2c-versioning-live-upgrade>`
to version 1.12 are not supported.