Skip to content

Commit f67ce67

Browse files
committed
errors fixed
1 parent fdbeba7 commit f67ce67

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

doc/reference/configuration/configuration_reference.rst

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3620,7 +3620,7 @@ The ``replication`` section defines configuration parameters related to :ref:`re
36203620

36213621
- **Startup**. When the cluster starts, ``autoexpel`` checks and removes instances not matching the updated configuration.
36223622
- **Reconfiguration**. When the YAML configuration is reloaded, ``autoexpel`` compares the current state to the updated configuration and performs necessary expulsions.
3623-
- ``box.status`` **Watcher event**. Changes detected by the ``box.status`` watcher also trigger the ``autoexpel`` mechanism.
3623+
- ``box.status`` **watcher event**. Changes detected by the ``box.status`` watcher also trigger the ``autoexpel`` mechanism.
36243624

36253625

36263626
``autoexpel`` does not take any actions on newly joined instances unless one of the triggering events occurs.
@@ -3634,7 +3634,7 @@ The ``replication`` section defines configuration parameters related to :ref:`re
36343634

36353635
Configuration fields
36363636

3637-
- ``by`` :ref:`replication.autoexpel_by.*` (string, default: ``nil``): specifies the ``autoexpel`` criterion. Currently, only ``prefix`` is supported and must be explicitly set.
3637+
- ``by`` (string, default: ``nil``): specifies the ``autoexpel`` criterion. Currently, only ``prefix`` is supported and must be explicitly set.
36383638

36393639
- ``enabled`` (boolean, default: ``false``): enables or disables the ``autoexpel`` logic.
36403640

@@ -3649,6 +3649,7 @@ replication.autoexpel_by.*
36493649
subject to the ``autoexpel`` process.
36503650

36513651
The by field helps differentiate between:
3652+
36523653
- Instances that are part of the cluster and should adhere to the YAML configuration.
36533654
- Instances or tools (e.g., CDC tools) that use the replication channel but are not part of the cluster configuration.
36543655

@@ -3658,7 +3659,8 @@ replication.autoexpel_by.*
36583659
based on their names, matching them against a prefix pattern defined in the configuration.
36593660

36603661
If the ``autoexpel`` feature is enabled (``enabled: true``), the ``by`` field must be explicitly set to ``prefix``.
3661-
The absence of this field or an unsupported value will result in configuration errors.
3662+
3663+
The absence of this field or an unsupported value will result in configuration errors.
36623664

36633665
.. code-block:: yaml
36643666
@@ -3671,7 +3673,7 @@ replication.autoexpel_by.*
36713673
|
36723674
| Type: string
36733675
| Default: ``nil``
3674-
| Environment variable: TT_REPLICATION_BY
3676+
| Environment variable: TT_REPLICATION_AUTOEXPEL_BY
36753677
36763678

36773679

@@ -3713,7 +3715,7 @@ replication.autoexpel_enabled.*
37133715
|
37143716
| Type: boolean
37153717
| Default: ``false``
3716-
| Environment variable: TT_REPLICATION_ENABLED
3718+
| Environment variable: TT_REPLICATION_AUTOEXPEL_ENABLED
37173719
37183720

37193721
replication.autoexpel_prefix.*
@@ -3728,13 +3730,13 @@ replication.autoexpel_prefix.*
37283730
This field is **mandatory** when ``replication.autoexpel_enabled`` is set to ``true``.
37293731

37303732

3731-
How It Works:
3733+
How it works:
37323734

3733-
1. The prefix filters instance names (e.g., ``{{ replicaset_name }}`` for replicaset-specific names or i- for names starting with i-).
3735+
1. The prefix filters instance names (e.g., ``{{ replicaset_name }}`` for replicaset-specific names or ``i-`` for names starting with ``i-``).
37343736
2. Instances matching the prefix and removed from the YAML configuration are expelled.
37353737
3. Unnamed instances or those not matching the prefix are ignored.
37363738

3737-
Dynamic Prefix Based on Replicaset Name:
3739+
Dynamic prefix based on replicaset name:
37383740

37393741
.. code-block:: yaml
37403742
@@ -3746,11 +3748,12 @@ replication.autoexpel_prefix.*
37463748
37473749
37483750
In this setup:
3751+
37493752
- Instances are grouped by replicaset names (e.g., ``r-001-i-001`` for ``replicaset r-001``).
37503753
- The prefix ensures that only instances with names matching the replicaset name are auto expelled when removed from the configuration.
37513754

37523755

3753-
Static Prefix for Matching Patterns:
3756+
Static prefix for matching patterns:
37543757

37553758
.. code-block:: yaml
37563759
@@ -3761,13 +3764,15 @@ replication.autoexpel_prefix.*
37613764
prefix: 'i-'
37623765
37633766
In this setup:
3767+
37643768
- All instances with names starting with ``i-`` (e.g., ``i-001``, ``i-002``) are considered for expulsion.
37653769
- This is useful when instances follow a uniform naming convention.
37663770

37673771
|
37683772
| Type: string
37693773
| Default: ``nil``
3770-
| Environment variable: TT_REPLICATION_PREFIX
3774+
| Environment variable: TT_REPLICATION_AUTOEXPEL_PREFIX
3775+
37713776

37723777

37733778
**Full Example**
@@ -3871,13 +3876,6 @@ replication.autoexpel_prefix.*
38713876
38723877
After the reload, ``r-001-i-003`` should no longer appear in the ``_cluster`` system space.
38733878

3874-
|
3875-
| Type: boolean
3876-
| Default: false
3877-
| Environment variable:
3878-
| TT_REPLICATION_AUTOEXPEL_BY
3879-
| TT_REPLICATION_AUTOEXPEL_ENABLED
3880-
| TT_REPLICATION_AUTOEXPEL_PREFIX
38813879

38823880

38833881
.. _configuration_reference_replication_bootstrap_strategy:

0 commit comments

Comments
 (0)