diff --git a/doc/tooling/tcm/_images/tcm_ui_tcf.png b/doc/tooling/tcm/_images/tcm_ui_tcf.png new file mode 100644 index 000000000..935fe6471 Binary files /dev/null and b/doc/tooling/tcm/_images/tcm_ui_tcf.png differ diff --git a/doc/tooling/tcm/tcm_cluster_management/index.rst b/doc/tooling/tcm/tcm_cluster_management/index.rst index fd1466981..189e58356 100644 --- a/doc/tooling/tcm/tcm_cluster_management/index.rst +++ b/doc/tooling/tcm/tcm_cluster_management/index.rst @@ -20,4 +20,5 @@ to learn how to perform various management operations on Tarantool clusters from tcm_cluster_security tcm_cluster_metrics tcm_supervised_failover - tcm_cluster_migrations \ No newline at end of file + tcm_cluster_migrations + tcm_cluster_tcf \ No newline at end of file diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_tcf.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_tcf.rst new file mode 100644 index 000000000..e18c7be0c --- /dev/null +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_tcf.rst @@ -0,0 +1,23 @@ +.. _tcm_cluster_tcf: + +TCF integration +=============== + +.. include:: ../index.rst + :start-after: ee_note_tcm_start + :end-before: ee_note_tcm_end + +|tcm_full_name| provides a web interface for clusters that run within `Tarantool Clusters Federation `__. +It is available on the **Cluster** > **TCF** page. If a connected cluster is +configured to run in a TCF installation, this page shows information about both +clusters in this installation: their ID's, names, and statuses. To switch cluster +states in TCF, click **Toggle** on the **TCF** page. + +To learn more about Tarantool Clusters Federation, see `its documentation `__. + +.. note:: + + For individual clusters, the **TCF** page is empty. + + + diff --git a/doc/tooling/tcm/tcm_releases/tcm_1.2.rst b/doc/tooling/tcm/tcm_releases/tcm_1.2.rst index 6a161dee4..498d988dc 100644 --- a/doc/tooling/tcm/tcm_releases/tcm_1.2.rst +++ b/doc/tooling/tcm/tcm_releases/tcm_1.2.rst @@ -46,4 +46,14 @@ Cluster security settings Since version 1.2.2, |tcm| provides a web interface for managing cluster security settings on the **Security** page in the **Cluster** group. -Learn more about managing cluster security from |tcm| in :ref:`tcm_cluster_security`. \ No newline at end of file +Learn more about managing cluster security from |tcm| in :ref:`tcm_cluster_security`. + +.. _tcm_releases_1_2_tcf: + +TCF integration +--------------- + +Since version 1.2.2, |tcm| includes a page for managing clusters that +run within `Tarantool Clusters Federation `__. + +Learn more about working with TCF in |tcm| in :ref:`tcm_cluster_tcf`. diff --git a/doc/tooling/tcm/tcm_ui_overview.rst b/doc/tooling/tcm/tcm_ui_overview.rst index bf7c87cf1..3c2234d40 100644 --- a/doc/tooling/tcm/tcm_ui_overview.rst +++ b/doc/tooling/tcm/tcm_ui_overview.rst @@ -199,6 +199,7 @@ The **Migrations** page provides centralized migration management tools for the :alt: TCM cluster migrations page Learn more in :ref:`tcm_cluster_migrations`. + .. _tcm_ui_cluster_tuples: Tuples @@ -222,6 +223,25 @@ On this page, you can: - view the list of user spaces, their size and engines - view and edit tuples stored in user spaces +.. _tcm_ui_cluster_tcf: + +TCF +~~~ + +The **TCF** page provides an interface for clusters that run within `Tarantool Clusters Federation `__. + +.. image:: _images/tcm_ui_tcf.png + :align: left + :width: 700 + :alt: TCM TCF page + +On this page, you can: + +- view information about TCF clusters +- switch cluster states in a TCF installation + +Learn more in :ref:`tcm_cluster_tcf`. + .. _tcm_ui_cluster_metrics: Cluster metrics