Skip to content

Commit 9359e95

Browse files
committed
Update per review
1 parent 8693fb8 commit 9359e95

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

doc/reference/configuration/cfg_replication.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -722,6 +722,21 @@
722722
Specify the instance name.
723723
This value must be unique in a replica set.
724724

725+
The following rules are applied to instance names:
726+
727+
- The maximum number of symbols is 63.
728+
- Should start with a letter.
729+
- Can contain lowercase letters (a-z). If uppercase letters are used, they are converted to lowercase.
730+
- Can contain digits (0-9).
731+
- Can contain the following characters: ``-``, ``_``.
732+
733+
To change or remove the specified name, you should temporarily set the :ref:`box.cfg.force_recovery <cfg_binary_logging_snapshots-force_recovery>` configuration option to ``true``.
734+
When all the names are updated and all the instances synced, ``box.cfg.force_recovery`` can be set back to ``false``.
735+
736+
.. NOTE::
737+
738+
The instance name is persisted in the :ref:`box.space._cluster <box_space-cluster>` system space.
739+
725740
See also: :ref:`box_info_name`
726741

727742
|
@@ -739,6 +754,15 @@
739754
Specify the name of a replica set to which this instance belongs.
740755
This value must be the same for all instances of the replica set.
741756

757+
See the :ref:`instance_name <cfg_replication-instance_name>` description to learn:
758+
759+
- which rules are applied to names
760+
- how to change or remove an already specified name
761+
762+
.. NOTE::
763+
764+
The replica set name is persisted in the :ref:`box.space._schema <box_space-schema>` system space.
765+
742766
See also: :ref:`box_info_replicaset`
743767

744768
|
@@ -756,6 +780,15 @@
756780
Specify the name of a cluster to which this instance belongs.
757781
This value must be the same for all instances of the cluster.
758782

783+
See the :ref:`instance_name <cfg_replication-instance_name>` description to learn:
784+
785+
- which rules are applied to names
786+
- how to change or remove an already specified name
787+
788+
.. NOTE::
789+
790+
The cluster name is persisted in the :ref:`box.space._schema <box_space-schema>` system space.
791+
759792
See also: :ref:`box_info_cluster`
760793

761794
|

doc/reference/configuration/configuration_reference.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2548,6 +2548,14 @@ The ``groups`` section provides the ability to define the :ref:`full topology of
25482548

25492549
A group name.
25502550

2551+
The following rules are applied to group names:
2552+
2553+
- The maximum number of symbols is 63.
2554+
- Should start with a letter.
2555+
- Can contain lowercase letters (a-z).
2556+
- Can contain digits (0-9).
2557+
- Can contain the following characters: ``-``, ``_``.
2558+
25512559
.. _configuration_reference_groups_name_replicasets:
25522560

25532561
.. confval:: groups.<group_name>.replicasets
@@ -2582,6 +2590,9 @@ replicasets
25822590

25832591
A replica set name.
25842592

2593+
Note that the rules applied to a replica set name are the same as for groups.
2594+
Learn more in :ref:`groups.\<group_name\> <configuration_reference_groups_name>`.
2595+
25852596
.. _configuration_reference_replicasets_name_leader:
25862597

25872598
.. confval:: replicasets.<replicaset_name>.leader
@@ -2645,6 +2656,9 @@ instances
26452656

26462657
An instance name.
26472658

2659+
Note that the rules applied to an instance name are the same as for groups.
2660+
Learn more in :ref:`groups.\<group_name\> <configuration_reference_groups_name>`.
2661+
26482662
.. _configuration_reference_instances_name_config_parameter:
26492663

26502664
.. confval:: instances.<instance_name>.<config_parameter>

0 commit comments

Comments
 (0)