Use the CRUD module in the 'Creating a sharded cluster' tutorial #4338
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andreyaksenov
force-pushed
the
sharded_cluster_use_crud
branch
2 times, most recently
from
a48aac8 to
a4de561
Compare
andreyaksenov
force-pushed
the
sharded_cluster_use_crud
branch
from
a4de561 to
f7b1802
Compare
andreyaksenov
force-pushed
the
sharded_cluster_use_crud
branch
from
f7b1802 to
f42fe02
Compare
Totktonada
approved these changes
Jul 5, 2024
p7nov
approved these changes
Jul 8, 2024
doc/how-to/vshard_quick.rst
Outdated
|
|
||
| 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. | ||
| To enable sharding in the cluster, the :ref:`vshard <vshard>` module is used. | ||
| In this tutorial, the following external modules are used: |
There was a problem hiding this comment.
Same introduction in two sentences in a row.
doc/how-to/vshard_quick.rst
Outdated
| In this tutorial, the following external modules are used: | ||
|
|
||
| - :ref:`vshard <vshard>` enables sharding in the cluster. | ||
| - `crud <https://github.com/tarantool/crud>`__ allows you to perform CRUD operations in the sharded cluster. |
There was a problem hiding this comment.
"crud allows .. CRUD operations" - the wording seems a bit useless:
- those who know the CRUD acronym can guess the module purpose by the name
- those who don't know it aren't getting any useful explanation.
Maybe write something about data operations or manipulation.
There was a problem hiding this comment.
Changed to allows you to manipulate data in a sharded cluster.
doc/how-to/vshard_quick.rst
Outdated
| @@ -128,6 +131,10 @@ In this section, the following options are configured: | |||
| In particular, this option informs other replica set members that the ``replicator`` user should be used to connect to the current instance. | |||
| * ``iproto.advertise.sharding`` specifies how to advertise the current instance to a router and rebalancer. | |||
|
|
|||
| 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. | |||
| This option accepts a URI used to advertise the instance to clients. | |||
| For example, |tcm_full_name| uses these URIs to :ref:`connect <tcm_connect_clusters>` to cluster instances. | |||
There was a problem hiding this comment.
Maybe a link to TCM? Since it was never introduced and newcomers hardly know about it.
|
|
||
| sharded_cluster:router-a-001> vshard.router.bootstrap() | ||
| sharded_cluster_crud:router-a-001> vshard.router.bootstrap() |
There was a problem hiding this comment.
Maybe mention thett rs vshard bootstrap alternative?
There was a problem hiding this comment.
Also, an idea: I've recently read the vshard.router.bootstrap reference and found it very useful for newcomers. bootstrap is a pretty technical and broad term, while .. and distribute buckets makes is really easy to understand for the first time.
andreyaksenov
force-pushed
the
sharded_cluster_use_crud
branch
from
01c0665 to
2e3a499
Compare
andreyaksenov
force-pushed
the
sharded_cluster_use_crud
branch
from
2e3a499 to
98306a5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previous update (migrating tutorial to a new config): #4042.
Fixes #4282.
crudmodule: Creating a sharded cluster. A new configuration also includes theiproto.advertise.clientoption specified for each instance (see Step 4: Defining the cluster topology). So, along with using thecrudmodule the resulting cluster can be managed by TCM and can be used to demonstrate TCM capabilities.sharded_cluster_crudsample:sharded_cluster_crudandsharded_clustersamples.Note that the old
sharded_clustersample still exists and its code snippets are referenced in the Sharding with vshard topic.