Skip to content

Commit 0534b26

Browse files
ajhuh-mdbjason-price-mongodbjason-price-mongodbltran-mdb2ianf-mongodb
authored
C2C Beta Docs (#370) (#375)
* C2C Beta Docs (#370) * DOCSP-29504-many-to-one-clusters (#161) * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters * DOCSP-29504-many-to-one-clusters --------- Co-authored-by: jason-price-mongodb <[email protected]> * DOCSP-31603 Document Filtering (#319) * DOCSP-31603 Document Filtering * more copy edits * example + learn more links * edit start description * add version added tag to start api page * JM feedback * FG tech feedback * formatting adjustments * external feedback * build error * link beta page * repeat * nits for readability * syntax nit * learn more link * DOCSP-38285 Beta Program Landing Page (#314) * DOCSP-39095 adding atlas search indexes limitation (#312) * DOCSP-39095 adding atlas search indexes limitation * DOCSP-39095 tech edit * DOCSP-39095 tech edit * DOCSP-39095 tech edit * DOCSP 39098 Recommend limiting DDL operations during a sync (#311) * DOCSP-39098 Recommend limiting DDL operations during a sync * DOCSP-39098 ddl warning * DOCSP-39098 ddl warning * DOCSP-39098 ddl warning * DOCSP-39098 tech edit * DOCSP-39098 tech edit * DOCSP-38018 Add Note Mongosync Cannot Mid Upgrade (#307) * DOCSP-38018 Add Note Mongosync Cannot Mid Upgrade * DOCSP-38018 Add Upgrade Consideraton * XR * DOCSP-38696 Add faq regarding fatal errors (#305) * DOCSP-38696 add faq * DOCSP-38696 jason feedback * DOCSP-39594 View Clarification (#321) * DOCSP-39211 reverse update (#320) * DOCSP-39211 reverse update * Fixes per Ajay * DOCSP-38285 Beta Program Landing Page * move toc item * add 1.8 to toc * render * snooty * feature table * swap order * stage disclaimer * move disclaimer + add intro text * get started section * beta program landing edits * conflicts * add beta flag + documetn filtering content * build errors * * * * * adjust TOC * JD feedback * JD nit --------- Co-authored-by: ltran-mdb2 <[email protected]> Co-authored-by: ianf-mongodb <[email protected]> Co-authored-by: jocelyn-mendez1 <[email protected]> Co-authored-by: Kenneth P. J. Dyer <[email protected]> * DOCSP-40106 C2C Beta Disclaimer (#329) * DOCSP-40106 C2C Beta Disclaimer * * * formatting * formatting more * remove copyable code * * * * * * * nit * DOCSP-38289-dest-data-flag (#318) * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag * DOCSP-38289-dest-data-flag --------- Co-authored-by: jason-price-mongodb <[email protected]> * DOCSP-38289-add-description-destination-handling (#333) Co-authored-by: jason-price-mongodb <[email protected]> * DOCSP-40749-many-to-one-limitation (#334) * DOCSP-40749-many-to-one-limitation * DOCSP-40749-many-to-one-limitation * DOCSP-40749-many-to-one-limitation --------- Co-authored-by: jason-price-mongodb <[email protected]> * DOCSP-40077 ABC Migrations + Migration Name Reference Page (#332) * DOCSP-40077 ABC Migrations * more edits + use cases * release notes * move content to own reference pages * build errors * nits * rename "many with one" to "many to one" * rebase * fix title names * build error * staging issue * SO feedback * data loss warning * typo * 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 * DOCSP-39059 namespace remap (#359) * DOCSP-39059 Namespace Remap * Adds request/response example * Adds request/response example * Adds RN * Adds to/from to the start parameters * Adds to/from to the start parameters * Adds to/from to the start parameters * Adds namespace page todos * Adds syntax * Fixes typo * Procedure * Procedure * Request parameters * Request parameters * Links * Minor edit * Fixes per Jonathan Wilson * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * Fixes build issue * Fixes per Jessica * Fixes per Jessica * Fixes per Jessica * update beta-program branch (#366) * DOCSP-39095 adding atlas search indexes limitation (#312) * DOCSP-39095 adding atlas search indexes limitation * DOCSP-39095 tech edit * DOCSP-39095 tech edit * DOCSP-39095 tech edit * DOCSP 39098 Recommend limiting DDL operations during a sync (#311) * DOCSP-39098 Recommend limiting DDL operations during a sync * DOCSP-39098 ddl warning * DOCSP-39098 ddl warning * DOCSP-39098 ddl warning * DOCSP-39098 tech edit * DOCSP-39098 tech edit * DOCSP-38018 Add Note Mongosync Cannot Mid Upgrade (#307) * DOCSP-38018 Add Note Mongosync Cannot Mid Upgrade * DOCSP-38018 Add Upgrade Consideraton * XR * DOCSP-38696 Add faq regarding fatal errors (#305) * DOCSP-38696 add faq * DOCSP-38696 jason feedback * DOCSP-39594 View Clarification (#321) * DOCSP-39211 reverse update (#320) * DOCSP-39211 reverse update * Fixes per Ajay * (DOCSP-40128): v1.7.3 release updates (#326) * (DOCSP-40128): v1.7.3 release notes * more updates * fix * fix * address review comments * DOCSP-38358 populating empty pages (#324) * DOCSP-38358 populating empty pages * DOCSP-38358 fixing spacing * DOCSP-38358 populating empty pages * DOCSP-38358 populating empty pages * DOCSP-38358 populating empty pages * DOCSP-38358 populating empty pages * DOCSP-38358 copy edits * DOCSP-38358 copy edits * DOCSP-38358 tech edits * DOCSP-38358 tech edits * (DOCSP-40657): Clarify patch releases for version support (#330) * (DOCSP-40657): Clarify patch releases for version support * typo * DOCSP-39156 Critical Advisory (#336) * DOCSP-39156 Critical Advisory * Adds header-rows field * Adds header-rows field * Adjusts column widths * Adjusts column widths * Adjusts column widths * Adjusts column widths * Adjusts column widths * Adds RN entries * Reworks for includes * Reworks for includes * Reworks for includes * Reworks for includes * Fixes per Sarah * Fixes per Rachael * Fixes per Rachael * Fixes per Rachael * Fixes per Rohan * Fixes per Tim * DOCSP-40742-disaster-recovery-page-updates (#340) * DOCSP-40742-disaster-recovery-page-updates * JP nit * ED nit * DOCS-41102 added code snippets cutover page (#341) * DOCS-41102 * DOCSP-41102 added to quickstart * DOCSP-41102 * DOCSP-40138-Mongosync-Delay-After-Resume-Restart (#343) * DOCSP-40138-Mongosync-Delay-After-Resume-Restart * add 1.8 to toc * * * * * JA feedback * add retry bit * DOCSP-41355 live upgrade updates (#349) * DOCSP-41355 live upgrade updates * external review * DOCSP-40105-storageEngine-limitation (#348) * DOCSP-40286 update wording (#353) * added reversing descr (#355) * DOCSP-41105 "About mongosync" page (#347) * DOCSP-41105 second draft * DOCSP-41105-2 * DOCSP-41105-2 * DOCSP-41580 creates release notes for 1.8.0 (#352) * DOCSP-41580 creates release notes for 1.8.0 * Responds to draft comments * Updates embedded verifier text and adds versions bugs were introduced * Removes embedded verifier. See #339 for embedded verifier release notes * Remove embedded verifier title * Updates release notes from sme feedback * DOCSP-41853 Updates mongosync documentation to support 1.8 release (#362) * Updates documentation for 1.8 * Update source/reference/api/progress.txt Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: Jessica <[email protected]> * DOCSP-41323 made behavior page (#356) * DOCSP-39095 adding atlas search indexes limitation (#312) * DOCSP-39095 adding atlas search indexes limitation * DOCSP-39095 tech edit * DOCSP-39095 tech edit * DOCSP-39095 tech edit * DOCSP 39098 Recommend limiting DDL operations during a sync (#311) * DOCSP-39098 Recommend limiting DDL operations during a sync * DOCSP-39098 ddl warning * DOCSP-39098 ddl warning * DOCSP-39098 ddl warning * DOCSP-39098 tech edit * DOCSP-39098 tech edit * DOCSP-38018 Add Note Mongosync Cannot Mid Upgrade (#307) * DOCSP-38018 Add Note Mongosync Cannot Mid Upgrade * DOCSP-38018 Add Upgrade Consideraton * XR * DOCSP-38696 Add faq regarding fatal errors (#305) * DOCSP-38696 add faq * DOCSP-38696 jason feedback * DOCSP-39594 View Clarification (#321) * DOCSP-39211 reverse update (#320) * DOCSP-39211 reverse update * Fixes per Ajay * (DOCSP-40128): v1.7.3 release updates (#326) * (DOCSP-40128): v1.7.3 release notes * more updates * fix * fix * address review comments * DOCSP-38358 populating empty pages (#324) * DOCSP-38358 populating empty pages * DOCSP-38358 fixing spacing * DOCSP-38358 populating empty pages * DOCSP-38358 populating empty pages * DOCSP-38358 populating empty pages * DOCSP-38358 populating empty pages * DOCSP-38358 copy edits * DOCSP-38358 copy edits * DOCSP-38358 tech edits * DOCSP-38358 tech edits * (DOCSP-40657): Clarify patch releases for version support (#330) * (DOCSP-40657): Clarify patch releases for version support * typo * DOCSP-39156 Critical Advisory (#336) * DOCSP-39156 Critical Advisory * Adds header-rows field * Adds header-rows field * Adjusts column widths * Adjusts column widths * Adjusts column widths * Adjusts column widths * Adjusts column widths * Adds RN entries * Reworks for includes * Reworks for includes * Reworks for includes * Reworks for includes * Fixes per Sarah * Fixes per Rachael * Fixes per Rachael * Fixes per Rachael * Fixes per Rohan * Fixes per Tim * DOCSP-40742-disaster-recovery-page-updates (#340) * DOCSP-40742-disaster-recovery-page-updates * JP nit * ED nit * DOCS-41102 added code snippets cutover page (#341) * DOCS-41102 * DOCSP-41102 added to quickstart * DOCSP-41102 * DOCSP-40138-Mongosync-Delay-After-Resume-Restart (#343) * DOCSP-40138-Mongosync-Delay-After-Resume-Restart * add 1.8 to toc * * * * * JA feedback * add retry bit * DOCSP-41355 live upgrade updates (#349) * DOCSP-41355 live upgrade updates * external review * DOCSP-40105-storageEngine-limitation (#348) * DOCSP-40286 update wording (#353) * added reversing descr (#355) * DOCSP-41105 "About mongosync" page (#347) * DOCSP-41105 second draft * DOCSP-41105-2 * DOCSP-41105-2 * DOCSP-41580 creates release notes for 1.8.0 (#352) * DOCSP-41580 creates release notes for 1.8.0 * Responds to draft comments * Updates embedded verifier text and adds versions bugs were introduced * Removes embedded verifier. See #339 for embedded verifier release notes * Remove embedded verifier title * Updates release notes from sme feedback * DOCSP-41853 Updates mongosync documentation to support 1.8 release (#362) * Updates documentation for 1.8 * Update source/reference/api/progress.txt Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: Jessica <[email protected]> * DOCSP-41323 made behavior page (#356) --------- Co-authored-by: ltran-mdb2 <[email protected]> Co-authored-by: ianf-mongodb <[email protected]> Co-authored-by: jocelyn-mendez1 <[email protected]> Co-authored-by: Kenneth P. J. Dyer <[email protected]> Co-authored-by: Jeff Allen <[email protected]> Co-authored-by: sonderdonk-mdb <[email protected]> Co-authored-by: jmd-mongo <[email protected]> Co-authored-by: Jonathan Wilson <[email protected]> Co-authored-by: Jessica <[email protected]> * DOCSP-41581-beta-docs-cleanup (#364) * DOCSP-41581-beta-docs-cleanup * finalize release notes * update links + delete migrationName page * build errors * more build errors * review comments * external feedback * external feedback pt 2 * * * adjust table width, text, add namespace remapping, newline in rn * title spacing * * * table space * * * fix column * clarification sentence on 1.8 features + beta * wording --------- Co-authored-by: jason-price-mongodb <[email protected]> Co-authored-by: jason-price-mongodb <[email protected]> Co-authored-by: ltran-mdb2 <[email protected]> Co-authored-by: ianf-mongodb <[email protected]> Co-authored-by: jocelyn-mendez1 <[email protected]> Co-authored-by: Kenneth P. J. Dyer <[email protected]> Co-authored-by: Jeff Allen <[email protected]> Co-authored-by: sonderdonk-mdb <[email protected]> Co-authored-by: jmd-mongo <[email protected]> Co-authored-by: Jonathan Wilson <[email protected]> Co-authored-by: Jessica <[email protected]> * fix release date --------- Co-authored-by: jason-price-mongodb <[email protected]> Co-authored-by: jason-price-mongodb <[email protected]> Co-authored-by: ltran-mdb2 <[email protected]> Co-authored-by: ianf-mongodb <[email protected]> Co-authored-by: jocelyn-mendez1 <[email protected]> Co-authored-by: Kenneth P. J. Dyer <[email protected]> Co-authored-by: Jeff Allen <[email protected]> Co-authored-by: sonderdonk-mdb <[email protected]> Co-authored-by: jmd-mongo <[email protected]> Co-authored-by: Jonathan Wilson <[email protected]> Co-authored-by: Jessica <[email protected]>
1 parent 3604f05 commit 0534b26

29 files changed

+1005
-9
lines changed

Diff for: ‎snooty.toml

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ toc_landing_pages = ["/quickstart",
2121
"/multiple-mongosyncs",
2222
"/release-notes/release-notes",
2323
"/faq",
24+
"/reference/beta-program",
2425
"/reference/collection-level-filtering",
2526
"/reference/verification",
2627
"/reference/mongosync"
@@ -33,6 +34,8 @@ version-dev = "1.8"
3334
c2c-product-name = "Cluster-to-Cluster Sync"
3435
c2c-full-product-name = "MongoDB Cluster-to-Cluster Sync"
3536
mdb-download-center = "`MongoDB Download Center <https://www.mongodb.com/try/download/mongosync>`__"
37+
c2c-full-beta-program = "Cluster-to-Cluster Sync Beta Program"
38+
c2c-beta-program-short = "``mongosync`` beta"
3639

3740
[substitutions]
3841
c2c-product-name = "Cluster-to-Cluster Sync"

Diff for: ‎source/includes/abc-migration-intro.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Starting in {+c2c-beta-program-short+} 1.8, you can perform A->B->C migrations.
2+
A->B->C migrations allow you to perform two consecutive migrations, where the
3+
destination cluster of the first migration acts as the source cluster for the
4+
second migration.

Diff for: ‎source/includes/api/requests/start-namespace-remap.sh

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
curl -X POST "http://localhost:27182/api/v1/start" --data '
2+
{
3+
"source": "cluster0",
4+
"destination": "cluster1",
5+
"namespaceRemap": [
6+
{
7+
"from": {
8+
"database": "accounts",
9+
},
10+
"to": {
11+
"database": "sales",
12+
}
13+
}
14+
]
15+
} '

Diff for: ‎source/includes/beta-feature.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. important:: Cluster-to-Cluster Sync Beta Program
2+
3+
This feature is only available in {+c2c-beta-program-short+}. To learn more,
4+
see :ref:`c2c-beta-program`.

Diff for: ‎source/includes/beta-program-intro.rst

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Starting in version 1.8.0, {+c2c-product-name+} introduces the
2+
{+c2c-full-beta-program+}. With {+c2c-beta-program-short+}, you can use
3+
experimental features with direct support and assistance from MongoDB.

Diff for: ‎source/includes/destinationDataHandling-introduction.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Starting in {+c2c-beta-program-short+} 1.8, use the ``destinationDataHandling``
2+
option in the start request to define what happens if the destination
3+
cluster already has user data. Earlier ``mongosync`` versions return an
4+
error if the destination cluster has user data.

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

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
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/document-filtering-limitations.rst

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
- ``field`` names can't contain dots (``.``) or dollar signs (``$``).
2+
3+
- ``matchValues`` array items can be the following BSON types:
4+
5+
- All number types
6+
- Binary
7+
- Booleans
8+
- Datetime
9+
- ObjectID
10+
- Strings
11+
12+
- Documents must not move in or out of the filter during migration.
13+
14+
- If the document filter contains a string and at least one migrated collection
15+
with non-default collation, ``mongosync`` fails immediately.
16+
17+
- If you call the :ref:`progress <c2c-api-progress>` API endpoint and use a
18+
:ref:`document filter <c2c-beta-document-filtering>`, the
19+
``estimatedTotalBytes`` response field returns ``null``.
20+
21+
- The destination cluster must not contain pre-existing data that matches the
22+
filter.
23+
24+
- You can't specify a document filter and set the ``reversible`` flag to
25+
``true``.

Diff for: ‎source/includes/fact-valid-namespace-remap.rst

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
The following restrictions apply to namespace remapping:
3+
4+
- Namespace remapping doesn't permit writing to the ``system``, ``config``, ``admin``,
5+
or ``local`` databases, or writing to internal databases used by ``mongosync``.
6+
7+
- The database name on the destination cluster must be valid under Windows
8+
restrictions.
9+
10+
For more information, see :limit:`Restrictions on Database Names for Windows`.
11+
12+
- Remapped database names on the destination cluster cannot differ only in case.
13+
14+
- The remap cannot produce namespace conflicts on the destination cluster.
15+
16+
For example:
17+
18+
.. code-block:: javascript
19+
:copyable: false
20+
21+
"namespaceRemap": [
22+
{
23+
"from": { "database": "us-west" },
24+
"to": {"database": "us-accounts" }
25+
},
26+
{
27+
"from": { "database": "us-south" },
28+
"to": { "database": "us-accounts" }
29+
}
30+
]
31+
32+
If each database on the source cluster contains a ``texas`` collection,
33+
``mongosync`` may fail, corrupt data, or exhibit unexpected behavior.

Diff for: ‎source/includes/many-to-one-cluster.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Starting in {+c2c-beta-program-short+} 1.8, you can perform Many-to-One
2+
migrations. Many-to-One migrations allow you to sync multiple source
3+
clusters simultaneously with a destination cluster. For example, you can
4+
consolidate data from many small clusters into a central cluster.

Diff for: ‎source/includes/migration-name-limitation.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
The ``migrationName`` string can contain up to 44 alphanumeric and underscore
2+
characters. ``migrationName`` is appended to the string
3+
``"mongosync_internal_"`` to set the migration metadata database name.
4+
5+
For example, if you set ``migrationName`` to
6+
``"cluster_27000_to_cluster_35000_sync"``, the resulting ``mongosync`` metadata
7+
database name is ``"mongosync_internal_cluster_27000_to_cluster_35000_sync"``.

Diff for: ‎source/includes/namespace-remapping-intro.rst

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Starting in {+c2c-beta-program-short+} 1.8, you can remap database names during
2+
sync. This allows you to take data in one database on the source cluster and
3+
migrate it into a different database on the destination cluster.

Diff for: ‎source/includes/opts/migrationName.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. reference/configuration.txt
2+
.. reference/mongosync.txt
3+
4+
Starting in ``mongosync-beta`` 1.8, sets a migration name for a sync
5+
operation. For example, you can set a migration name to identify each
6+
sync operation from multiple source clusters into one destination
7+
cluster.
8+
9+
.. include:: /includes/migration-name-limitation.rst
10+
11+
For complete examples, see :ref:`Many-to-One Migrations
12+
<c2c-beta-many-to-one-example>` or :ref:`A->B->C Migrations
13+
<c2c-beta-abc-migration-example>`.

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/includes/table-beta-compatibility.rst

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
.. list-table::
2+
:header-rows: 1
3+
:stub-columns: 1
4+
:class: compatibility
5+
6+
* -
7+
- Many-to-One
8+
- A->B->C Migration
9+
- Document Filtering
10+
- Namespace Remapping
11+
- Oplog Rollover Resilience
12+
- Destination Data Handling
13+
14+
* - Many-to-One
15+
-
16+
-
17+
-
18+
- |checkmark|
19+
- |checkmark|
20+
- |checkmark|
21+
22+
* - A->B->C Migration
23+
-
24+
-
25+
-
26+
- |checkmark|
27+
- |checkmark|
28+
- |checkmark|
29+
30+
* - Document Filtering
31+
-
32+
-
33+
-
34+
- |checkmark|
35+
- |checkmark|
36+
- |checkmark|
37+
38+
* - Namespace Remapping
39+
- |checkmark|
40+
- |checkmark|
41+
- |checkmark|
42+
-
43+
- |checkmark|
44+
- |checkmark|
45+
46+
* - Oplog Rollover Resilience
47+
- |checkmark|
48+
- |checkmark|
49+
- |checkmark|
50+
- |checkmark|
51+
-
52+
- |checkmark|
53+
54+
* - Destination Data Handling
55+
- |checkmark|
56+
- |checkmark|
57+
- |checkmark|
58+
- |checkmark|
59+
- |checkmark|
60+
-

Diff for: ‎source/index.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Cluster-to-Cluster Sync
99
.. default-domain:: mongodb
1010

1111
{+c2c-product-name+} provides continuous data synchronization or a
12-
one-time data migration between two MongoDB clusters. You can enable
12+
one-time data migration between MongoDB clusters. You can enable
1313
{+c2c-product-name+} with the :ref:`mongosync <c2c-mongosync>` utility.
1414

1515
``mongosync`` can continuously synchronize data between two clusters.

Diff for: ‎source/quickstart.txt

+2
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,8 @@ Initialization Notes
206206
<c2c-api-start>` command. "cluster0" and "cluster1" are just labels,
207207
either cluster can be ``cluster0`` or ``cluster1``.
208208

209+
.. _c2c-quickstart-synchronize:
210+
209211
Synchronize Data Between Clusters
210212
---------------------------------
211213

Diff for: ‎source/reference.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,4 @@ Reference
6666
/reference/verification
6767
/reference/versioning
6868
/reference/supported-server-version
69-
69+
/reference/beta-program

Diff for: ‎source/reference/api/start.txt

+22-2
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,17 @@ Request Body Parameters
112112

113113
.. versionadded:: 1.3.0
114114

115+
* - ``documentFilter``
116+
- document
117+
- Optional
118+
- .. include:: /includes/beta-feature.rst
119+
120+
.. include:: /includes/document-filtering-intro.rst
121+
122+
To learn more, see :ref:`c2c-beta-document-filtering`.
123+
124+
.. versionadded:: 1.8 Beta
125+
115126
* - ``enableUserWriteBlocking``
116127
- boolean
117128
- Optional
@@ -150,6 +161,17 @@ Request Body Parameters
150161

151162
.. versionadded:: 1.6
152163

164+
* - ``namespaceRemap``
165+
- array
166+
- Optional
167+
- .. include:: /includes/beta-feature.rst
168+
169+
Array of documents that specify namespace changes to make during sync.
170+
171+
For more information, see :ref:`c2c-beta-namespace-remapping`.
172+
173+
.. versionadded:: 1.8 Beta
174+
153175
* - ``reversible``
154176
- boolean
155177
- Optional
@@ -464,5 +486,3 @@ Endpoint Protection
464486

465487
.. |endpoint| replace:: ``start``
466488
.. include:: /includes/fact-api-endpoint
467-
468-

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

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
.. _c2c-beta-program:
2+
3+
====================================
4+
{+c2c-full-beta-program+}
5+
====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
.. include:: /includes/beta-program-intro.rst
16+
17+
Each ``mongosync`` release has a corresponding {+c2c-beta-program-short+}
18+
build that includes its own set of experimental features.
19+
20+
.. _c2c-beta-program-disclaimer:
21+
22+
Get Started
23+
-----------
24+
25+
To request access to the {+c2c-beta-program-short+} binaries, please file a
26+
`HELP ticket <https://jira.mongodb.org/browse/HELP>`_.
27+
28+
When you first run the {+c2c-beta-program-short+} binary, you must accept the
29+
following disclaimer:
30+
31+
.. code-block:: shell
32+
:copyable: false
33+
34+
MongoDB restricts access to beta features via the beta build. Your use
35+
of the beta is governed by the language specified in the Cloud
36+
Subscription Agreement, Cloud Terms of Service, or other applicable
37+
agreement between you and MongoDB with respect to your use of
38+
mongosync.
39+
40+
You understand that features are available through the beta build, and
41+
flags are not generally available. All use of beta builds is at your own
42+
risk. Beta builds provide no stability guarantees; API, UI, options, and
43+
behaviors may change or be removed any time. MongoDB will never issue a
44+
Critical Advisory or notify about defects in beta builds.
45+
46+
You should follow feature usage guidance provided by Field and R&D
47+
without deviation and should only use beta builds for one-time, human-
48+
supervised migrations (e.g., not for continuous sync or automated
49+
migrations). Beta capabilities are not intended for use to migrate
50+
production workloads.
51+
52+
Do you want to continue? (y/n):
53+
54+
.. seealso::
55+
56+
- `Cloud Subscription Agreement <https://www.mongodb.com/cloud-subscription-agreement/november-2023>`_
57+
- `Cloud Terms of Service <https://www.mongodb.com/legal/terms-and-conditions/cloud>`_
58+
59+
60+
Beta Features
61+
-------------
62+
63+
{+c2c-beta-program-short+} {+version-dev+} includes the following features:
64+
65+
.. list-table::
66+
:header-rows: 1
67+
:stub-columns: 1
68+
69+
* - Feature
70+
- Description
71+
72+
* - :ref:`c2c-beta-abc-migration`
73+
- .. include:: /includes/abc-migration-intro.rst
74+
75+
* - :ref:`c2c-beta-document-filtering`
76+
- .. include:: /includes/document-filtering-intro.rst
77+
78+
* - :ref:`c2c-beta-destination-data-handling`
79+
- .. include:: /includes/destinationDataHandling-introduction.rst
80+
81+
* - :ref:`c2c-beta-namespace-remapping`
82+
- .. include:: /includes/namespace-remapping-intro.rst
83+
84+
* - :ref:`c2c-beta-many-to-one`
85+
- .. include:: /includes/many-to-one-cluster.rst
86+
87+
* - :ref:`c2c-beta-orr`
88+
- .. include:: /includes/orr-intro.rst
89+
90+
Feature Compatibility Matrix
91+
----------------------------
92+
93+
.. |checkmark| unicode:: U+2713
94+
95+
The following table shows supported combinations of beta features:
96+
97+
.. warning::
98+
99+
Unsupported feature combinations do not have guardrails and can result in
100+
undefined behavior.
101+
102+
.. include:: /includes/table-beta-compatibility.rst
103+
104+
.. toctree::
105+
:titlesonly:
106+
107+
/reference/beta-program/abc-migration
108+
/reference/beta-program/many-to-one
109+
/reference/beta-program/document-filtering
110+
/reference/beta-program/destinationDataHandling
111+
/reference/beta-program/namespace-remapping
112+
/reference/beta-program/orr

0 commit comments

Comments
 (0)