Skip to content

Commit 6c28af8

Browse files
authored
doc: describe new TCF Settings page n TCM (#5415)
* doc: describe new TCF Settings page n TCM
1 parent eba75fb commit 6c28af8

File tree

4 files changed

+36
-3
lines changed

4 files changed

+36
-3
lines changed
112 KB
Loading
108 KB
Loading
-134 KB
Loading

doc/tooling/tcm/tcm_ui_overview.rst

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -357,14 +357,47 @@ TCF
357357
The **TCF** page provides an interface for clusters that run within `Tarantool Clusters Federation <https://www.tarantool.io/en/clustersfederation/>`__.
358358

359359
.. image:: _images/tcm_ui_tcf.png
360-
:align: left
360+
:align: center
361361
:width: 700
362362
:alt: TCM TCF page
363363

364+
TCF page can be added via the |tcm| configuration file:
365+
366+
.. code-block:: yaml
367+
368+
# tcm.yaml
369+
feature:
370+
tcf:True
371+
372+
364373
On this page, you can:
365374

366-
- view information about TCF clusters
367-
- switch cluster states in a TCF installation
375+
* view information about TCF clusters
376+
* toggle the state of clusters
377+
* promote or demote clusters
378+
* change key cluster parameters. To open the settings, click **Actions** (the three dots next to the cluster status) and select **Settings**. Available parameters:
379+
- ``dml_users``: list of DML users
380+
- ``cluster1``, ``cluster2``: cluster settings
381+
- ``replication_user``: replication username
382+
- ``replication_password``: password associated with the replication user
383+
- ``failover_timeout``: time period (in seconds) to wait before initiating failover to another cluster. Default value: ``20``
384+
- ``initial_status``: initial service state
385+
- ``max_suspect_counts``: maximum suspect counts for failover. Default value: ``3``
386+
- ``health_check_delay``: delay (in seconds) between health checks. Default value: ``2``
387+
- ``enable_system_check``: enables or disables system-level health checks. Default value: ``true``
388+
- ``status_ttl``: time-to-live for service status. Default value: ``4``
389+
390+
391+
.. image:: _images/tcm_tcf_settings.png
392+
:align: center
393+
:width: 700
394+
:alt: TCM TCF settings page
395+
396+
.. image:: _images/tcm_tcf_settings_params.png
397+
:align: center
398+
:width: 700
399+
:alt: TCM TCF settings page
400+
368401

369402
Learn more in :ref:`tcm_cluster_tcf`.
370403

0 commit comments

Comments
 (0)