diff --git a/doc/reference/tooling/index.rst b/doc/reference/tooling/index.rst index d68e4c91ec..f3b8d598c1 100644 --- a/doc/reference/tooling/index.rst +++ b/doc/reference/tooling/index.rst @@ -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 diff --git a/doc/reference/tooling/tcm/index.rst b/doc/reference/tooling/tcm/index.rst new file mode 100644 index 0000000000..52dd41c720 --- /dev/null +++ b/doc/reference/tooling/tcm/index.rst @@ -0,0 +1,31 @@ +.. _tcm: + +Tarantool Cluster Manager +========================= + +.. admonition:: Enterprise Edition + :class: fact + + |tcm_full_name| is a part of the `Enterprise Edition `_. + +|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 `. +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 diff --git a/prolog.rst b/prolog.rst index 967293b9af..c1a95fe5ec 100644 --- a/prolog.rst +++ b/prolog.rst @@ -36,3 +36,9 @@ .. |iproto_version| replace:: 3 +.. |tcm_full_name| replace:: Tarantool Cluster Manager + +.. |tcm| replace:: TCM + +.. |tcm_version| replace:: TCM + diff --git a/styles/Vocab/Tarantool/accept.txt b/styles/Vocab/Tarantool/accept.txt index 79dc6dbd8d..d10d3141e8 100644 --- a/styles/Vocab/Tarantool/accept.txt +++ b/styles/Vocab/Tarantool/accept.txt @@ -46,3 +46,4 @@ vshard boolean failover rebalancer +TCM