Skip to content

Commit 0295479

Browse files
author
Bob Grabar
committed
DOCS-303 shard cluster to sharded cluster
1 parent fb68f8c commit 0295479

32 files changed

+67
-67
lines changed

draft/core/write-operations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ Architecture
4646
.. ordered list:
4747

4848
- atomicity
49-
- replica sets / shard clusters
49+
- replica sets / sharded clusters

draft/tutorial/inserting-documents-into-a-sharded-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ in the :ref:`sharding-pre-splitting` section below.
8181
Uneven distribution occurs in the following cases:
8282

8383
- You insert a large volume of data that is not evenly distributed. Even
84-
if the :term:`sharded cluster <shard cluster>` contains existing
84+
if the :term:`sharded cluster` contains existing
8585
documents balanced over multiple chunks, the inserted data might
8686
include values that write disproportionately to a small number of
8787
chunks.

draft/use-cases/gaming-user-state.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@ Sharding
570570
--------
571571

572572
If your system needs to scale beyond a single MongoDB instance node,
573-
you will want to use a :term:`shard cluster`, which takes advantage of
573+
you will want to use a :term:`sharded cluster`, which takes advantage of
574574
MongoDB's :term:`sharding` functionality.
575575

576576
.. see:: ":doc:`/faq/sharding`" and the ":wiki:`Sharding` wiki page.

meta.style-guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Referencing
157157

158158
Type this:
159159

160-
To deploy a shard cluster for an existing replica set, see
160+
To deploy a sharded cluster for an existing replica set, see
161161
:doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`.
162162

163163
General Formulations
@@ -277,7 +277,7 @@ disk.)
277277
Distributed System Terms
278278
~~~~~~~~~~~~~~~~~~~~~~~~
279279

280-
- Refer to partitioned systems as "shard clusters," over other
280+
- Refer to partitioned systems as "sharded clusters," over other
281281
variants. (e.g. sharded clusters, or sharded systems.)
282282

283283
- Refer configurations that run with replication as "replica sets" (or
@@ -317,7 +317,7 @@ Notes on Specific Features
317317
Other Terms
318318
~~~~~~~~~~~
319319

320-
- Use "**shard cluster**," to refer to a collection of ``mongod``
320+
- Use "**sharded cluster**," to refer to a collection of ``mongod``
321321
instances that hold a sharded data set. Use the term "**replica
322322
set**," to refer to a collection of ``mongod`` instances that
323323
provide a replicated data set. Do not use the word "cluster" to

source/administration/backups.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ process is crucial for every production-grade deployment. Take the
1818
specific features of your deployment, your use patterns, and
1919
architecture into consideration as you develop your own backup system.
2020

21-
:term:`Replica sets <replica set>` and :term:`sharded clusters <shard cluster>`
21+
:term:`Replica sets <replica set>` and :term:`sharded clusters`
2222
require special considerations. Don't miss the :ref:`backup
2323
considerations for sharded clusters and replica sets
2424
<backups-with-sharding-and-replication>`.
@@ -595,7 +595,7 @@ binary dump of each database instance using :ref:`binary dump methods
595595

596596
These backups must not only capture the database in a consistent
597597
state, as described in the aforementioned procedures, but the
598-
:term:`sharded cluster <shard cluster>` needs to be consistent in itself. Also, disable
598+
:term:`sharded cluster` needs to be consistent in itself. Also, disable
599599
the balancer process that equalizes the distribution of data among the
600600
:term:`shards <shard>` before taking the backup.
601601

source/administration/monitoring.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ waiting for a crisis or failure.
1414
This document provides an overview of the available tools and data
1515
provided by MongoDB as well as introduction to diagnostic strategies,
1616
and suggestions for monitoring instances in MongoDB's replica sets and
17-
shard clusters.
17+
sharded clusters.
1818

1919
.. note::
2020

@@ -488,7 +488,7 @@ instances become unavailable. However, clusters remain
488488
accessible from already-running :program:`mongos` instances.
489489

490490
Because inaccessible configuration servers can have a serious impact
491-
on the availability of a shard cluster, you should monitor the
491+
on the availability of a sharded cluster, you should monitor the
492492
configuration servers to ensure that the cluster remains well
493493
balanced and that :program:`mongos` instances can restart.
494494

source/administration/replica-sets.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ other members in the set will not advertise the hidden member in the
171171

172172
.. versionchanged:: 2.0
173173

174-
For :term:`sharded clusters <shard cluster>` running with replica sets before 2.0 if
174+
For :term:`sharded clusters` running with replica sets before 2.0 if
175175
you reconfigured a member as hidden, you *had* to restart
176176
:program:`mongos` to prevent queries from reaching the hidden
177177
member.

source/administration/sharding-architectures.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Sharded Cluster Architectures
99
.. default-domain:: mongodb
1010

