Skip to content

Commit 81b8d63

Browse files
committed
Add TCM overview
1 parent f1277cb commit 81b8d63

File tree

4 files changed

+43
-1
lines changed

4 files changed

+43
-1
lines changed

doc/reference/tooling/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ to work with Tarantool.
77
.. toctree::
88
:maxdepth: 1
99

10-
interactive_console
1110
tt_cli/index
11+
tcm/index
12+
interactive_console
1213
tarantoolctl
1314
luajit_memprof
1415
luajit_getmetrics

doc/reference/tooling/tcm/index.rst

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:noindex:
2+
:fullwidth:
3+
4+
.. _tcm:
5+
6+
Tarantool Cluster Manager
7+
=========================
8+
9+
.. admonition:: Enterprise Edition
10+
:class: fact
11+
12+
|tcm_full_name| is a part of the `Enterprise Edition <https://www.tarantool.io/compare/>`_.
13+
14+
|tcm_full_name| (|tcm|) is a web-based visual tool for configuring, managing, and
15+
monitoring Tarantool EE clusters. It provides a GUI for working with clusters
16+
and individual instances, from monitoring their state to executing commands interactively
17+
in an instance's console.
18+
19+
|tcm| is a standalone application included in the Tarantool Enterprise Edition
20+
distribution package. It is shipped as an executable that is ready to run on Linux
21+
and macOS platforms.
22+
23+
|tcm| works only with Tarantool EE clusters that use :ref:`etcd as a configuration storage <configuration_etcd>`.
24+
When you create or edit a cluster's configuration in |tcm|, it publishes the saved
25+
configuration to etcd. This ensures consistent and reliable configuration storage.
26+
A single |tcm| installation can connect to multiple Tarantool EE clusters and
27+
switch between them in one click.
28+
29+
To provide enterprise-grade security, |tcm| features its own role-based access control.
30+
You can create users and assign them roles that include required permissions.
31+
For example, a user can be an administrator of a specific cluster or only have the right
32+
to read data. LDAP authorization is supported as well.
33+
34+
.. TODO: table of contents

prolog.rst

+6
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,9 @@
3636

3737
.. |iproto_version| replace:: 3
3838

39+
.. |tcm_full_name| replace:: Tarantool Cluster Manager
40+
41+
.. |tcm| replace:: TCM
42+
43+
.. |tcm_version| replace:: TCM
44+

styles/Vocab/Tarantool/accept.txt

+1
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,4 @@ vshard
4646
boolean
4747
failover
4848
rebalancer
49+
TCM

0 commit comments

Comments
 (0)