Skip to content

Commit 9188854

Browse files
maryiaLichkomaryiaLichko
authored
doc: tcm update releases (#5355)
* doc: tcm release 1.3 and 1.4 added * doc: tcm release 1.5 added
1 parent 3e8dcd9 commit 9188854

File tree

4 files changed

+167
-0
lines changed

4 files changed

+167
-0
lines changed

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

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

29+
* - :ref:`1.5 <tcm_releases_1_5>`
30+
- August 28, 2025
31+
- | 1.5.1
32+
| 1.5.0
33+
34+
* - :ref:`1.4 <tcm_releases_1_4>`
35+
- June 9, 2025
36+
- 1.4.0
37+
38+
* - :ref:`1.3 <tcm_releases_1_3>`
39+
- March 14, 2025
40+
- | 1.3.1
41+
| 1.3.0
42+
2943
* - :ref:`1.2 <tcm_releases_1_2>`
3044
- July 30, 2024
3145
- | 1.2.2
@@ -47,6 +61,9 @@ Supported versions
4761
.. toctree::
4862
:maxdepth: 1
4963

64+
tcm_1.5
65+
tcm_1.4
66+
tcm_1.3
5067
tcm_1.2
5168
tcm_1.1
5269
tcm_1.0

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. _tcm_releases_1_3:
2+
3+
Tarantool Cluster Manager 1.3
4+
=============================
5+
6+
Release date: March 14, 2025
7+
8+
Latest release in series: 1.3.1
9+
10+
|tcm_full_name| 1.3.0 enhances the TCF integration page with minor bug fixes and functional improvements.
11+
Below is an overview of key updates.
12+
13+
.. _tcm_releases_1_3_0_tcf:
14+
15+
TCF page improvements
16+
------------------------
17+
18+
Starting from version 1.3.0, |tcm| provides additional actions for managing TCF clusters through the web interface.
19+
You can now use **promote** and **demote** operations directly on the **TCF** page without switching to external tools.
20+
Also, the **TCF** page is now disabled by default and must be explicitly enabled if needed.
21+
In addition, |tcm| now supports connections to multiple gRPC servers, which improves integration with distributed cluster infrastructures.
22+
23+
24+
.. _tcm_releases_1_3_0_explorer:
25+
Explorer improvements
26+
------------------------
27+
28+
|tcm| 1.3.0 introduces a new approach to pagination in the Explorer. Instead of using a tuple, the interface now relies on pointers for navigating result pages.
29+
When sending data to the frontend, binary values (varbinary) are now automatically encoded in base64.
30+
31+
Additionally, |tcm| fixes an issue where queries using a datetime key could result in type mismatch errors due to incorrect index part handling.
32+
33+
34+
.. _tcm_releases_1_3_0_etcd:
35+
etcd integration fixes
36+
------------------------
37+
38+
In this version, |tcm| improves its interaction with etcd-based data sources.
39+
Tabs that use etcd for updating can now be refreshed even if some of the etcd endpoints are temporarily unavailable.
40+
To improve stability, a check was added to detect and correctly handle empty tuple arrays, preventing unexpected errors when processing empty data.
41+
42+
43+
.. _tcm_releases_1_3_0_crud:
44+
CRUD and query parsing
45+
------------------------
46+
47+
|tcm| 1.3.0 includes improvements to how search expressions are parsed in `CRUD <https://github.com/tarantool/crud>`__ explorer queries. The CRUD explorer is located on the **Tuples** page.
48+
This release also introduces dedicated tests for the relevant components to ensure consistent behavior in future versions.
49+
50+
51+
Since version 1.3.1, |tcm| includes missing changes that have now been properly delivered.
52+
In addition, several minor issues flagged by the Svacer linter were fixed to improve overall code quality and maintainability.

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. _tcm_releases_1_4:
2+
3+
Tarantool Cluster Manager 1.4
4+
=============================
5+
6+
Release date: June 9, 2025
7+
8+
Latest release in series: 1.4.0
9+
10+
|tcm_full_name| 1.4.0 improves LDAP support and includes several enhancements and fixes aimed at improving authentication flexibility and system stability.
11+
12+
.. _tcm_releases_1_4_0_ldap:
13+
14+
LDAP support improvements
15+
------------------------
16+
17+
|tcm| 1.4.0 significantly enhances the experience of working with LDAP authentication.
18+
The web interface now includes a visual confirmation pop-up when a connection to an LDAP server is successfully established.
19+
This helps administrators quickly verify the correctness of LDAP settings without checking logs or reloading the page.
20+
21+
The authentication settings now support switching between local and LDAP methods directly in the interface, making it easier to configure hybrid or alternative access scenarios.
22+
23+
The LDAP configuration form has been simplified:
24+
25+
* The ``groupQueryTemplate`` field is now optional, allowing LDAP authentication without querying for user groups.
26+
* The ``queryUser`` and ``queryPassword`` fields are also optional, which enables anonymous binding to the LDAP server.
27+
* You now only need to provide either ``templateDN`` or ``templateQuery``, instead of both -- reducing configuration complexity.
28+
29+
More about :ref:`tcm_ldap_auth`.
30+
31+
32+
.. _tcm_releases_1_4_0_infra_fixes:
33+
34+
LDAP support improvements
35+
------------------------
36+
37+
In version 1.4.0, |tcm| improves the behavior of the etcd client.
38+
Previously, if one of the etcd nodes became unresponsive while keeping its port open, the client could hang indefinitely.
39+
This issue has been fixed to ensure better resilience of etcd-based components.
40+
41+
Additionally, the audit log mechanism now correctly creates log files in the directory of the running application binary.
42+
To learn more, see :ref:`tcm_audit_log_config`.

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _tcm_releases_1_5:
2+
3+
Tarantool Cluster Manager 1.5
4+
=============================
5+
6+
Release date: August 28, 2025
7+
8+
Latest release in series: 1.5.1
9+
10+
|tcm_full_name| 1.5.0 introduces a new UI page for configuring TCF clusters and includes important fixes that enhance reliability, compliance, and user experience.
11+
12+
13+
.. _tcm_releases_1_5_0_tcf_config:
14+
15+
TCF cluster configuration in UI
16+
-------------------------------
17+
18+
|tcm| 1.5.0 adds a dedicated settings page for managing TCF cluster parameters directly through the web interface.
19+
You can now retrieve and modify key fields that define cluster behavior and failover logic without editing configuration files manually.
20+
21+
The new page allows configuring the following parameters:
22+
23+
- ``dml_users`` -- a list of users with DML access
24+
- ``cluster1``, ``cluster2`` -- settings for connected clusters
25+
- ``replication_user``, ``replication_password`` -- replication credentials
26+
- ``failover_timeout`` -- delay before switching to a failover node
27+
- ``initial_status`` -- default service state on startup
28+
- ``max_suspect_counts`` -- the threshold for marking a node as failed
29+
- ``health_check_delay`` -- interval between health checks
30+
- ``enable_system_check`` -- toggles system-level health monitoring
31+
- ``status_ttl`` -- time-to-live for service status data
32+
33+
34+
.. _tcm_releases_1_5_0_testing:
35+
36+
Testing improvements
37+
--------------------
38+
39+
To make tests more efficient and predictable, all occurrences of ``time.Sleep`` were replaced with ``require.Eventually``.
40+
This change improves test speed and reliability. Additionally, HTTP checks and tuple insertion operations in tests were updated for better performance and accuracy.
41+
42+
43+
44+
.. _tcm_releases_1_5_0_fixes:
45+
46+
Fixes and compliance updates
47+
----------------------------
48+
49+
This release includes multiple fixes across different modules:
50+
51+
- CRUD and Explorer -- data types used during operations have been corrected to comply with FSTEC security requirements, ensuring strict typing and better protection of sensitive data.
52+
- Authentication -- the system no longer relies on etcd for storing authentication parameters. Instead, it uses local configuration to improve startup reliability and simplify setup.
53+
- Logging -- fixed issues with log output by switching to the ``slog`` logging system.
54+
- UI -- resolved display issues in the ``OperationStatus`` component.
55+
- Tuples -- fixed an error that caused tab refresh failures in clusters with a large number of spaces.
56+

0 commit comments

Comments
 (0)