1111
This document describes the organization and design of :term:`sharded
12-
cluster <shard cluster>` deployments.
12+
cluster` deployments.
1313

1414
.. seealso:: The :doc:`/administration/sharding` document, the
1515
":ref:`Sharding Requirements <sharding-requirements>`" section,
@@ -90,7 +90,7 @@ that *are not* sharded reside on the primary for their database. Use
9090
the :dbcommand:`movePrimary` command to change the primary shard for a
9191
database. Use the :dbcommand:`printShardingStatus` command or the
9292
:method:`sh.status()` to see an overview of the cluster, which contains
93-
information about the chunk and database distribution within the
93+
information about the :term:`chunk` and database distribution within the
9494
cluster.
9595

9696
.. warning::

source/administration/sharding.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ clusters. For a full introduction to sharding in MongoDB see
1212
:doc:`/core/sharding`, and for a complete overview of all sharding
1313
documentation in the MongoDB Manual, see :doc:`/sharding`. The
1414
:doc:`/administration/sharding-architectures` document provides an
15-
overview of deployment possibilities to help deploy a shard
15+
overview of deployment possibilities to help deploy a sharded
1616
cluster. Finally, the :doc:`/core/sharding-internals` document
1717
provides a more detailed introduction to sharding when troubleshooting
1818
issues or understanding your cluster's behavior.
@@ -192,7 +192,7 @@ use the following procedure as a quick starting point:
192192
Cluster Management
193193
------------------
194194

195-
Once you have a running shard cluster, you will need to maintain it.
195+
Once you have a running sharded cluster, you will need to maintain it.
196196
This section describes common maintenance procedure, including: how to
197197
add and remove nodes, how to manually split chunks, and how to disable
198198
the balancer for backups.
@@ -213,7 +213,7 @@ command:
213213
Add a Shard to a Cluster
214214
~~~~~~~~~~~~~~~~~~~~~~~~
215215

216-
To add a shard to an *existing* shard cluster, use the following
216+
To add a shard to an *existing* sharded cluster, use the following
217217
procedure:
218218

219219
#. Connect to a :program:`mongos` in the cluster using the
@@ -405,7 +405,7 @@ Chunk Management
405405
This section describes various operations on :term:`chunks <chunk>` in
406406
:term:`sharded clusters <sharded cluster>`. MongoDB automates these
407407
processes; however, in some cases, particularly when you're setting up
408-
a shard cluster, you may need to create and manipulate chunks
408+
a sharded cluster, you may need to create and manipulate chunks
409409
directly.
410410

411411
.. _sharding-procedure-create-split:
@@ -558,7 +558,7 @@ To create and migrate chunks manually, use the following procedure:
558558
Modify Chunk Size
559559
~~~~~~~~~~~~~~~~~
560560

561-
When you initialize a shard cluster, the default chunk size is 64
561+
When you initialize a sharded cluster, the default chunk size is 64
562562
megabytes. This default chunk size works well for most deployments. However, if you
563563
notice that automatic migrations are incurring a level of I/O that
564564
your hardware cannot handle, you may want to reduce the chunk
@@ -790,7 +790,7 @@ be able to migrate chunks:
790790
two digit hour and minute values (e.g ``HH:MM``) that describe the
791791
beginning and end boundaries of the balancing window.
792792
These times will be evaluated relative to the time zone of each individual
793-
:program:`mongos` instance in the shard cluster.
793+
:program:`mongos` instance in the sharded cluster.
794794
For instance, running the following
795795
will force the balancer to run between 11PM and 6AM local time only:
796796

@@ -1109,7 +1109,7 @@ default chunk size is configurable with the :setting:`chunkSize`
11091109
setting, these behaviors help prevent unnecessary chunk migrations,
11101110
which can degrade the performance of your cluster as a whole.
11111111

1112-
If you have just deployed a shard cluster, make sure that you have
1112+
If you have just deployed a sharded cluster, make sure that you have
11131113
enough data to make sharding effective. If you do not have sufficient
11141114
data to create more than eight 64 megabyte chunks, then all data will
11151115
remain on one shard. Either lower the :ref:`chunk size
@@ -1144,7 +1144,7 @@ to correct this pattern.
11441144
The Cluster does not Balance
11451145
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11461146

1147-
If you have just deployed your shard cluster, you may want to
1147+
If you have just deployed your sharded cluster, you may want to
11481148
consider the :ref:`troubleshooting suggestions for a new cluster where
11491149
data remains on a single shard <sharding-troubleshooting-not-splitting>`.
11501150

