Skip to content

Commit b1be9ee

Browse files
authored
DOCSP-16529 Clarifies source/destination clusters on Quickstart (#235) (#259)
* DOCSP-16529 Clarifies source/destination clusters on Quickstart * Fixes per Ashley * Fixes per Ashley * Fixes per Ajay
1 parent 6b561dd commit b1be9ee

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

source/quickstart.txt

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
Quickstart
55
==========
66

7-
87
.. default-domain:: mongodb
98

109
.. contents:: On this page
@@ -25,15 +24,27 @@ the rest of the {+c2c-product-name+} documentation.
2524
Setup
2625
-----
2726

28-
{+c2c-product-name+} syncs data between two clusters. To run
29-
``mongosync``, you will need to:
27+
``mongosync`` syncs data between two clusters.
28+
29+
- Each cluster can be a replica set or a sharded cluster. If either
30+
is a sharded cluster, consult the :ref:`sharded cluster limitations
31+
<c2c-sharded-limitations>` for ``mongosync``.
32+
33+
- Sharded clusters are not required to have the same number of shards.
34+
35+
- The destination cluster must be the same version or up to two versions ahead
36+
of the source cluster. The patch version is not important, so long as they
37+
meets the minimum patch :ref:`version requirements
38+
<c2c-server-version-compatibility>`.
39+
40+
To run ``mongosync``, you need to:
3041

3142
#. Define a source and a destination cluster.
3243
#. Define administrative users.
3344
#. Download and install ``mongosync``.
3445
#. Connect the clusters.
3546

36-
Follow the instructions below to setup {+c2c-product-name+}.
47+
Follow the instructions below to set up {+c2c-product-name+}.
3748

3849
.. procedure::
3950
:style: normal

source/reference/limitations.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ Unsupported Collection Types
7070
- Clustered collections with :ref:`expireAfterSeconds
7171
<db.createCollection.expireAfterSeconds>` set aren't supported.
7272

73+
.. _c2c-sharded-limitations:
74+
7375
Sharded Clusters
7476
----------------
7577

0 commit comments

Comments
 (0)