Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified doc/tooling/tcm/_images/tcm_ui_acl.png
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of the screenshots have white lines on the sides. I think they need to be removed.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/tooling/tcm/_images/tcm_ui_add_ons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_audit_log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_cluster_metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_cluster_migrations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_instance_explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_tcm_metrics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_tuples.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_user_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/tooling/tcm/_images/tcm_ui_users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions doc/tooling/tcm/tcm_access_control/tcm_access_control_rbac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -412,3 +412,24 @@ The following cluster permissions are available in |tcm|:

* - ``cluster.metrics``
- View cluster metrics

* - ``cluster.config.security``
- View and edit settings on the **Security** tab

* - ``cluster.user.read``
- View users and roles of the cluster on the Users tab on the instance page

* - ``cluster.user.write``
- Create, edit, and delete users and roles of the cluster on the **Users** tab on the **Instance page**

* - ``cluster.migrations.read``
- View information about loaded and applied migrations on the **Migrations** tab

* - ``cluster.migrations.write``
- Create, edit, and apply migrations

* - ``cluster.tcf.read``
- View information about TCF clusters and their status on the **TCF** tab

* - ``cluster.tcf.write``
- Modify TCF configuration settings and switch cluster states on the **TCF** tab
5 changes: 3 additions & 2 deletions doc/tooling/tcm/tcm_access_control/tcm_ldap_auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Define the general configuration settings:
* **Automatically add non-existent users**. By default, |tcm| automatically saves
LDAP user information to its :ref:`backend store <tcm_backend_store>`
upon their first login. Turn the toggle off if you don't want to save users from this LDAP server.
If the parameter is disabled, the user must be added manually in TCM on the **Users** tab, and the authentication method must be set to LDAP.

.. _tcm_ldap_auth_config_connect:

Expand All @@ -122,7 +123,7 @@ LDAP queries
To define how |tcm| queries the LDAP server for user authentication and authorization,
fill in the fields of the **Queries** step:

- **Query user** and **Query password**. Credentials of the LDAP user on behalf
- (Optional fields) **Query user** and **Query password**. Credentials of the LDAP user on behalf
of which all LDAP queries are executed: a distinguished name (DN) and a password.
Example DN:

Expand Down Expand Up @@ -163,7 +164,7 @@ fill in the fields of the **Queries** step:

- (Optional) **Template query**. A template for querying the LDAP server for the DN. This
way is used if **Template DN** is not provided.
- **Group query template**. A template for querying groups to which a user belongs
- (Optional) **Group query template**. A template for querying groups to which a user belongs
for authorization purposes. Learn more in :ref:`tcm_ldap_auth_config_permissions`.
Example:

Expand Down
12 changes: 9 additions & 3 deletions doc/tooling/tcm/tcm_audit_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,15 @@ For details, see :ref:`Viewing audit log <tcm_audit_log_view>`.
Enabling audit logging
----------------------

To enable audit logging in |tcm|, go to **Audit settings** and click **Enable**.
You can enable and configure the audit log in two ways:

To additionally send audit log events to the standard output, click **Send to stdout**.
* in the TCM UI
* in the TCM configuration YAML file

To enable audit logging in |tcm| UI, go to **Audit settings** and click **Enable**. To additionally send audit log events to the standard output, click **Send to stdout**.

You can also pre-configure audit logging during the first TCM launch by setting options in the TCM configuration file (tcm.yaml)
through the :ref:`initial-settings.auditlog <tcm_configuration_initial>` parameter.

.. _tcm_audit_log_config:

Expand All @@ -56,7 +62,7 @@ Writing to a file
To write |tcm| audit logs to a file:

1. Go to **Audit settings** and select the **file** protocol.
2. Specify the name of the audit log file. The file appears in the |tcm| working directory.
2. Specify the name of the audit log file. The file will be saved in the directory specified by the user, which can be either absolute or relative. The file appears in the |tcm| working directory.
3. Configure the log files rotation: the maximum file size and age, and the number
of files to store simultaneously.
4. (Optional) Enable compression of audit log files.
Expand Down
3 changes: 0 additions & 3 deletions doc/tooling/tcm/tcm_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,10 @@ The example below shows a fragment of a |tcm| configuration file:

# a fragment of a YAML configuration file
cluster: # top-level group
on-air-limit: 4096
connection-rate-limit: 512
tarantool-timeout: 10s
tarantool-ping-timeout: 5s
http: # top-level group
basic-auth: # nested group
enabled: false
network: tcp
host: 127.0.0.1
port: 8080
Expand Down
Loading