Skip to content

Commit 93199bd

Browse files
maryiaLichkomaryiaLichko
authored
TCM: release notes debt (#5665)
* doc: 1.7 release notes * doc: 1.8 release notes * doc: 1.8 release notes * doc: 1.9 release notes * doc: add some corrections
1 parent d7d4167 commit 93199bd

4 files changed

Lines changed: 177 additions & 3 deletions

File tree

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,20 @@ Supported versions
2626
- First release date
2727
- Versions
2828

29+
* - :ref:`1.9 <tcm_releases_1_9>`
30+
- April 17, 2026
31+
- | 1.9.1
32+
- | 1.9.0
33+
34+
* - :ref:`1.8 <tcm_releases_1_8>`
35+
- March 30, 2026
36+
- | 1.8.0
37+
2938
* - :ref:`1.7 <tcm_releases_1_7>`
3039
- February 17, 2026
40+
- | 1.7.3
41+
- | 1.7.2
42+
- | 1.7.1
3143
- | 1.7.0
3244

3345
* - :ref:`1.6 <tcm_releases_1_6>`
@@ -71,6 +83,8 @@ Supported versions
7183
.. toctree::
7284
:maxdepth: 1
7385

86+
tcm_1.9
87+
tcm_1.8
7488
tcm_1.7
7589
tcm_1.6
7690
tcm_1.5

‎doc/tooling/tcm/tcm_releases/tcm_1.7.rst‎

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,52 @@ Tarantool Cluster Manager 1.7
55

66
Release date: February 11, 2026
77

8-
Latest release in series: 1.7.1
8+
Latest release in series: 1.7.3
99

10-
This release introduces control over automatic default cluster creation,
11-
improves LDAP authentication handling, and enhances user management capabilities in the UI.
10+
The |tcm| 1.7.x release includes a range of improvements and bug fixes aimed at enhancing the stability, usability,
11+
and configurability of the system. Key updates include a fix for the **Metrics** tab and export functionality, improvements to session management,
12+
better handling of audit log paths, enhanced visibility into migration status, and refinements to LDAP authentication.
13+
14+
.. _tcm_releases_1_7_3_metrics:
15+
16+
Metrics fix
17+
-----------
18+
19+
A bug was fixed in 1.7.3 release that prevented the **Metrics** tab from displaying data and disabled the ability to export metrics.
20+
21+
.. _tcm_releases_1_7_2_websession:
22+
23+
WebSession improvements
24+
-----------------------
25+
26+
In 1.7.2 the `websession` component has been updated to correctly handle user session creation.
27+
Users can now create the number of sessions specified in the configuration.
28+
29+
.. _tcm_releases_1_7_2_audit_log:
30+
31+
AuditLog path handling
32+
----------------------
33+
34+
The `auditlog` component now has improved support in version 1.7.2 for absolute paths in its configuration.
35+
When a relative path is provided, the audit log file is now saved relative to the application’s working directory.
36+
37+
Read more about :ref:`Audit log <tcm_audit_log>`.
38+
39+
.. _tcm_releases_1_7_1_migration:
40+
41+
Migration handling
42+
------------------
43+
44+
In 1.7.1 the migration handling has been updated to improve visibility into the state of applied migrations.
45+
If a migration is reapplied, the system now logs a warning message in the logs.
46+
47+
.. _tcm_releases_1_7_1_test_fix:
48+
49+
Connection Test Fix
50+
-------------------
51+
52+
A bug in the "test connection" functionality for Tarantool and etcd services has been fixed. Previously,
53+
the function did not correctly report the connection status for these services.
1254

1355
.. _tcm_releases_1_7_cluster_management:
1456

‎doc/tooling/tcm/tcm_releases/tcm_1.8.rst‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
.. _tcm_releases_1_8:
2+
3+
Tarantool Cluster Manager 1.8
4+
=============================
5+
6+
Release date: March 13, 2026
7+
8+
Latest release in series: 1.8.1
9+
10+
|tcm| 1.8.0 improves LDAP reliability, expands the CLI with full user and role administration capabilities,
11+
and adds safer behavior when creating clusters.
12+
This release also includes fixes that improve authentication stability after failed login attempts and correct data rendering in the **Tuples** tab.
13+
14+
.. _tcm_releases_1_8_ldap:
15+
16+
LDAP improvements
17+
-----------------
18+
19+
|tcm| 1.8.0 introduces support for cascading LDAP connections in environments where multiple LDAP domains share the same domain name.
20+
Instead of failing on the first unreachable domain, |tcm| now tries each configured domain sequentially until a successful connection is established.
21+
22+
.. _tcm_releases_1_8_new_cli_commands:
23+
24+
New CLI commands for user and role management
25+
---------------------------------------------
26+
27+
This release adds dedicated CLI commands to manage users and roles without relying on the UI.
28+
You can now create and delete users using `tcm user add` and `tcm user delete`, and create, update, or delete roles using `tcm role add`, `tcm role update`, and `tcm role delete`.
29+
30+
When creating users, the CLI supports assigning multiple roles and granting access to multiple clusters (including per-cluster permissions and ACL on/off).
31+
Passwords are validated against the configured password policy, and operations provide detailed logging to support auditing and traceability.
32+
33+
Example of user creation:
34+
35+
.. code-block:: console
36+
37+
.. tcm user add
38+
39+
--fullname 'John Doe'
40+
--description 'System administrator'
41+
--role admin-role-id
42+
--role operator-role-id
43+
--clusters cluster-id-1:cluster.config.read,cluster.config.write:true
44+
--clusters cluster-id-2:cluster.config.read:false
45+
--secret-type password
46+
--public-key john-public-key
47+
--secret-key john-secret-key
48+
49+
.. tcm role add
50+
51+
--name 'Cluster Administrator'
52+
--description 'Full access to cluster configuration and management'
53+
--permission admin.clusters.read
54+
--permission admin.clusters.write
55+
--permission admin.users.read
56+
--permission admin.users.write
57+
58+
.. _tcm_releases_1_8_cluster:
59+
60+
Safer cluster creation
61+
----------------------
62+
63+
To prevent configuration mistakes, |tcm| now shows a warning when attempting to create a new cluster using an ID that already exists.
64+
This helps catch ID conflicts early and reduces the chance of accidental misconfiguration.
65+
66+
.. _tcm_releases_1_8_fixes:
67+
68+
Fixes
69+
-----
70+
71+
- Fixed an issue where, after several failed login attempts followed by a successful login, an error could occur during logout.
72+
- Fixed an issue in the **Tuples** tab where scrolling could trigger a “data could not be found” error when connected to a cluster with multiple storages.
73+
- Improved the error returned when hitting the WebSession limit: previously it could be uninformative.

‎doc/tooling/tcm/tcm_releases/tcm_1.9.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _tcm_releases_1_9:
2+
3+
Tarantool Cluster Manager 1.9
4+
=============================
5+
6+
Release date: April 17, 2026
7+
8+
Latest release in series: 1.9.1
9+
10+
|tcm| 1.9.0 expands cluster connectivity options, simplifies first-time setup by allowing initial user and role provisioning from configuration,
11+
and improves observability in **Stateboard** when `vshard` issues occur. The release also includes fixes for migration storage connectivity
12+
in split-configuration setups and corrects password handling during cluster `Test connection`.
13+
14+
.. _tcm_releases_1_9_instances_connection:
15+
16+
Connect to instances via iproto.listen.uri
17+
-------------------------------------------
18+
19+
TCM can now connect to a cluster instance using `iproto.listen.uri`.
20+
This provides more flexibility in environments where instance endpoints are defined through `iproto.listen.uri` rather
21+
than alternative connection parameters, and helps align |tcm| connectivity with the instance’s actual listen configuration.
22+
23+
.. _tcm_releases_1_9_boostrap:
24+
25+
Bootstrap users and roles on first launch
26+
-----------------------------------------
27+
28+
|tcm| 1.9.0 introduces the ability to create users and roles on the very first |tcm| launch using the initial-settings field in the configuration.
29+
Roles can be created with an explicit ID or without one, allowing you to either keep stable identifiers across environments or let the system generate them as needed.
30+
31+
.. _tcm_releases_1_9_boostrap:
32+
33+
Stateboard router indicators for vshard errors
34+
----------------------------------------------
35+
36+
**Stateboard** tab now provides a router indicator response when `vshard` errors occur.
37+
This change improves diagnostics by making routing-related problems more visible and easier to interpret during incident investigation.
38+
39+
.. _tcm_releases_1_9_fixed:
40+
41+
Fixes
42+
-----
43+
- Fixed a migration storage connection error that could occur when cluster configuration and |tcm| configuration are stored in different configuration storages.
44+
- Fixed incorrect password handling during `Test connection` when creating or updating a cluster, ensuring the test uses the intended credentials.
45+
- Fixed a bug where, after a failed migration, the resulting migration status was not properly recorded or displayed, ensuring accurate state tracking and more reliable migration workflows.

0 commit comments

Comments
 (0)