Skip to content

Commit 3d54d69

Browse files
authored
DOCSP-38286 Enable ORR (#335)
* DOCSP-38286 Enable ORR * add to rn * add beta version * nit * * * final edits * SO feedback, monospace consistency * more edits * ED feedback * ED more feedback
1 parent 80dfb1f commit 3d54d69

File tree

5 files changed

+73
-17
lines changed

5 files changed

+73
-17
lines changed

Diff for: source/includes/document-filtering-intro.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Starting in ``mongosync-beta`` 1.8, you can selectively migrate documents based
2-
on specific conditions. To further limit which documents migrate to the
3-
destination cluster, you can combine document filtering and :ref:`namespace
4-
filtering <c2c-filtered-sync>`.
1+
Starting in {+c2c-beta-program-short+} 1.8, you can selectively migrate
2+
documents based on specific conditions. To further limit which documents migrate
3+
to the destination cluster, you can combine document filtering and
4+
:ref:`namespace filtering <c2c-filtered-sync>`.

Diff for: source/includes/orr-intro.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Starting in {+c2c-beta-program-short+} 1.8, you can enable Oplog Rollover
2+
Resilience (ORR). With ORR, ``mongosync`` applies changes made on the source
3+
cluster to the destination cluster concurrently with initial sync. For source
4+
clusters with a high write rate, ORR significantly lowers the risk of oplog
5+
rollover during initial sync and reduces the need to restart the sync.

Diff for: source/reference/beta-program.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,6 @@ Beta Features
7575
* - :ref:`c2c-beta-document-filtering`
7676
- .. include:: /includes/document-filtering-intro.rst
7777

78-
* - :ref:`c2c-beta-orr`
79-
- # DESCRIPTION TBD
80-
8178
* - :ref:`c2c-beta-destination-data-handling`
8279
- .. include:: /includes/destinationDataHandling-introduction.rst
8380

@@ -90,6 +87,9 @@ Beta Features
9087
* - :ref:`c2c-beta-many-to-one`
9188
- .. include:: /includes/many-to-one-cluster.rst
9289

90+
* - :ref:`c2c-beta-orr`
91+
- .. include:: /includes/orr-intro.rst
92+
9393
.. toctree::
9494
:titlesonly:
9595

Diff for: source/reference/beta-program/orr.txt

+54-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _c2c-beta-orr:
22

3-
================================
4-
Enable Oplog Rollover Resilience
5-
================================
3+
=========================
4+
Oplog Rollover Resilience
5+
=========================
66

77
.. default-domain:: mongodb
88

@@ -13,3 +13,54 @@ Enable Oplog Rollover Resilience
1313
:class: singlecol
1414

1515
.. include:: /includes/beta-feature.rst
16+
17+
Starting in {+c2c-beta-program-short+} 1.8, you can enable Oplog Rollover
18+
Resilience (ORR). With ORR, ``mongosync`` applies changes made on
19+
the source cluster to the destination cluster concurrently with initial sync.
20+
21+
By applying changes earlier in the sync process, ``mongosync`` maintains a more
22+
recent position in the :term:`oplog`. For source clusters with a high write
23+
rate, ORR significantly lowers the risk of oplog rollover during initial sync
24+
and reduces the need to restart the sync.
25+
26+
Syntax
27+
------
28+
29+
To enable ORR, use ``--oplogRolloverResilienceIntervalSeconds``and specify the
30+
interval, in seconds, in which ``mongosync`` checks for eligible change events
31+
in the oplog. The default value is ``-1``, which disables ORR.
32+
33+
For example, to start ``mongosync`` with the
34+
``oplogRolloverResilienceIntervalSeconds`` set to ``60`` seconds, run the
35+
following command:
36+
37+
.. code-block:: shell
38+
:copyable: false
39+
40+
./bin/mongosync \
41+
--cluster0 "mongodb://localhost:27000" \
42+
--cluster1 "mongodb://localhost:27001" \
43+
--oplogRolloverResilienceIntervalSeconds 60
44+
45+
Behavior
46+
--------
47+
48+
ORR increases the resilience of ``mongosync`` to oplog rollover during initial
49+
sync but does not prevent rollover entirely.
50+
51+
You might exceed the :term:`oplog window` if you:
52+
53+
- Sync from a high write rate source cluster for an extended
54+
period.
55+
- Pause sync for an extended period.
56+
57+
To increase the size of the oplog on the source cluster, use
58+
:setting:`~replication.oplogSizeMB`.
59+
60+
Learn More
61+
----------
62+
63+
- :ref:`c2c-beta-program`
64+
- :ref:`Change Oplog Size <tutorial-change-oplog-size>`
65+
- :ref:`Workloads that Might Requre a Large Oplog Size
66+
<replica-set-large-oplog-required>`

Diff for: source/release-notes/1.8.txt

+7-7
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,20 @@ Handle Destination Data with destinationDataHandling Option
4949

5050
For details, see :ref:`c2c-beta-destination-data-handling`.
5151

52-
Set a Migration Name
53-
````````````````````
54-
55-
.. include:: /includes/migrationName.rst
56-
57-
To learn more, see :ref:`c2c-beta-migration-name`.
58-
5952
Many-to-One Migrations
6053
``````````````````````
6154

6255
.. include:: /includes/many-to-one-cluster.rst
6356

6457
To learn more, see :ref:`c2c-beta-many-to-one`.
6558

59+
Set a Migration Name
60+
````````````````````
61+
62+
.. include:: /includes/migrationName.rst
63+
64+
To learn more, see :ref:`c2c-beta-migration-name`.
65+
6666
Other Notes
6767
~~~~~~~~~~~
6868

0 commit comments

Comments
 (0)