Skip to content

Commit

Permalink
Add TCM overview (#3848)
Browse files Browse the repository at this point in the history
Resolves #3601
  • Loading branch information
p7nov authored and andreyaksenov committed Nov 21, 2023
1 parent ad4dcc7 commit bbc1166
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/reference/tooling/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ to work with Tarantool.
.. toctree::
:maxdepth: 1

interactive_console
tt_cli/index
tcm/index
interactive_console
tarantoolctl
luajit_memprof
luajit_getmetrics
31 changes: 31 additions & 0 deletions doc/reference/tooling/tcm/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _tcm:

Tarantool Cluster Manager
=========================

.. admonition:: Enterprise Edition
:class: fact

|tcm_full_name| is a part of the `Enterprise Edition <https://www.tarantool.io/compare/>`_.

|tcm_full_name| (|tcm|) is a web-based visual tool for configuring, managing, and
monitoring Tarantool EE clusters. It provides a GUI for working with clusters
and individual instances, from monitoring their state to executing commands interactively
in an instance's console.

|tcm| is a standalone application included in the Tarantool Enterprise Edition
distribution package. It is shipped as an executable that is ready to run on Linux
and macOS platforms.

|tcm| works only with Tarantool EE clusters that use :ref:`etcd as a configuration storage <configuration_etcd>`.
When you create or edit a cluster's configuration in |tcm|, it publishes the saved
configuration to etcd. This ensures consistent and reliable configuration storage.
A single |tcm| installation can connect to multiple Tarantool EE clusters and
switch between them in one click.

To provide enterprise-grade security, |tcm| features its own role-based access control.
You can create users and assign them roles that include required permissions.
For example, a user can be an administrator of a specific cluster or only have the right
to read data. LDAP authorization is supported as well.

.. TODO: table of contents
6 changes: 6 additions & 0 deletions prolog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@

.. |iproto_version| replace:: 3

.. |tcm_full_name| replace:: Tarantool Cluster Manager

.. |tcm| replace:: TCM

.. |tcm_version| replace:: TCM

1 change: 1 addition & 0 deletions styles/Vocab/Tarantool/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ vshard
boolean
failover
rebalancer
TCM

0 comments on commit bbc1166

Please sign in to comment.