Skip to content

Commit 4f0cbb4

Browse files
p7novp7nov
authored
Add TCM releases section with 1.0 and 1.1 (#4264)
Resolves #3602
1 parent c9756ab commit 4f0cbb4

File tree

4 files changed

+244
-0
lines changed

4 files changed

+244
-0
lines changed

‎doc/reference/tooling/tcm/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,4 @@ to read data. LDAP authorization is supported as well.
4444
tcm_configuration
4545
tcm_backend_store
4646
tcm_configuration_reference
47+
Releases <tcm_releases/index>

‎doc/reference/tooling/tcm/tcm_releases/index.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _tcm_releases:
2+
3+
Tarantool Cluster Manager releases
4+
==================================
5+
6+
.. include:: ../index.rst
7+
:start-after: ee_note_tcm_start
8+
:end-before: ee_note_tcm_end
9+
10+
This section contains the list of |tcm_full_name| releases along with descriptions
11+
of their key changes.
12+
13+
For information about Tarantool releases, see :ref:`release`.
14+
15+
.. _tcm_releases_supported:
16+
17+
Supported versions
18+
------------------
19+
20+
.. container:: table
21+
22+
.. list-table::
23+
:header-rows: 1
24+
25+
* - Series
26+
- First release date
27+
- Versions
28+
29+
* - :ref:`1.1 <tcm_releases_1_1>`
30+
- May 16, 2024
31+
- 1.1.0
32+
33+
* - :ref:`1.0 <tcm_releases_1_0>`
34+
- December 23, 2023
35+
- | 1.0.4
36+
| 1.0.3
37+
| 1.0.2
38+
| 1.0.1
39+
| 1.0.0
40+
41+
.. toctree::
42+
:maxdepth: 1
43+
44+
tcm_1.1
45+
tcm_1.0

‎doc/reference/tooling/tcm/tcm_releases/tcm_1.0.rst

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
.. _tcm_releases_1_0:
2+
3+
Tarantool Cluster Manager 1.0
4+
=============================
5+
6+
Release date: December 26, 2023
7+
8+
Latest release in series: 1.0.4
9+
10+
1.0 is the first public release series of |tcm_full_name|. It was introduced as a
11+
part of the :ref:`Tarantool EE 3.0 release <3-0-tarantool_cluster_manager>`.
12+
Below is an overview of key features of TCM 1.0.
13+
14+
.. _tcm_releases_1_0_clusters:
15+
16+
Multiple connected clusters
17+
---------------------------
18+
19+
|tcm| works as a standalone application. You can connect any number of Tarantool EE
20+
3.0+ clusters to a single |tcm| instance and switch between them on the fly.
21+
22+
To connect a cluster to |tcm|, you need to provide the endpoint URLs and connection
23+
parameters of its centralized configuration storage (for example, etcd).
24+
To learn more, see :ref:`tcm_connect_clusters`.
25+
26+
.. _tcm_releases_1_0_stateboard:
27+
28+
Cluster stateboard
29+
------------------
30+
31+
The cluster *stateboard* is a main |tcm| page that visualizes the information about
32+
the selected cluster:
33+
34+
- Cluster topology visualized as a table or a graph
35+
- Tarantool versions running on instances
36+
- Memory statistics
37+
- Errors and warnings that happen on instances
38+
39+
From the stateboard, you can navigate to specific instances to view their details
40+
or connect to their interactive consoles.
41+
42+
To learn more, see :ref:`tcm_cluster_monitoring`.
43+
44+
.. _tcm_releases_1_0_config:
45+
46+
Cluster configuration management
47+
--------------------------------
48+
49+
|tcm| includes a visual editor for cluster configuration. It allows editing cluster
50+
configurations as a YAML file in the browser. Once you're done editing the configuration,
51+
you can send the changes to the configuration storage in one click or save them locally
52+
to continue editing them later.
53+
54+
To learn more, see :ref:`tcm_configuring_clusters`.
55+
56+
.. _tcm_releases_1_0_access:
57+
58+
Role-based access control
59+
-------------------------
60+
61+
|tcm| features its own role-based access control system. It defines users that can
62+
log into |tcm| and their permissions to perform various actions or access clusters
63+
in its web interface.
64+
65+
You can use built-in roles or create new ones with permissions you need. Users'
66+
access can be limited to specific clusters and operations on them, for example,
67+
editing the configuration or calling stored functions.
68+
To learn more, see :ref:`tcm_access_control`.
69+
70+
|tcm| also supports LDAP authentication.
71+
72+
.. _tcm_releases_1_0_audit:
73+
74+
Audit logging
75+
-------------
76+
77+
|tcm| has a built-in audit logging mechanism. When enabled, it records information
78+
about events that occur in |tcm| and users' actions to dedicated audit log files.
79+
You can define events to write to the audit log and adjust logging parameters, such
80+
as filename, log rotation, or compression.
81+
82+
To learn more, see :ref:`tcm_audit_log`.

‎doc/reference/tooling/tcm/tcm_releases/tcm_1.1.rst

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
.. _tcm_releases_1_1:
2+
3+
Tarantool Cluster Manager 1.1
4+
=============================
5+
6+
Release date: May 16, 2024
7+
8+
Latest release in series: 1.1.0
9+
10+
|tcm_full_name| 1.1 introduces a number of new features that extend and improve its
11+
cluster management capabilities. Below is an overview of its key updates.
12+
13+
.. _tcm_releases_1_1_data_access:
14+
15+
Data access
16+
-----------
17+
18+
An important update of |tcm| 1.1.0 is a set of features that enable access to clusters'
19+
stored data.
20+
21+
The instance *space explorer* shows all spaces that exist on an instance, including
22+
system spaces. On its pages, you can view and edit the stored data. To open the instance explorer,
23+
find the instance on the cluster stateboard and click its name to open its details page.
24+
Then click **Explorer** in the **Actions** menu in the top right corner.
25+
26+
In the development mode, the instance explorer also includes the *schema editor*.
27+
It allows you to add new and edit existing spaces.
28+
29+
For clusters that use the `CRUD <https://github.com/tarantool/crud>`__ module,
30+
there is also the *CRUD explorer* that enables access to data in user spaces across
31+
the entire cluster. The CRUD explorer is located on the **Tuples** page.
32+
33+
.. _tcm_releases_1_1_acl:
34+
35+
Access control list
36+
-------------------
37+
38+
|tcm|'s *access control list* (*ACL*) enables control over user access to particular spaces
39+
and stored functions in the web interface.
40+
41+
For each user that has access to a cluster, you can enable the use of ACL on this cluster.
42+
This restricts this user's access to the cluster's spaces and functions unless they
43+
are explicitly specified in the ACL. The ACL must contain an entry for each such
44+
space and function.
45+
46+
Users with ACL off have access to all spaces and functions on clusters according
47+
to their cluster permissions.
48+
49+
The tools for managing ACL are located on the new **ACL** page.
50+
51+
.. _tcm_releases_1_1_api_tokens:
52+
53+
API tokens
54+
----------
55+
56+
|tcm| 1.1 supports token authentication of external requests. Users can generate
57+
API tokens in their user settings dialog. An API token has the same permissions
58+
as its creator.
59+
60+
.. _tcm_releases_1_1_stateboard:
61+
62+
Stateboard improvements
63+
-----------------------
64+
65+
|tcm| 1.1 extends the functionality of the cluster stateboard to improve the
66+
cluster management experience. Here are the key updates of the stateboard:
67+
68+
- More flexible instance grouping.
69+
- Stateful failover and switchover controls.
70+
- Runtime issues on the stateboard.
71+
72+
.. _tcm_releases_1_1_instance:
73+
74+
Instance interaction
75+
--------------------
76+
77+
The instance management dialog has been extended with new functions:
78+
79+
- A new terminal that uses the :ref:`tt interactive console <tt-interactive-console>`.
80+
- SQL query execution terminal.
81+
- Stored functions editor.
82+
- Slab visualization.
83+
84+
.. _tcm_releases_1_1_metrics:
85+
86+
Cluster metrics
87+
---------------
88+
89+
Starting from version 1.1.0, |tcm| displays metrics of connected clusters.
90+
You can view metrics in |tcm| one by one, visualizing them as charts or tables.
91+
The cluster metrics are shown on the new **Cluster metrics** page.
92+
93+
For more complex monitoring, you can use dedicated solutions, for example, Prometheus.
94+
It can integrate with |tcm| using the :ref:`API tokens <tcm_releases_1_1_api_tokens>`.
95+
96+
.. _tcm_releases_1_1_config:
97+
98+
Configuration validation
99+
------------------------
100+
101+
The cluster configuration editor now validates the configuration semantically.
102+
Previously, |tcm| was able to highlight the syntax errors in configurations, for example,
103+
incorrect spelling of option names or hierarchy. In |tcm| 1.1.0, the editor
104+
checks and highlights possible semantic issues, such as:
105+
106+
- Users without passwords.
107+
- Users with the ``super`` role.
108+
- Absence of leader instances in replica sets.
109+
110+
.. _tcm_releases_1_1_tutorial:
111+
112+
Onboarding tutorial
113+
-------------------
114+
115+
|tcm| 1.1.0 includes an interactive tutorial that takes new users through its
116+
main features and pages. It opens automatically after the first start.

0 commit comments

Comments
 (0)