Skip to content

Commit 55e6c89

Browse files
authored
Add TCF page doc (#4613)
Resolves #4560
1 parent 5f6cf2d commit 55e6c89

File tree

5 files changed

+56
-2
lines changed

5 files changed

+56
-2
lines changed
219 KB
Loading

doc/tooling/tcm/tcm_cluster_management/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ to learn how to perform various management operations on Tarantool clusters from
2020
tcm_cluster_security
2121
tcm_cluster_metrics
2222
tcm_supervised_failover
23-
tcm_cluster_migrations
23+
tcm_cluster_migrations
24+
tcm_cluster_tcf
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _tcm_cluster_tcf:
2+
3+
TCF integration
4+
===============
5+
6+
.. include:: ../index.rst
7+
:start-after: ee_note_tcm_start
8+
:end-before: ee_note_tcm_end
9+
10+
|tcm_full_name| provides a web interface for clusters that run within `Tarantool Clusters Federation <https://www.tarantool.io/en/clustersfederation/>`__.
11+
It is available on the **Cluster** > **TCF** page. If a connected cluster is
12+
configured to run in a TCF installation, this page shows information about both
13+
clusters in this installation: their ID's, names, and statuses. To switch cluster
14+
states in TCF, click **Toggle** on the **TCF** page.
15+
16+
To learn more about Tarantool Clusters Federation, see `its documentation <https://www.tarantool.io/en/clustersfederation/doc/latest/>`__.
17+
18+
.. note::
19+
20+
For individual clusters, the **TCF** page is empty.
21+
22+
23+

doc/tooling/tcm/tcm_releases/tcm_1.2.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,14 @@ Cluster security settings
4646
Since version 1.2.2, |tcm| provides a web interface for managing cluster security settings
4747
on the **Security** page in the **Cluster** group.
4848

49-
Learn more about managing cluster security from |tcm| in :ref:`tcm_cluster_security`.
49+
Learn more about managing cluster security from |tcm| in :ref:`tcm_cluster_security`.
50+
51+
.. _tcm_releases_1_2_tcf:
52+
53+
TCF integration
54+
---------------
55+
56+
Since version 1.2.2, |tcm| includes a page for managing clusters that
57+
run within `Tarantool Clusters Federation <https://www.tarantool.io/en/clustersfederation/>`__.
58+
59+
Learn more about working with TCF in |tcm| in :ref:`tcm_cluster_tcf`.

doc/tooling/tcm/tcm_ui_overview.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ The **Migrations** page provides centralized migration management tools for the
199199
:alt: TCM cluster migrations page
200200

201201
Learn more in :ref:`tcm_cluster_migrations`.
202+
202203
.. _tcm_ui_cluster_tuples:
203204

204205
Tuples
@@ -222,6 +223,25 @@ On this page, you can:
222223
- view the list of user spaces, their size and engines
223224
- view and edit tuples stored in user spaces
224225

226+
.. _tcm_ui_cluster_tcf:
227+
228+
TCF
229+
~~~
230+
231+
The **TCF** page provides an interface for clusters that run within `Tarantool Clusters Federation <https://www.tarantool.io/en/clustersfederation/>`__.
232+
233+
.. image:: _images/tcm_ui_tcf.png
234+
:align: left
235+
:width: 700
236+
:alt: TCM TCF page
237+
238+
On this page, you can:
239+
240+
- view information about TCF clusters
241+
- switch cluster states in a TCF installation
242+
243+
Learn more in :ref:`tcm_cluster_tcf`.
244+
225245
.. _tcm_ui_cluster_metrics:
226246

227247
Cluster metrics

0 commit comments

Comments
 (0)