Skip to content

Commit bbc1166

Browse files
p7novandreyaksenov
authored andcommitted
Add TCM overview (#3848)
Resolves #3601
1 parent ad4dcc7 commit bbc1166

File tree

4 files changed

+40
-1
lines changed

4 files changed

+40
-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

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

0 commit comments

Comments
 (0)