Skip to content

Commit 5f6cf2d

Browse files
authored
Add TCM security page doc (#4611)
Resolves #4477
1 parent 019ecb5 commit 5f6cf2d

File tree

6 files changed

+57
-3
lines changed

6 files changed

+57
-3
lines changed

doc/platform/security/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ types of connections:
3333
* Over a binary port for read and write operations and procedure invocation.
3434

3535
For more information on authentication and connection types, see the
36-
:ref:`admin-security` section of the Tarantool manual.
36+
:ref:`admin-security` section in :ref:`Administration <admin>`.
3737

3838
In addition, Tarantool provides the following functionality:
3939

233 KB
Loading

doc/tooling/tcm/tcm_cluster_management/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ to learn how to perform various management operations on Tarantool clusters from
1717
tcm_cluster_state
1818
tcm_cluster_config
1919
tcm_cluster_users
20+
tcm_cluster_security
2021
tcm_cluster_metrics
2122
tcm_supervised_failover
2223
tcm_cluster_migrations
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. _tcm_cluster_security:
2+
3+
Security settings
4+
=================
5+
6+
.. include:: ../index.rst
7+
:start-after: ee_note_tcm_start
8+
:end-before: ee_note_tcm_end
9+
10+
|tcm_full_name| includes a web interface for managing security settings of connected
11+
clusters. It is available on the **Cluster** > **Security** page. On this page,
12+
you can manage the following security features in the cluster:
13+
14+
- *Authentication settings*: protocol (CHAP or PAP), number of retries, and
15+
the delay after a failed authentication attempt (:ref:`security.auth_* <configuration_reference_security>`
16+
configuration options). To learn more about Tarantool authentication settings, see :ref:`configuration_authentication`.
17+
- *Password policy*: minimal password length, required characters, expiration
18+
period, and other settings (:ref:`security.password_* <configuration_reference_security>`
19+
configuration options). To learn more about Tarantool password policy, see :ref:`enterprise-password-policy`.
20+
- *Guest access*: whether unauthenticated or :ref:`guest <authentication-passwords>`
21+
users can connect to cluster (:ref:`security.disable_guest <configuration_reference_security_disable_guest>`
22+
configuration option).
23+
- *Secure erasing*: whether to delete data files securely so that they cannot be restored
24+
(:ref:`security.secure_erasing <configuration_reference_security_secure_erasing>` configuration option).
25+
- *Audit log*: configure audit logging in the cluster
26+
(:ref:`audit_log.* <configuration_reference_audit>` configuration options).
27+
To learn how to manage audit logging in the cluster, see :ref:`enterprise_audit_module`.
28+
29+
30+

doc/tooling/tcm/tcm_releases/tcm_1.2.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,14 @@ on connected clusters. The new page **Migrations** in the **Cluster** page group
3636
provides a text editor where you can write migration scripts in Lua and apply them
3737
to the cluster.
3838

39-
Learn more about migrations in Tarantool :ref:`migrations`.
39+
Learn more about migrations in Tarantool :ref:`migrations`.
40+
41+
.. _tcm_releases_1_2_cluster_security:
42+
43+
Cluster security settings
44+
-------------------------
45+
46+
Since version 1.2.2, |tcm| provides a web interface for managing cluster security settings
47+
on the **Security** page in the **Cluster** group.
48+
49+
Learn more about managing cluster security from |tcm| in :ref:`tcm_cluster_security`.

doc/tooling/tcm/tcm_ui_overview.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,20 @@ sent to this centralized storage.
172172

173173
Learn more in :ref:`tcm_configuring_clusters`.
174174

175+
.. _tcm_ui_cluster_security:
176+
177+
Security
178+
~~~~~~~~
179+
180+
The **Security** page provides controls for managing the cluster security settings.
181+
182+
.. image:: _images/tcm_ui_cluster_security.png
183+
:align: left
184+
:width: 700
185+
:alt: TCM cluster security page
186+
187+
Learn more in :ref:`tcm_cluster_security`.
188+
175189
.. _tcm_ui_cluster_migrations:
176190

177191
Migrations
@@ -185,7 +199,6 @@ The **Migrations** page provides centralized migration management tools for the
185199
:alt: TCM cluster migrations page
186200

187201
Learn more in :ref:`tcm_cluster_migrations`.
188-
189202
.. _tcm_ui_cluster_tuples:
190203

191204
Tuples

0 commit comments

Comments
 (0)