Skip to content

Commit 19fa932

Browse files
committed
Add box.cfg settings: bootstrap_leader
1 parent b37accf commit 19fa932

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

doc/reference/configuration/cfg_replication.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
* :ref:`replication <cfg_replication-replication>`
22
* :ref:`replication_anon <cfg_replication-replication_anon>`
3+
* :ref:`bootstrap_leader <cfg_replication-bootstrap_leader>`
34
* :ref:`bootstrap_strategy <cfg_replication-bootstrap_strategy>`
45
* :ref:`replication_connect_timeout <cfg_replication-replication_connect_timeout>`
56
* :ref:`replication_connect_quorum <cfg_replication-replication_connect_quorum>`
@@ -206,6 +207,31 @@
206207
| Dynamic: **yes**
207208
208209

210+
.. _cfg_replication-bootstrap_leader:
211+
212+
.. confval:: bootstrap_leader
213+
214+
Since :doc:`3.0.0 </release/3.0.0>`.
215+
216+
A bootstrap leader for a replica set.
217+
You can pass a bootstrap leader's URI, UUID, or name.
218+
219+
To specify a bootstrap leader manually, you need to set :ref:`bootstrap_strategy <cfg_replication-bootstrap_strategy>` to ``config``, for example:
220+
221+
.. code-block:: lua
222+
223+
box.cfg{
224+
bootstrap_strategy = 'config',
225+
bootstrap_leader = '127.0.0.1:3301',
226+
replication = {'127.0.0.1:3301'},
227+
}
228+
229+
| Type: string
230+
| Default: null
231+
| Environment variable: TT_BOOTSTRAP_LEADER
232+
| Dynamic: **yes**
233+
234+
209235
.. _cfg_replication-bootstrap_strategy:
210236

211237
.. confval:: bootstrap_strategy
@@ -221,6 +247,11 @@
221247
In the case of 4 or 5 nodes, at least 3 connected instances are required.
222248
Moreover, a bootstrap leader fails to boot unless every connected node has chosen it as a bootstrap leader.
223249

250+
* ``config``: use the specified node to bootstrap a replica set.
251+
To specify the bootstrap leader, use the :ref:`bootstrap_leader <cfg_replication-bootstrap_leader>` option.
252+
253+
* ``supervised``: a bootstrap leader isn't chosen automatically but should be appointed using :ref:`box.ctl.make_bootstrap_leader() <box_ctl-make_bootstrap_leader>` on the desired node.
254+
224255
* ``legacy`` (deprecated since :doc:`2.11.0 </release/2.11.0>`): a node requires the :ref:`replication_connect_quorum <cfg_replication-replication_connect_quorum>` number of other nodes to be connected.
225256
This option is added to keep the compatibility with the current versions of Cartridge and might be removed in the future.
226257

0 commit comments

Comments
 (0)