Skip to content

Commit 91046f9

Browse files
committed
Sharding reference: update per review
1 parent 2280807 commit 91046f9

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

doc/reference/configuration/configuration_reference.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2398,15 +2398,14 @@ The ``security`` section defines configuration parameters related to various sec
23982398
sharding
23992399
--------
24002400

2401-
The ``sharding`` section defines configuration parameters related to sharding.
2401+
The ``sharding`` section defines configuration parameters related to :ref:`sharding <vshard-admin>`.
24022402

24032403
.. NOTE::
24042404

24052405
Sharding support requires installing the :ref:`vshard <vshard>` module.
24062406
The minimum required version of ``vshard`` is 0.1.25.
24072407

24082408
- :ref:`sharding.bucket_count <configuration_reference_sharding_bucket_count>`
2409-
- :ref:`sharding.connection_outdate_delay <configuration_reference_sharding_connection_outdate_delay>`
24102409
- :ref:`sharding.discovery_mode <configuration_reference_sharding_discovery_mode>`
24112410
- :ref:`sharding.failover_ping_timeout <configuration_reference_sharding_failover_ping_timeout>`
24122411
- :ref:`sharding.lock <configuration_reference_sharding_lock>`
@@ -2453,21 +2452,21 @@ The ``sharding`` section defines configuration parameters related to sharding.
24532452
| Default: 3000
24542453
| Environment variable: TT_SHARDING_BUCKET_COUNT
24552454
2455+
.. TODO: Remove: for internal use
2456+
.. _configuration_reference_sharding_connection_outdate_delay:
24562457
2457-
.. _configuration_reference_sharding_connection_outdate_delay:
2458+
.. confval:: sharding.connection_outdate_delay
24582459
2459-
.. confval:: sharding.connection_outdate_delay
2460+
The delay (in seconds) to outdate old replica set and replica objects after reconfiguration.
24602461
2461-
The delay (in seconds) to outdate old replica set and replica objects after reconfiguration.
2462-
2463-
.. NOTE::
2462+
.. NOTE::
24642463
2465-
This option should be defined at the :ref:`global level <configuration_scopes>`.
2464+
This option should be defined at the :ref:`global level <configuration_scopes>`.
24662465
2467-
|
2468-
| Type: number
2469-
| Default: nil
2470-
| Environment variable: TT_SHARDING_CONNECTION_OUTDATE_DELAY
2466+
|
2467+
| Type: number
2468+
| Default: nil
2469+
| Environment variable: TT_SHARDING_CONNECTION_OUTDATE_DELAY
24712470
24722471
24732472
.. _configuration_reference_sharding_discovery_mode:
@@ -2514,7 +2513,7 @@ The ``sharding`` section defines configuration parameters related to sharding.
25142513

25152514
.. NOTE::
25162515

2517-
This option should be defined at the :ref:`replica set level <configuration_scopes>`.
2516+
``sharding.lock`` can be specified at the :ref:`replica set level <configuration_scopes>` or higher.
25182517

25192518
|
25202519
| Type: boolean
@@ -2621,7 +2620,7 @@ The ``sharding`` section defines configuration parameters related to sharding.
26212620
If it is not specified, a rebalancer is selected automatically from master instances of replica sets.
26222621

26232622
There can be at most one replica set with the ``rebalancer`` role.
2624-
Additionally, this replica set should have a storage role.
2623+
Additionally, this replica set should have a ``storage`` role.
26252624

26262625
**Example:**
26272626

@@ -2730,7 +2729,7 @@ The ``sharding`` section defines configuration parameters related to sharding.
27302729

27312730
.. NOTE::
27322731

2733-
This option should be defined at the :ref:`instance level <configuration_scopes>`.
2732+
``sharding.zone`` can be specified at any :ref:`level <configuration_scopes>`.
27342733

27352734
|
27362735
| Type: integer

0 commit comments

Comments
 (0)