Skip to content

Add TCM overview #3848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 15, 2023
Merged

Add TCM overview #3848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81b8d63
Add TCM overview
p7nov Nov 15, 2023
5c50f84
Fix
p7nov Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/reference/tooling/index.rst
View file
Open in desktop
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
View file
Open in desktop
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.
Copy link
Contributor

@andreyaksenov andreyaksenov Nov 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, replace sends with publishes for terminology consistency with tt: ... it publishes the saved configuration to etcd.. Looks like send work better for networking things, for example, sending a network packet.

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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ vshard
boolean
failover
rebalancer
TCM