source/applications/replication.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Application Development with Replica Sets
77
From the perspective of a client application, whether a MongoDB
88
instance is running as a single server (i.e. "standalone") or a :term:`replica set`
99
is transparent. However, replica sets
10-
offer some configuration options for write and read operations. [#shard-clusters]_
10+
offer some configuration options for write and read operations. [#sharded-clusters]_
1111
This document describes those options and their implications.
1212

13-
.. [#shard-clusters] :term:`Shard clusters <shard cluster>` where the
13+
.. [#sharded-clusters] :term:`Sharded clusters <sharded cluster>` where the
1414
shards are also replica sets provide the same configuration options
1515
with regards to write and read operations.
1616

@@ -529,7 +529,7 @@ Member Selection
529529
````````````````
530530

531531
Both clients, by way of their drivers, and :program:`mongos` instances for
532-
shard clusters send periodic "ping," messages to all member of the
532+
sharded clusters send periodic "ping," messages to all member of the
533533
replica set to determine latency from the application to each
534534
:program:`mongod` instance.
535535

@@ -573,10 +573,10 @@ Sharding and ``mongos``
573573

574574
In most :term:`sharded clusters <sharded cluster>`, a :term:`replica set`
575575
provides each shard where read preferences are also applicable. Read
576-
operations in a shard cluster, with regard to read preference, are
576+
operations in a sharded cluster, with regard to read preference, are
577577
identical to unsharded replica sets.
578578

579-
Unlike simple replica sets, in shard clusters, all interactions with
579+
Unlike simple replica sets, in sharded clusters, all interactions with
580580
the shards pass from the clients to the :program:`mongos` instances
581581
that are actually connected to the set members. :program:`mongos` is
582582
responsible for the application of the read preferences, which is

source/core/sharding-internals.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Shard Keys
2121
----------
2222

2323
Shard keys are the field in a collection that MongoDB uses to
24-
distribute :term:`documents <document>` within a shard cluster. See the
24+
distribute :term:`documents <document>` within a sharded cluster. See the
2525
:ref:`overview of shard keys <sharding-shard-key>` for an
2626
introduction to these topics.
2727

@@ -169,7 +169,7 @@ compound shard key. The data may become more splitable with a
169169
compound shard key.
170170

171171
.. see:: ":ref:`sharding-mongos`" for more information on query
172-
operations in the context of shard clusters.
172+
operations in the context of sharded clusters.
173173

174174
.. [#shard-key-index] In many ways, you can think of the shard key a
175175
cluster-wide unique index. However, be aware that sharded systems
@@ -402,7 +402,7 @@ than two.*
402402

403403
The specification of the balancing window is relative to the local
404404
time zone of all individual :program:`mongos` instances in the
405-
shard cluster.
405+
sharded cluster.
406406

407407
.. index:: sharding; chunk size
408408
.. _sharding-chunk-size:

source/core/sharding.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ You should consider deploying a :term:`sharded cluster`, if:
114114
If these attributes are not present in your system, sharding will only
115115
add additional complexity to your system without providing much
116116
benefit. When designing your data model, if you will eventually need a
117-
shard cluster, consider which collections you will want to shard and
117+
sharded cluster, consider which collections you will want to shard and
118118
the corresponding shard keys.
119119

120120
.. _sharding-capacity-planning:
@@ -169,7 +169,7 @@ A :term:`sharded cluster` has the following components:
169169
MongoDB enables data :term:`partitioning <partition>`, or
170170
sharding, on a *per collection* basis. You *must* access all data
171171
in a sharded cluster via the :program:`mongos` instances as below.
172-
If you connect directly to a :program:`mongod` in a shard cluster
172+
If you connect directly to a :program:`mongod` in a sharded cluster
173173
you will see its fraction of cluster's data. The data on any
174174
given shard may be somewhat random: MongoDB provides no grantee
175175
that any two contiguous chunks will reside on a single shard.
@@ -304,7 +304,7 @@ within a :term:`sharded cluster`. Without a config database, the
304304
operations within the cluster.
305305

306306
Config servers *do not* run as replica sets. Instead, a :term:`cluster
307-
<shard cluster>` operates with a group of *three* config servers that use a
307+
<sharded cluster>` operates with a group of *three* config servers that use a
308308
two-phase commit process that ensures immediate consistency and
309309
reliability.
310310

@@ -330,7 +330,7 @@ database. MongoDB only writes data to the config server to:
330330
- migrate a chunk between shards.
331331

332332
Additionally, all config servers must be available on initial setup
333-
of a shard cluster, each :program:`mongos` instance must be able
333+
of a sharded cluster, each :program:`mongos` instance must be able
334334
to write to the ``config.version`` collection.
335335

336336
If one or two configuration instances become unavailable, the
@@ -354,15 +354,15 @@ queries or write operations to the cluster.
354354

355355
Because the configuration data is small relative to the amount of data
356356
stored in a cluster, the amount of activity is relatively low, and 100%
357-
up time is not required for a functioning shard cluster. As a result,
357+
up time is not required for a functioning sharded cluster. As a result,
358358
backing up the config servers is not difficult. Backups of config
359359
servers are critical as clusters become totally inoperable when
360360
you lose all configuration instances and data. Precautions to ensure
361361
that the config servers remain available and intact are critical.
362362

363363
.. note::
364364

365-
Configuration servers store metadata for a single shard cluster.
365+
Configuration servers store metadata for a single sharded cluster.
366366
You must have a separate configuration server or servers for each
367367
cluster you administer.
368368

@@ -561,18 +561,18 @@ Security
561561
enforce read-only limitations.
562562

563563
.. versionchanged:: 2.0
564-
Shard clusters support authentication. Previously, in version
564+
Sharded clusters support authentication. Previously, in version
565565
1.8, sharded clusters will not support authentication and access
566566
control. You must run your sharded systems in trusted
567567
environments.
568568

569-
To control access to a shard cluster, you must set the
570-
:setting:`keyFile` option on all components of the shard cluster. Use
569+
To control access to a sharded cluster, you must set the
570+
:setting:`keyFile` option on all components of the sharded cluster. Use
571571
the :option:`--keyFile <mongos --keyFile>` run-time option or the
572572
:setting:`keyFile` configuration option for all :program:`mongos`,
573573
configuration instances, and shard :program:`mongod` instances.
574574

575-
There are two classes of security credentials in a shard cluster:
575+
There are two classes of security credentials in a sharded cluster:
576576
credentials for "admin" users (i.e. for the :term:`admin database`) and
577577
credentials for all other databases. These credentials reside in
578578
different locations within the cluster and have different roles:

source/faq/developers.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ occur simultaneously.
280280

281281
In standalone and :term:`replica sets <replica set>` the lock's scope
282282
applies to a single :program:`mongod` instance or :term:`primary`
283-
instance. In a shard cluster, locks apply to each individual shard,
283+
instance. In a sharded cluster, locks apply to each individual shard,
284284
not to the whole cluster.
285285

286286
A more granular approach to locking will appear in MongoDB v2.2. For

source/faq/sharding.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ How does MongoDB distribute queries among shards?
8181

8282
The exact method for distributing queries to :term:`shards <shard>` in a
8383
:term:`cluster <sharded cluster>` depends on the nature of the query and the configuration of
84-
the shard cluster. Consider a sharded collection, using the
84+
the sharded cluster. Consider a sharded collection, using the
8585
:term:`shard key` ``user_id``, that has ``last_login`` and
8686
``email`` attributes:
8787

@@ -274,7 +274,7 @@ Can shard keys be randomly generated?
274274
:term:`Shard keys <shard key>` can be random. Random keys ensure
275275
optimal distribution of data across the cluster.
276276

277-
:term:`Shard clusters <shard cluster>`, attempt to route queries to
277+
:term:`Sharded clusters <sharded cluster>`, attempt to route queries to
278278
*specific* shards when queries include the shard key as a parameter,
279279
because these directed queries are more efficient. In many cases,
280280
random keys can make it difficult to direct queries to specific
@@ -291,7 +291,7 @@ the shard key.
291291
However, documents that have the shard key *must* reside in the same
292292
*chunk* and therefore on the same server. If your sharded data set has
293293
too many documents with the exact same shard key you will not be able
294-
to distribute *those* documents across your shard cluster.
294+
to distribute *those* documents across your sharded cluster.
295295

296296
.. STUB link to shard key granularity.
297297

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.. note::
22

33
All config servers must be running and available when you first initiate
4-
a :term:`shard cluster`.
4+
a :term:`sharded cluster`.

source/includes/note-conn-pool-stats.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
:dbcommand:`connPoolStats` only returns meaningful results for
44
:program:`mongos` instances and for :program:`mongod` instances
5-
in shard clusters.
5+
in sharded clusters.

source/reference/command/fsync.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ fsync
8989
.. note::
9090

9191
:dbcommand:`fsync` lock is only possible on individual shards of
92-
a shard cluster, not on the entire shard cluster. To backup an
93-
entire shard cluster, please read :ref:`considerations for
92+
a sharded cluster, not on the entire sharded cluster. To backup an
93+
entire sharded cluster, please read :ref:`considerations for
9494
backing up sharded clusters <backups-with-sharding-and-replication>`.
9595

9696
If your :program:`mongod` has :term:`journaling <journal>`

source/reference/command/group.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ group
8282
.. warning::
8383

8484
:method:`group()` does not work in :term:`shard environments
85-
<shard cluster>`. Use the :term:`aggregation framework` or
85+
<sharded cluster>`. Use the :term:`aggregation framework` or
8686
:term:`map-reduce` (i.e. :command:`mapReduce` in :term:`sharded
8787
environments <sharding>`.
8888

0 commit comments

Comments
 (0)