Skip to content

Commit 494d0c7

Browse files
author
Sam Kleinman
committed
edit: normalizing use of shard cluster across documentation
1 parent d7ed0e0 commit 494d0c7

File tree

12 files changed

+33
-24
lines changed

12 files changed

+33
-24
lines changed

meta.style-guide.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,15 @@ process, or server instance itself. These are "processes" or
260260
structure that holds collections and refers to a group of files on
261261
disk.)
262262

263+
Distributed System Terms
264+
~~~~~~~~~~~~~~~~~~~~~~~~
265+
266+
- Refer to partitioned systems as "shard clusters," over other
267+
variants. (e.g. sharded clusters, or sharded systems.)
268+
269+
- Refer configurations that run with replication as "replica sets" (or
270+
"master/slave deployments") rather than "clusters" or other variants.
271+
263272
Data Structures
264273
~~~~~~~~~~~~~~~
265274

source/administration/backups.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -680,7 +680,7 @@ from that instance. When you unlock the database, the slave will catch
680680
:term:`master` or :term:`primary` node. You may also chose to deploy a
681681
dedicated :term:`hidden member` for backup purposes.
682682

683-
If you have a sharded cluster where each shard is itself a replica
683+
If you have a shard cluster where each shard is itself a replica
684684
set, you can use this method to create a backup of the entire cluster
685685
without disrupting the operation of the node. In these situations you
686686
should still turn off the balancer when you create backups.

source/administration/indexes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,8 +266,8 @@ building process blocks all replication and read operations on the
266266
secondaries while they build the index.
267267

268268
Secondaries will begin building indexes *after* the
269-
:term:`primary` finishes building the index. In :term:`sharded clusters
270-
<shard cluster>`, the :program:`mongos` will send :func:`ensureIndex()
269+
:term:`primary` finishes building the index. In :term:`shard clusters`,
270+
the :program:`mongos` will send :func:`ensureIndex()
271271
<db.collection.ensureIndex()>` to the primary members of the replica
272272
set for each shard, which then replicate to the secondaries after the
273273
primary finishes building the index.

source/core/sharding-internals.txt

Lines changed: 2 additions & 2 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 sharded cluster. See the
24+
distribute :term:`documents <document>` within a shard 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 sharded clusters.
172+
operations in the context of shard 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

source/core/sharding.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ MongoDB has the following features:
6060

6161
Transparent Query Routing
6262
Sharding is completely transparent to the application layer,
63-
because all connections to a sharded cluster go through
63+
because all connections to a shard cluster go through
6464
:program:`mongos`. Sharding in MongoDB requires some
6565
:ref:`basic initial configuration <sharding-procedure-setup>`,
6666
but ongoing function is entirely transparent to the application.
@@ -167,7 +167,7 @@ A :term:`shard cluster` has the following components:
167167

168168
MongoDB enables data :term:`partitioning <partition>`
169169
(i.e. sharding) on a *per collection* basis. You *must* access
170-
all data in a sharded cluster via the :program:`mongos`
170+
all data in a shard cluster via the :program:`mongos`
171171
instances.
172172

173173
- One or more :program:`mongos` instances.

source/faq/developers.txt

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

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

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

source/reference/commands.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,14 +166,14 @@ Sharding
166166
.. warning::
167167

168168
There's no easy way to disable sharding once you've enabled it. In addition,
169-
shard keys are immutable. If you must revert a sharded cluster to a single
169+
shard keys are immutable. If you must revert a shard clustero to a single
170170
node or replica set, you'll have to make a single backup of the entire cluster
171171
and then restore the backup to the standalone :program:`mongod`.
172172

173173
.. dbcommand:: shardingState
174174

175175
The :dbcommand:`shardingState` command returns ``true`` if the
176-
:program:`mongod` instance is a member of a sharded cluster. Run the
176+
:program:`mongod` instance is a member of a shard cluster. Run the
177177
command using the following syntax:
178178

179179
.. code-block:: javascript
@@ -213,7 +213,7 @@ Sharding
213213
databases remain on the shard. Use :dbcommand:`printShardingStatus`
214214
to list the databases that you must move from the shard.
215215

216-
Each database in a sharded cluster has a primary shard. If the
216+
Each database in a shard cluster has a primary shard. If the
217217
shard you want to remove is also the primary of one the cluster's
218218
databases, then you must manually move the database to a new
219219
shard. This can be only after the shard is empty. See the
@@ -2551,7 +2551,7 @@ Internal Use
25512551

25522552
:dbcommand:`writeBacksQueued` is an internal command that returns true if
25532553
there are operations in the write back queue for the given :program:`mongos`.
2554-
This command applies to sharded clusters only.
2554+
This command applies to shard clusters only.
25552555

25562556
.. slave-ok, admin-only
25572557

source/reference/javascript.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1507,8 +1507,8 @@ that you may use with collection objects.
15071507
.. function:: getShardVersion()
15081508

15091509
This method returns information regarding the state of data in a
1510-
sharded cluster that is useful when diagnosing underlying issues
1511-
with a :term:`shard cluster`.
1510+
:term:`shard cluster` that is useful when diagnosing underlying issues
1511+
with a shard cluster.
15121512

15131513
For internal and diagnostic use only.
15141514

source/release-notes/2.2.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Read through all release notes before upgrading, and ensure that no
3131
changes will affect your deployment.
3232

3333
2.2 processes can inter-operate with 2.0 and 1.8 tools and processes
34-
in replica sets and sharded clusters, if you are not running with
34+
in replica sets and shard clusters, if you are not running with
3535
authentication. As a result, you can safely upgrade the
3636
:program:`mongod` and :program:`mongos` components of your deployment
3737
in any order.

source/sharding.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Tutorials
4747
---------
4848

4949
The following tutorials outline basic administrative process for
50-
deploying and managing sharded clusters:
50+
deploying and managing shard clusters:
5151

5252
.. toctree::
5353
:maxdepth: 1

source/tutorial/convert-replica-set-to-replicated-shard-cluster.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ In brief, the process is as follows:
3030

3131
3. Create a second replica set with three new :program:`mongod` processes.
3232

33-
4. Add the second replica set to the sharded cluster.
33+
4. Add the second replica set to the shard cluster.
3434

3535
5. Enable sharding on the desired collection or collections.
3636

3737
Process
3838
-------
3939

4040
Install MongoDB according to a ":ref:`MongoDB Installation Tutorial
41-
<tutorials-installation>`".
41+
<tutorials-installation>`".
4242

