Skip to content

Commit b8dbcbc

Browse files
authored
1 parent a74f362 commit b8dbcbc

File tree

2 files changed

+5
-146
lines changed

2 files changed

+5
-146
lines changed

source/includes/api/automation-configuration/sharding.rst

Lines changed: 4 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,9 @@ clusters.
77
88
"sharding" : [
99
{
10-
"managedSharding" : <boolean>,
10+
"managedSharding" : false,
1111
"name" : "<string>",
1212
"configServerReplica" : "<string>",
13-
"collections" : [
14-
{
15-
"_id" : "<string>",
16-
"key" : [
17-
[ "shard key" ],
18-
[ "shard key" ],
19-
...
20-
],
21-
"unique" : <boolean>
22-
},
23-
...
24-
],
2513
"shards" : [
2614
{
2715
"_id" : "<string>",
@@ -30,27 +18,6 @@ clusters.
3018
},
3119
...
3220
],
33-
"tags" : [
34-
{
35-
"ns" : "<string>",
36-
"min" : [
37-
{
38-
"parameter" : "<string>",
39-
"parameterType" : "<string>",
40-
"value" : "<string>"
41-
}
42-
],
43-
"max" : [
44-
{
45-
"parameter" : "<string>",
46-
"parameterType" : "<string>",
47-
"value" : "<string>"
48-
}
49-
],
50-
"tag" : "<string>"
51-
},
52-
...
53-
]
5421
},
5522
...
5623
]
@@ -78,10 +45,11 @@ clusters.
7845

7946
* - sharding.managedSharding
8047
- boolean
81-
- Conditional
48+
- Optional
8249
- Flag that indicates whether |mms| Automation manages all
8350
:manual:`sharded collections </sharding>`
84-
and :manual:`tags </core/zone-sharding>` in the deployment
51+
and :manual:`tags </core/zone-sharding>` in the deployment.
52+
Starting in |mms| version 7.0, this can be set only to ``false``.
8553

8654
* - sharding.name
8755
- string
@@ -110,33 +78,6 @@ clusters.
11078

11179
.. important:: MongoDB 3.4 removes support for mirrored config servers.
11280

113-
* - sharding.collections
114-
- array of objects
115-
- Conditional
116-
- Objects that define the sharded :term:`collections <collection>`
117-
and their :manual:`shard keys </reference/glossary/#std-term-shard-key>`.
118-
119-
* - sharding.collections._id
120-
- string
121-
- Conditional
122-
- :term:`namespace` of the sharded collection. The namespace
123-
is the combination of the database name and the name of the
124-
collection. For example, **testdb.testcoll**.
125-
126-
* - sharding.collections.key
127-
- array of arrays
128-
- Conditional
129-
- Collection's :manual:`shard keys </reference/glossary/#std-term-shard-key>`. It contains:
130-
131-
- One array if your cluster uses one shard key.
132-
- Multiple arrays if your cluster uses a compound shard key.
133-
134-
* - sharding.collections.unique
135-
- boolean
136-
- Conditional
137-
- Flag that indicates whether MongoDB
138-
:manual:`enforces uniqueness for the shard key </reference/method/sh.shardCollection>`.
139-
14081
* - sharding.shards
14182
- array of objects
14283
- Conditional
@@ -160,84 +101,3 @@ clusters.
160101

161102
You can add this array parameter if you use
162103
:manual:`zoned sharding </core/zone-sharding>`.
163-
164-
* - sharding.tags
165-
- array of objects
166-
- Conditional
167-
- Definition of zones for
168-
:manual:`zoned sharding </core/zone-sharding>`. Each object in
169-
this array defines a zone and configures the shard key range
170-
for that zone.
171-
172-
* - sharding.tags.ns
173-
- string
174-
- Conditional
175-
- :manual:`Namespace </reference/glossary/#std-term-namespace>` of the collection that uses zoned
176-
sharding. The namespace combines the database name and the name
177-
of the collection.
178-
179-
.. example::
180-
181-
testdb.testcoll
182-
183-
* - sharding.tags.min
184-
- array
185-
- Conditional
186-
- Minimum value of the shard key range.
187-
188-
.. include:: /includes/possibleValues-sharding.tags-ranges.rst
189-
190-
* - sharding.tags.max
191-
- array
192-
- Conditional
193-
- Maximum value of the shard key range.
194-
195-
.. include:: /includes/possibleValues-sharding.tags-ranges.rst
196-
197-
* - sharding.tags.tag
198-
- string
199-
- Conditional
200-
- Name of the :manual:`zone </core/zone-sharding>` associated
201-
with the shard key range specified by **sharding.tags.min** and
202-
**sharding.tags.max**.
203-
204-
.. example:: The **sharding.tags** Array with Compound Shard Key
205-
206-
The following example configuration defines a compound shard key
207-
range with a min value of **{ a : 1, b : ab }** and a max value of
208-
**{ a : 100, b : fg }**. The example defines the range on the
209-
**testdb.test1** collection and assigns it to zone **zone1**.
210-
211-
.. code-block:: json
212-
:linenos:
213-
214-
"tags" : [
215-
{
216-
"ns" : "testdb.test1",
217-
"min" : [
218-
{
219-
"parameter" : "a",
220-
"parameterType" : "integer",
221-
"value" : "1"
222-
},
223-
{
224-
"parameter" : "b",
225-
"parameterType" : "string",
226-
"value" : "ab"
227-
}
228-
],
229-
"max" : [
230-
{
231-
"parameter" : "a",
232-
"parameterType" : "integer",
233-
"value" : "100"
234-
},
235-
{
236-
"parameter" : "b",
237-
"parameterType" : "string",
238-
"value" : "fg"
239-
}
240-
],
241-
"tag" : "zone1"
242-
}
243-
]

source/includes/steps-create-cluster-through-api.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,7 @@ content: |
182182
}
183183
],
184184
"name": "sharded_cluster_via_api",
185-
"configServerReplica": "rs-config",
186-
"collections": []
185+
"configServerReplica": "rs-config"
187186
}
188187
]
189188
---

0 commit comments

Comments
 (0)