Skip to content

Commit

Permalink
Add TCF page doc (#4613)
Browse files Browse the repository at this point in the history
Resolves #4560
  • Loading branch information
p7nov authored Oct 28, 2024
1 parent 5f6cf2d commit 55e6c89
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 2 deletions.
Binary file added doc/tooling/tcm/_images/tcm_ui_tcf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion doc/tooling/tcm/tcm_cluster_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
tcm_cluster_migrations
tcm_cluster_tcf
23 changes: 23 additions & 0 deletions doc/tooling/tcm/tcm_cluster_management/tcm_cluster_tcf.rst
Original file line number Diff line number Diff line change
@@ -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 <https://www.tarantool.io/en/clustersfederation/>`__.
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 <https://www.tarantool.io/en/clustersfederation/doc/latest/>`__.

.. note::

For individual clusters, the **TCF** page is empty.



12 changes: 11 additions & 1 deletion doc/tooling/tcm/tcm_releases/tcm_1.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
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 <https://www.tarantool.io/en/clustersfederation/>`__.

Learn more about working with TCF in |tcm| in :ref:`tcm_cluster_tcf`.
20 changes: 20 additions & 0 deletions doc/tooling/tcm/tcm_ui_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <https://www.tarantool.io/en/clustersfederation/>`__.

.. 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
Expand Down

0 comments on commit 55e6c89

Please sign in to comment.