Skip to content

Commit 2e3a499

Browse files
committed
Update per TW review
1 parent 98eb464 commit 2e3a499

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/how-to/vshard_quick.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Creating a sharded cluster
66
**Example on GitHub**: `sharded_cluster_crud <https://github.com/tarantool/doc/tree/latest/doc/code_snippets/snippets/sharding/instances.enabled/sharded_cluster_crud>`_
77

88
In this tutorial, you get a sharded cluster up and running on your local machine and learn how to manage the cluster using the tt utility.
9-
In this tutorial, the following external modules are used:
9+
This cluster uses the following external modules:
1010

11-
- :ref:`vshard <vshard>` enables sharding in the cluster.
12-
- `crud <https://github.com/tarantool/crud>`__ allows you to perform CRUD operations in the sharded cluster.
11+
- :ref:`vshard <vshard>` enables sharding in a cluster.
12+
- `crud <https://github.com/tarantool/crud>`__ allows you to manipulate data in a sharded cluster.
1313

1414
The cluster created in this tutorial includes 5 instances: one router and 4 storages, which constitute two replica sets.
1515

@@ -51,7 +51,7 @@ In this tutorial, the application layout is prepared manually:
5151
3. Inside ``instances.enabled/sharded_cluster_crud``, create the following files:
5252

5353
- ``instances.yml`` specifies instances to run in the current environment.
54-
- ``config.yaml`` specifies the cluster's :ref:`configuration <configuration_overview>`.
54+
- ``config.yaml`` specifies the cluster :ref:`configuration <configuration_overview>`.
5555
- ``storage.lua`` contains code specific for :ref:`storages <vshard-architecture-storage>`.
5656
- ``router.lua`` contains code specific for a :ref:`router <vshard-architecture-router>`.
5757
- ``sharded_cluster_crud-scm-1.rockspec`` specifies external dependencies required by the application.
@@ -133,7 +133,7 @@ In this section, the following options are configured:
133133

134134
The cluster topology defined in the :ref:`following section <vshard-quick-start-configuring-cluster-topology>` also specifies the ``iproto.advertise.client`` option for each instance.
135135
This option accepts a URI used to advertise the instance to clients.
136-
For example, |tcm_full_name| uses these URIs to :ref:`connect <tcm_connect_clusters>` to cluster instances.
136+
For example, :ref:`Tarantool Cluster Manager <tcm>` uses these URIs to :ref:`connect <tcm_connect_clusters>` to cluster instances.
137137

138138

139139
.. _vshard-quick-start-configuring-cluster-bucket-count:
@@ -155,13 +155,13 @@ Specify the total number of :ref:`buckets <vshard-vbuckets>` in a sharded cluste
155155
Step 4: Defining the cluster topology
156156
*************************************
157157

158-
Define the cluster's topology inside the :ref:`groups <configuration_reference_groups>` section.
158+
Define the cluster topology inside the :ref:`groups <configuration_reference_groups>` section.
159159
The cluster includes two groups:
160160

161161
* ``storages`` includes two replica sets. Each replica set contains two instances.
162162
* ``routers`` includes one router instance.
163163

164-
Here is a schematic view of the cluster's topology:
164+
Here is a schematic view of the cluster topology:
165165

166166
.. code-block:: yaml
167167
@@ -326,7 +326,7 @@ After starting instances, you need to bootstrap the cluster as follows:
326326
• Connecting to the instance...
327327
• Connected to sharded_cluster_crud:router-a-001
328328
329-
2. Call :ref:`vshard.router.bootstrap() <router_api-bootstrap>` to perform the initial cluster bootstrap:
329+
2. Call :ref:`vshard.router.bootstrap() <router_api-bootstrap>` to perform the initial cluster bootstrap and distribute all buckets across the replica sets:
330330

331331
.. code-block:: tarantoolsession
332332
@@ -338,10 +338,10 @@ After starting instances, you need to bootstrap the cluster as follows:
338338
339339
.. _vshard-quick-start-working-status:
340340

341-
Checking the cluster's status
342-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
341+
Checking the cluster status
342+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
343343

344-
To check the cluster's status, execute :ref:`vshard.router.info() <router_api-info>` on the router:
344+
To check the cluster status, execute :ref:`vshard.router.info() <router_api-info>` on the router:
345345

346346
.. code-block:: tarantoolsession
347347
@@ -416,7 +416,7 @@ Writing and selecting data
416416
{ 10, box.NULL, 'Queen', 1970 }
417417
})
418418
419-
Calling this function :ref:`distributes data <vshard-quick-start-working-adding-data>` evenly across the cluster's nodes.
419+
Calling this function :ref:`distributes data <vshard-quick-start-working-adding-data>` evenly across the cluster nodes.
420420

421421
2. To get a tuple by the specified ID, call the ``crud.get()`` function:
422422

@@ -464,7 +464,7 @@ Writing and selecting data
464464
Checking data distribution
465465
~~~~~~~~~~~~~~~~~~~~~~~~~~
466466

467-
To check how data is distributed across the cluster's nodes, follow the steps below:
467+
To check how data is distributed across the replica sets, follow the steps below:
468468

469469
1. Connect to any storage in the ``storage-a`` replica set:
470470

0 commit comments

Comments
 (0)