Skip to content

Commit d7d4167

Browse files
authored
doc: write about tt-connect and direct terminals (#5654)
* doc: write about tt-connect and direct terminals
1 parent 94f3b86 commit d7d4167

3 files changed

Lines changed: 51 additions & 7 deletions

File tree

doc/tooling/tcm/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,5 @@ to read data. LDAP authorization is supported as well.
4747
tcm_dev_mode
4848
tcm_configuration_reference
4949
tcm_integrity_check
50+
tcm_terminals
5051
Releases <tcm_releases/index>

doc/tooling/tcm/tcm_terminals.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. _tcm_terminals:
2+
3+
Terminals
4+
=========
5+
6+
|tcm_full_name| (TCM) provides two ways to interact with Tarantool instances:
7+
8+
- ``direct`` — a terminal that connects directly to a Tarantool instance using the `go-tarantool <https://github.com/tarantool/go-tarantool/>`__ library, bypassing the `tt connect` utility
9+
- ``tt-connect`` — a terminal that uses the :ref:`tt-cli` utility to connect to a Tarantool instance
10+
11+
Both terminals allow executing SQL queries, managing cluster state, viewing metrics, and more.
12+
13+
.. _tcm_terminals_direct:
14+
15+
Terminal direct
16+
---------------
17+
18+
Authentication credentials are taken from the cluster configuration:
19+
20+
.. code-block:: yaml
21+
22+
credentials:
23+
users:
24+
tcm_tarantool:
25+
password: tcm_tarantool_password
26+
roles: [super]
27+
28+
29+
.. _tcm_terminals_tt-connect:
30+
31+
Terminal tt-connect
32+
-------------------
33+
34+
Specify the path to the tt connect utility in the tcm.yaml configuration file:
35+
36+
.. code-block:: yaml
37+
38+
mode: production
39+
cluster:
40+
tt-command: .tarantool/tt

doc/tooling/tcm/tcm_ui_overview.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -173,14 +173,17 @@ The instance page opens when you click an instance name on the **Stateboard**.
173173

174174
It provides a set of tabs for performing actions on the selected Tarantool instance:
175175

176-
- **Details** and **State** tabs: view instance details as a human-readable table
176+
* **Details** and **State** tabs: view instance details as a human-readable table
177177
or as a console output of ``box.cfg``, ``box.info``, and other built-in functions
178-
- **SQL** and **Terminal** tabs: run SQL and Lua commands on the instance
179-
- **Logs** tab: view instance logs
180-
- **Slabs** tab: view :ref:`slab allocator <memtx-memory>` statistics
181-
- **Users** tab: manage Tarantool :ref:`users and roles <tcm_cluster_users>` on the instance
182-
- **Funcs**: manage and call stored functions
183-
- **Metrics**: view instance metrics
178+
* **SQL** and **Terminal** tabs: run SQL and Lua commands on the instance. TCM provides :ref:`two ways <tcm_terminals>` to interact with Tarantool instances:
179+
180+
- ``direct`` — a terminal that connects directly to a Tarantool instance using the `go-tarantool <https://github.com/tarantool/go-tarantool/>`__ library, bypassing the tt connect utility
181+
- ``tt-connect`` — a terminal that uses the :ref:`tt-cli` utility to connect to a Tarantool instance
182+
* **Logs** tab: view instance logs
183+
* **Slabs** tab: view :ref:`slab allocator <memtx-memory>` statistics
184+
* **Users** tab: manage Tarantool :ref:`users and roles <tcm_cluster_users>` on the instance
185+
* **Funcs**: manage and call stored functions
186+
* **Metrics**: view instance metrics
184187

185188
The instance page has an **Actions** menu at the top that allows you to:
186189

0 commit comments

Comments
 (0)