4343
.. .. note::
4444

@@ -146,8 +146,8 @@ set and then insert test data.
146146
:program:`mongo` shell may take several minutes depending on your
147147
system.
148148

149-
.. _convert-replica-set-to-shard-cluster-deploy-sharding-infrastructure:
150-
149+
.. _convert-replica-set-to-shard-cluster-deploy-sharding-infrastructure:
150+
151151
Deploy Sharding Infrastructure
152152
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153153

@@ -477,4 +477,4 @@ demonstrate that :term:`chunks <chunk>` are migrating from
477477
``firstset`` to ``secondset``.
478478

479479
When this procedure is complete, you will have converted a replica set
480-
into a sharded cluster where each shard is itself a replica set.
480+
into a shard cluster where each shard is itself a replica set.

source/tutorial/deploy-shard-cluster.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ Synopsis
88
--------
99

1010
This document outlines the full procedure for deploying a
11-
:term:`sharded cluster <shard cluster>` in MongoDB. Use the
11+
:term:`shard cluster` in MongoDB. Use the
1212
":doc:`/tutorial/convert-replica-set-to-replicated-shard-cluster`"
1313
procedure if you have an existing replica set. If you have a
1414
standalone :program:`mongod` instance you can use this tutorial to
15-
deploy a sharded cluster.
15+
deploy a shard cluster.
1616

1717
Requirements
1818
------------
1919

2020
See the ":ref:`Requirements for Shard Clusters
2121
<sharding-requirements>`" section for more information about potential
22-
requirements for sharded cluster.
22+
requirements for shard cluster.
2323

2424
.. warning:: Sharding and "localhost" Addresses
2525

0 commit comments

Comments
 (0)