Skip to content

Commit d233dd8

Browse files
authored
Move master parameter to other section (#3117)
1 parent 4c54f66 commit d233dd8

File tree

2 files changed

+42
-40
lines changed

2 files changed

+42
-40
lines changed

doc/reference/reference_rock/vshard/vshard_ref.rst

Lines changed: 40 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ Basic parameters
2121
* :ref:`rebalancer_max_receiving <cfg_basic-rebalancer_max_receiving>`
2222
* :ref:`rebalancer_max_sending <cfg_basic-rebalancer_max_sending>`
2323
* :ref:`discovery_mode <cfg_basic-discovery_mode>`
24-
* :ref:`master <cfg_basic-master>`
2524

2625
.. _cfg_basic-sharding:
2726

@@ -175,14 +174,46 @@ Basic parameters
175174
| Default: 'on'
176175
| Dynamic: yes
177176
178-
.. _cfg_basic-master:
177+
.. _vshard-config-replica-set-funcs:
178+
179+
-------------------------------------------------------------------------------
180+
Replica set parameters
181+
-------------------------------------------------------------------------------
182+
183+
* :ref:`uuid <cfg_replica_set-uuid>`
184+
* :ref:`weight <cfg_replica_set-weight>`
185+
* :ref:`master <cfg_replica_set-master>`
186+
187+
.. _cfg_replica_set-uuid:
188+
189+
.. confval:: uuid
190+
191+
A unique identifier of a replica set.
192+
193+
| Type:
194+
| Default:
195+
| Dynamic:
196+
197+
.. _cfg_replica_set-weight:
198+
199+
.. confval:: weight
200+
201+
A weight of a replica set. See the :ref:`Replica set weights <vshard-replica-set-weights>`
202+
section for details.
203+
204+
| Type:
205+
| Default: 1
206+
| Dynamic:
207+
208+
.. _cfg_replica_set-master:
179209

180210
.. confval:: master
181211

182212
Turns on automated master discovery in a replica set if set to ``auto``.
183213
Applicable only to the configuration of a router; the storage configuration ignores this parameter.
184214

185-
The parameter should be specified per replica set and is not compatible with manual master selection.
215+
The parameter should be specified per replica set.
216+
The configuration is not compatible with a manual master selection.
186217

187218
**Examples**
188219

@@ -227,48 +258,19 @@ Basic parameters
227258
...
228259
}
229260
230-
If configuration is incorrect configuration, it is not applied, and the ``vshard.router.cfg()`` call throws an error.
231-
261+
If the configuration is incorrect, it is not applied, and the ``vshard.router.cfg()`` call throws an error.
232262

233-
If the ``master`` parameter is set to ``auto`` for some replica sets, the router goes to these replica sets, discovers the master in each of them, and periodically checks if the master instance still has its master status.
234-
When the master in the replica set stops being a master, the router goes around all the nodes of the replica set and finds out which one is the new master.
263+
If the ``master`` parameter is set to ``auto`` for some replica sets, the router goes to these replica sets,
264+
discovers the master in each of them, and periodically checks if the master instance still has its master status.
265+
When the master in the replica set stops being a master, the router goes around all the nodes of the replica set
266+
to find out which one is the new master.
235267

236268
Without this setting, the router cannot detect master nodes in the configured replica sets on its own.
237269
It relies only on how they are specified in the configuration.
238-
This becomes a problem when the master changes and the change is not delivered to the router's configuration:
270+
This becomes a problem when the master changes, and the change is not delivered to the router's configuration:
239271
for instance, in case the router doesn't rely on a central configuration provider
240272
or the provider cannot deliver a new configuration due to some reason.
241273

242274
| Type: string
243275
| Default: ``nil``
244276
| Dynamic: yes
245-
246-
.. _vshard-config-replica-set-funcs:
247-
248-
-------------------------------------------------------------------------------
249-
Replica set parameters
250-
-------------------------------------------------------------------------------
251-
252-
* :ref:`uuid <cfg_replica_set-uuid>`
253-
* :ref:`weight <cfg_replica_set-weight>`
254-
255-
.. _cfg_replica_set-uuid:
256-
257-
.. confval:: uuid
258-
259-
A unique identifier of a replica set.
260-
261-
| Type:
262-
| Default:
263-
| Dynamic:
264-
265-
.. _cfg_replica_set-weight:
266-
267-
.. confval:: weight
268-
269-
A weight of a replica set. See the :ref:`Replica set weights <vshard-replica-set-weights>`
270-
section for details.
271-
272-
| Type:
273-
| Default: 1
274-
| Dynamic:

doc/reference/reference_rock/vshard/vshard_router.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -941,14 +941,14 @@ Router public API
941941

942942
.. function:: vshard.router.master_search_wakeup()
943943

944-
:ref:`Automated master discovery <cfg_basic-master>` works in its own fiber on a router,
944+
:ref:`Automated master discovery <cfg_replica_set-master>` works in its own fiber on a router,
945945
which is activated only if at least one replica set is configured to look for the master (the ``master`` parameter is set to ``auto``).
946946
The fiber wakes up within a certain period. But it is possible to wake it up on demand by using this function.
947947

948948
Manual fiber wakeup can help speed up tests for master change.
949949
Another use case is performing some actions with a router in the router console.
950950

951-
The function does nothing if master search is not :ref:`configured <cfg_basic-master>` for any replica set.
951+
The function does nothing if master search is not :ref:`configured <cfg_replica_set-master>` for any replica set.
952952

953953
:return: none
954954

0 commit comments

Comments
 (0)