Skip to content

Commit 65e402b

Browse files
committed
Adds required specs for geosharded clusters.
1 parent 02c21f1 commit 65e402b

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

source/cluster-config-file.txt

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,45 @@ Optional and Conditional {+Cluster+} Settings
150150
---------------------------------------------
151151

152152
Your {+cluster+} configuration file may contain additional optional or
153-
conditional {+cluster+} settings. For a full list of available
153+
conditional {+cluster+} settings. If you selected a ``clusterType`` of ``GEOSHARDED``, you must specify these {+cluster+} settings either
154+
in the configuration file or as flags in the command:
155+
156+
.. list-table::
157+
:header-rows: 1
158+
:widths: 20 10 70
159+
160+
* - Field
161+
- Type
162+
- Description
163+
164+
* - ``replicationSpecs.``
165+
``numShards``
166+
- string
167+
- Positive integer that specifies the number of shards to deploy
168+
in each specified zone. Provide this value if you set a
169+
``clusterType`` of ``SHARDED`` or ``GEOSHARDED``. Omit this
170+
value if you selected a ``clusterType`` of ``REPLICASET``.
171+
172+
This API resource accepts ``1`` through ``50``, inclusive. This
173+
parameter defaults to ``1``.
174+
175+
If you specify a ``numShards`` value of ``1`` and a
176+
``clusterType`` of ``SHARDED``, |service| deploys a single-shard
177+
`sharded cluster <https://www.mongodb.com/docs/manual/reference/glossary/#std-term-sharded-cluster>`__.
178+
179+
Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.
180+
181+
* - ``replicationSpecs.``
182+
``zoneName``
183+
- string
184+
- Name for the zone in a :ref:`Global Cluster <global-clusters>`.
185+
Provide this value if you set ``clusterType`` to ``GEOSHARDED``.
186+
187+
For a full list of available
154188
settings, see the API documentation for
155-
:atlas:`Create One Multi-Cloud Cluster from One Project
156-
</reference/api-resources-spec/#operation/createOneAdvancedClusterFromOneProject>`.
189+
:oas-atlas-op:`Create One Cluster </createOneCluster>` and
190+
:oas-atlas-op:`Create One Multi-Cloud Cluster from One Project
191+
</createCluster>`.
157192

158193
.. _example-cluster-config-file:
159194

0 commit comments

Comments
 (0)