Skip to content

Commit

Permalink
Add TCM security page doc
Browse files Browse the repository at this point in the history
  • Loading branch information
p7nov committed Oct 24, 2024
1 parent 019ecb5 commit 52df78b
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/platform/security/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ types of connections:
* Over a binary port for read and write operations and procedure invocation.

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

In addition, Tarantool provides the following functionality:

Expand Down
1 change: 1 addition & 0 deletions doc/tooling/tcm/tcm_cluster_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ to learn how to perform various management operations on Tarantool clusters from
tcm_cluster_state
tcm_cluster_config
tcm_cluster_users
tcm_cluster_security
tcm_cluster_metrics
tcm_supervised_failover
tcm_cluster_migrations
31 changes: 31 additions & 0 deletions doc/tooling/tcm/tcm_cluster_management/tcm_cluster_security.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _tcm_cluster_security:

Security settings
=================

.. include:: ../index.rst
:start-after: ee_note_tcm_start
:end-before: ee_note_tcm_end

:ref:`configuration_reference_security`

|tcm_full_name| includes a web interface for managing security settings of connected
clusters. It is available on the **Cluster** > **Security** page. On this page,
you can manage the following security features in the cluster:

- *Authentication settings*: protocol (CHAP or PAP), number of retries, and
the delay after a failed authentication attempt (``security.auth_*`` configuration options).
To learn more about authentication settings, see :ref:`configuration_authentication`.
- *Password policy*: minimal password length, mandatory characters, expiration
period, and other settings (``security.password_*`` configuration options).
To learn more about Tarantool password policy, see :ref:`enterprise-password-policy`.
- *Guest access*: whether unauthenticated or :ref:`guest <authentication-passwords>`
users can connect to cluster (``security.disable_guest`` configuration option).
- *Secure erasing*: whether to delete data files so that it cannot be restored.
(:ref:`security.secure_erasing <configuration_reference_security_secure_erasing>` configuration option).
- *Audit log*: configure audit logging in the cluster
(:ref:`audit_log.* <configuration_reference_audit>` configuration options)
To learn how to manage audit logging, see :ref:`enterprise_audit_module`.



9 changes: 8 additions & 1 deletion doc/tooling/tcm/tcm_releases/tcm_1.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,11 @@ on connected clusters. The new page **Migrations** in the **Cluster** page group
provides a text editor where you can write migration scripts in Lua and apply them
to the cluster.

Learn more about migrations in Tarantool :ref:`migrations`.
Learn more about migrations in Tarantool :ref:`migrations`.

.. _tcm_releases_1_2_cluster_security:

Cluster security settings
-------------------------

Learn more in :ref:`tcm_cluster_security`.
15 changes: 8 additions & 7 deletions doc/tooling/tcm/tcm_ui_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,19 +172,20 @@ sent to this centralized storage.

Learn more in :ref:`tcm_configuring_clusters`.

.. _tcm_ui_cluster_migrations:
.. _tcm_ui_cluster_security:

Migrations
~~~~~~~~~~
Security
~~~~~~~~

The **Migrations** page provides centralized migration management tools for the selected cluster.
The **Security** page provides controls for managing the cluster security settings.

.. image:: _images/tcm_ui_cluster_migrations.png
.. image:: _images/tcm_ui_cluster_security.png
:align: left
:width: 700
:alt: TCM cluster migrations page
:alt: TCM cluster security page

Learn more in :ref:`tcm_cluster_security`.

Learn more in :ref:`tcm_cluster_migrations`.

.. _tcm_ui_cluster_tuples:

Expand Down

0 comments on commit 52df78b

Please sign in to comment.