From 7c5d693d1c07d854c9649bf1b09bdbf804b74447 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 12 Aug 2024 11:50:30 +0700 Subject: [PATCH 01/10] TCM: cluster users and roles --- doc/tooling/tcm/index.rst | 4 +- .../tcm/tcm_cluster_management/index.rst | 16 ++++++++ .../tcm_cluster_config.rst | 0 .../tcm_cluster_metrics.rst | 0 .../tcm_cluster_state.rst} | 28 +++++++------- .../tcm_cluster_users.rst | 37 +++++++++++++++++++ doc/tooling/tcm/tcm_releases/tcm_1.0.rst | 2 +- doc/tooling/tcm/tcm_ui_overview.rst | 2 +- 8 files changed, 70 insertions(+), 19 deletions(-) create mode 100644 doc/tooling/tcm/tcm_cluster_management/index.rst rename doc/tooling/tcm/{ => tcm_cluster_management}/tcm_cluster_config.rst (100%) rename doc/tooling/tcm/{ => tcm_cluster_management}/tcm_cluster_metrics.rst (100%) rename doc/tooling/tcm/{tcm_cluster_monitoring.rst => tcm_cluster_management/tcm_cluster_state.rst} (86%) create mode 100644 doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst diff --git a/doc/tooling/tcm/index.rst b/doc/tooling/tcm/index.rst index 46a29a5996..d7584c352f 100644 --- a/doc/tooling/tcm/index.rst +++ b/doc/tooling/tcm/index.rst @@ -38,9 +38,7 @@ to read data. LDAP authorization is supported as well. tcm_ui_overview tcm_connect_clusters - tcm_cluster_config - tcm_cluster_monitoring - tcm_cluster_metrics + tcm_cluster_management/index tcm_cluster_data_access tcm_access_control tcm_audit_log diff --git a/doc/tooling/tcm/tcm_cluster_management/index.rst b/doc/tooling/tcm/tcm_cluster_management/index.rst new file mode 100644 index 0000000000..9a4bdb8e81 --- /dev/null +++ b/doc/tooling/tcm/tcm_cluster_management/index.rst @@ -0,0 +1,16 @@ +.. _tcm_cluster_management: + +Cluster management +================== + +.. include:: ../index.rst + :start-after: ee_note_tcm_start + :end-before: ee_note_tcm_end + +.. toctree:: + :maxdepth: 1 + + tcm_cluster_config + tcm_cluster_state + tcm_cluster_users + tcm_cluster_metrics \ No newline at end of file diff --git a/doc/tooling/tcm/tcm_cluster_config.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_config.rst similarity index 100% rename from doc/tooling/tcm/tcm_cluster_config.rst rename to doc/tooling/tcm/tcm_cluster_management/tcm_cluster_config.rst diff --git a/doc/tooling/tcm/tcm_cluster_metrics.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_metrics.rst similarity index 100% rename from doc/tooling/tcm/tcm_cluster_metrics.rst rename to doc/tooling/tcm/tcm_cluster_management/tcm_cluster_metrics.rst diff --git a/doc/tooling/tcm/tcm_cluster_monitoring.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_state.rst similarity index 86% rename from doc/tooling/tcm/tcm_cluster_monitoring.rst rename to doc/tooling/tcm/tcm_cluster_management/tcm_cluster_state.rst index 43fbab2ad7..29428beb34 100644 --- a/doc/tooling/tcm/tcm_cluster_monitoring.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_state.rst @@ -1,9 +1,9 @@ -.. _tcm_cluster_monitoring: +.. _tcm_cluster_state: -Cluster monitoring -================== +Viewing cluster state +===================== -|tcm_full_name| provides means for monitoring various aspects of connected clusters, +|tcm_full_name| provides a visual interface for checking various aspects of connected clusters, such as: * topology @@ -12,9 +12,9 @@ such as: * data distribution * Tarantool versions -Cluster monitoring tools are available on the **Cluster** > **Stateboard** page. +Cluster state information is available on the **Cluster** > **Stateboard** page. -.. _tcm_cluster_monitoring_topology: +.. _tcm_cluster_state_topology: Cluster topology ---------------- @@ -22,7 +22,7 @@ Cluster topology The cluster topology is displayed on the **Stateboard** page in one of two forms: a list or a graph. -.. _tcm_cluster_monitoring_topology_list: +.. _tcm_cluster_state_topology_list: List view ~~~~~~~~~ @@ -37,7 +37,7 @@ to filter the instances with the selected versions and states. To switch to the list view, click the list button on the right of the search bar on the **Stateboard** page. -.. _tcm_cluster_monitoring_topology_graph: +.. _tcm_cluster_state_topology_graph: Graph view ~~~~~~~~~~ @@ -49,7 +49,7 @@ which is helpful for larger clusters. To switch to the graph view, click the graph button on the right of the search bar on the **Stateboard** page. -.. _tcm_cluster_monitoring_topology_group: +.. _tcm_cluster_state_topology_group: Instance grouping ~~~~~~~~~~~~~~~~~ @@ -66,7 +66,7 @@ you see if issues happen in a specific data center or server. To change the instance grouping, click **Group by** in the **Actions** menu on the **Stateboard** page. Then add or remove grouping criteria. -.. _tcm_cluster_monitoring_topology_filters: +.. _tcm_cluster_state_topology_filters: Filtering ~~~~~~~~~ @@ -81,7 +81,7 @@ at the top. It has predefined filters that select: To display all instances, delete the filter applied in the search bar. -.. _tcm_cluster_monitoring_instance_details: +.. _tcm_cluster_state_instance_details: Instance details ---------------- @@ -104,10 +104,10 @@ find: Additionally, on the instance details page there is a terminal in which you can execute arbitrary Lua code on the instance. -.. _tcm_cluster_monitoring_urls: +.. _tcm_cluster_state_urls: -Additional monitoring services ------------------------------- +Linked external services +------------------------ When you :ref:`connect a cluster ` to |tcm|, you can specify URLs of external services linked to this cluster. For example, this can be a Grafana diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst new file mode 100644 index 0000000000..70fcf9d1c3 --- /dev/null +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -0,0 +1,37 @@ +.. _tcm_cluster_users: + +Cluster users and roles +======================= + + +Managing cluster users and roles +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +TODO: check the location + +.. important:: + + This creates Tarantool users and roles (link)on a connected cluster / or replicaset? + To learn about TCM users, refer to :ref:`tcm_access_control`. + +You can manage Tarantool users and roles on a connected cluster from the Users tab of +the instance page. + +only on read-write (leader) instances + +To create a user: + +#. click Add in the Users section. +#. Enter a username and a password in the dialog and click Add. +#. Click the lock icon against the username in the table to open user privileges dialog. +#. Add privileges + + +.. note + + a user on whose behalf tcm connect to the cluster must have the privileges to + grant privileges to users + + +To create a role: + diff --git a/doc/tooling/tcm/tcm_releases/tcm_1.0.rst b/doc/tooling/tcm/tcm_releases/tcm_1.0.rst index da291f0be6..fbc1ec86ad 100644 --- a/doc/tooling/tcm/tcm_releases/tcm_1.0.rst +++ b/doc/tooling/tcm/tcm_releases/tcm_1.0.rst @@ -39,7 +39,7 @@ the selected cluster: From the stateboard, you can navigate to specific instances to view their details or connect to their interactive consoles. -To learn more, see :ref:`tcm_cluster_monitoring`. +To learn more, see :ref:`tcm_cluster_state`. .. _tcm_releases_1_0_config: diff --git a/doc/tooling/tcm/tcm_ui_overview.rst b/doc/tooling/tcm/tcm_ui_overview.rst index f154a975ec..0e9753301d 100644 --- a/doc/tooling/tcm/tcm_ui_overview.rst +++ b/doc/tooling/tcm/tcm_ui_overview.rst @@ -124,7 +124,7 @@ On this page, you can: by clicking instance names in the cluster topology list - start and stop instances (in the development mode). -Learn more about using the cluster stateboard in :ref:`tcm_cluster_monitoring`. +Learn more about using the cluster stateboard in :ref:`tcm_cluster_state`. .. _tcm_ui_instance: From 7c7cb379b92337f7cbe0e53ac08993b94fa23537 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 12 Aug 2024 12:45:36 +0700 Subject: [PATCH 02/10] TCM: cluster users and roles --- .../tcm_cluster_config.rst | 2 +- .../tcm_cluster_metrics.rst | 2 +- .../tcm_cluster_state.rst | 4 ++ .../tcm_cluster_users.rst | 72 ++++++++++++++----- doc/tooling/tcm/tcm_releases/tcm_1.2.rst | 2 +- doc/tooling/tcm/tcm_ui_overview.rst | 3 +- 6 files changed, 63 insertions(+), 22 deletions(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_config.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_config.rst index 15a18a1565..3b866d0224 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_config.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_config.rst @@ -3,7 +3,7 @@ Configuring clusters ==================== -.. include:: index.rst +.. include:: ../index.rst :start-after: ee_note_tcm_start :end-before: ee_note_tcm_end diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_metrics.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_metrics.rst index af7b5264c9..77e80c0d03 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_metrics.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_metrics.rst @@ -3,7 +3,7 @@ Viewing cluster metrics ======================= -.. include:: index.rst +.. include:: ../index.rst :start-after: ee_note_tcm_start :end-before: ee_note_tcm_end diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_state.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_state.rst index 29428beb34..3d04a689a3 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_state.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_state.rst @@ -3,6 +3,10 @@ Viewing cluster state ===================== +.. include:: ../index.rst + :start-after: ee_note_tcm_start + :end-before: ee_note_tcm_end + |tcm_full_name| provides a visual interface for checking various aspects of connected clusters, such as: diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index 70fcf9d1c3..f916f026c1 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -1,37 +1,73 @@ .. _tcm_cluster_users: -Cluster users and roles -======================= +Managing cluster users and roles +================================ +.. include:: ../index.rst + :start-after: ee_note_tcm_start + :end-before: ee_note_tcm_end -Managing cluster users and roles -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +|tcm_full_name| provides a visual interface for managing Tarantool users and roles +on connected clusters. The tools for managing cluster users and roles are located on +the **Users** tab of the :ref:`instance page `. + +.. note:: + + This page describes management of *Tarantool* :ref:`users and roles ` + on instances of connected clusters. To learn about *|tcm|* users, see :ref:`tcm_access_control`. + +The :ref:`Tarantool access model ` defines user access to entities +inside a single instance. Thus, to create or alter a user on a cluster, you need to +do this on all cluster instances. -TODO: check the location +In replication clusters, changes in access model are possible only on read-write instances +(replica set leaders). All changes made on a leader instance are propagated to all +instances of the same replica set automatically. + +To make the operations on cluster access model possible, make sure that the user +that |tcm| uses to connect to the cluster has the privileges to manage users and roles. .. important:: - This creates Tarantool users and roles (link)on a connected cluster / or replicaset? - To learn about TCM users, refer to :ref:`tcm_access_control`. + To ensure the access consistency across the cluster, repeat all operations on + all read-write instances of the cluster. + +You can also manage Tarantool users and roles from |tcm| using the Lua API +as described in :ref:`access_control`. To do this, connect to instance consoles +from the **Terminal** tab of the instance page. -You can manage Tarantool users and roles on a connected cluster from the Users tab of -the instance page. +.. _tcm_cluster_users_users: -only on read-write (leader) instances +Managing cluster users +---------------------- -To create a user: +To create a user on a cluster: -#. click Add in the Users section. -#. Enter a username and a password in the dialog and click Add. +#. Go to **Stateboard**. +#. Find a replica set leader in the instances list and click it to open the instance page. +#. Go to the **Users** tab and click **Add user**. +#. Enter a username and a password and click **Add**. #. Click the lock icon against the username in the table to open user privileges dialog. -#. Add privileges +#. Add required privileges to the user. +#. Repeat all previous steps on all read-write instances in the cluster. + +To edit or delete a user, or alter their privileges, click the corresponding button in the users table. + +.. _tcm_cluster_users_roles: -.. note +Managing cluster roles +---------------------- - a user on whose behalf tcm connect to the cluster must have the privileges to - grant privileges to users +To create a role on a cluster: +#. Go to **Stateboard**. +#. Find a replica set leader in the instances list and click it to open the instance page. +#. Go to the **Users** tab and click **Add role**. +#. Enter a role name and a password and click **Add**. +#. Click the lock icon against the role name in the table to open role privileges dialog. +#. Add required privileges to the role. +#. Repeat all previous steps on all read-write instances in the cluster. -To create a role: +To edit or delete a role, click the corresponding button in the roles table. diff --git a/doc/tooling/tcm/tcm_releases/tcm_1.2.rst b/doc/tooling/tcm/tcm_releases/tcm_1.2.rst index ee546d463c..286e13dc0f 100644 --- a/doc/tooling/tcm/tcm_releases/tcm_1.2.rst +++ b/doc/tooling/tcm/tcm_releases/tcm_1.2.rst @@ -24,7 +24,7 @@ cluster through the |tcm| web interface. The tools for managing Tarantool users on a cluster instance are located on the **Users** tab of the instance page. -Learn more about Tarantool access model in :ref:`access_control`. +Learn more about managing Tarantool users from |tcm| in :ref:`tcm_cluster_users`. .. _tcm_releases_1_2_migrations: diff --git a/doc/tooling/tcm/tcm_ui_overview.rst b/doc/tooling/tcm/tcm_ui_overview.rst index 0e9753301d..2647e5133a 100644 --- a/doc/tooling/tcm/tcm_ui_overview.rst +++ b/doc/tooling/tcm/tcm_ui_overview.rst @@ -144,7 +144,8 @@ It provides a set of tabs for performing actions on the selected Tarantool insta or as a console output of ``box.cfg``, ``box.info``, and other built-in functions - **SQL** and **Terminal** tabs: run SQL and Lua commands on the instance - **Logs** tab: view instance logs -- **Slab stats** tab: view :ref:`slab allocator ` statistics +- **Slabs** tab: view :ref:`slab allocator ` statistics +- **Users** tab: manage Tarantool :ref:`users and roles ` on the instance - **Funcs**: manage and call stored functions - **Metrics**: view instance metrics From dbb8d21590b1567702b78ffee305fa407d07273f Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 12 Aug 2024 13:03:54 +0700 Subject: [PATCH 03/10] TCM: cluster users and roles --- .../tcm/tcm_cluster_management/index.rst | 6 ++++- .../tcm_cluster_users.rst | 22 +++++++++---------- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/index.rst b/doc/tooling/tcm/tcm_cluster_management/index.rst index 9a4bdb8e81..76fa994324 100644 --- a/doc/tooling/tcm/tcm_cluster_management/index.rst +++ b/doc/tooling/tcm/tcm_cluster_management/index.rst @@ -7,10 +7,14 @@ Cluster management :start-after: ee_note_tcm_start :end-before: ee_note_tcm_end +The main goal of |tcm_full_name| is to provide visual tools for managing +various aspects of Tarantool clusters from the browser. See the pages of this section +to learn to perform various management operations on Tarantool clusters from |tcm|. + .. toctree:: :maxdepth: 1 - tcm_cluster_config tcm_cluster_state + tcm_cluster_config tcm_cluster_users tcm_cluster_metrics \ No newline at end of file diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index f916f026c1..89eba922b1 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -13,24 +13,22 @@ the **Users** tab of the :ref:`instance page `. .. note:: - This page describes management of *Tarantool* :ref:`users and roles ` - on instances of connected clusters. To learn about *|tcm|* users, see :ref:`tcm_access_control`. + This page describes management of :ref:`Tarantool users and roles ` + on instances of connected clusters. To learn about TCM users, see :ref:`tcm_access_control`. The :ref:`Tarantool access model ` defines user access to entities inside a single instance. Thus, to create or alter a user on a cluster, you need to -do this on all cluster instances. - -In replication clusters, changes in access model are possible only on read-write instances -(replica set leaders). All changes made on a leader instance are propagated to all -instances of the same replica set automatically. - -To make the operations on cluster access model possible, make sure that the user -that |tcm| uses to connect to the cluster has the privileges to manage users and roles. +do this on all cluster instances. In replication clusters, changes in access model +are possible only on read-write instances (replica set leaders). Changes made on +a leader instance are propagated to all instances of the same replica set automatically. .. important:: - To ensure the access consistency across the cluster, repeat all operations on - all read-write instances of the cluster. + To ensure the access model consistency across the cluster, repeat all user + management operations on all read-write instances of the cluster. + +Operations on cluster access model are possible only if the user that |tcm| uses +to connect to the cluster has the privileges to manage users and roles. You can also manage Tarantool users and roles from |tcm| using the Lua API as described in :ref:`access_control`. To do this, connect to instance consoles From 38d5d608377dbdd6158327997475177bfba78be5 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 12 Aug 2024 14:29:48 +0700 Subject: [PATCH 04/10] TCM: cluster users and roles --- .../tcm_cluster_users.rst | 48 ++++++++++++------- 1 file changed, 31 insertions(+), 17 deletions(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index 89eba922b1..1f4a24707c 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -8,8 +8,7 @@ Managing cluster users and roles :end-before: ee_note_tcm_end |tcm_full_name| provides a visual interface for managing Tarantool users and roles -on connected clusters. The tools for managing cluster users and roles are located on -the **Users** tab of the :ref:`instance page `. +on connected clusters. .. note:: @@ -22,11 +21,6 @@ do this on all cluster instances. In replication clusters, changes in access mod are possible only on read-write instances (replica set leaders). Changes made on a leader instance are propagated to all instances of the same replica set automatically. -.. important:: - - To ensure the access model consistency across the cluster, repeat all user - management operations on all read-write instances of the cluster. - Operations on cluster access model are possible only if the user that |tcm| uses to connect to the cluster has the privileges to manage users and roles. @@ -39,33 +33,53 @@ from the **Terminal** tab of the instance page. Managing cluster users ---------------------- +The tools for managing cluster users are located on the **Users** tab +of the :ref:`instance page `. + +.. important:: + + To ensure the access model consistency across the cluster, repeat all user + management operations on all read-write instances of the cluster. + To create a user on a cluster: #. Go to **Stateboard**. #. Find a replica set leader in the instances list and click it to open the instance page. #. Go to the **Users** tab and click **Add user**. -#. Enter a username and a password and click **Add**. -#. Click the lock icon against the username in the table to open user privileges dialog. -#. Add required privileges to the user. -#. Repeat all previous steps on all read-write instances in the cluster. -To edit or delete a user, or alter their privileges, click the corresponding button in the users table. +To edit or delete a user, click the corresponding button in the **Users** table. + +To edit a user's privileges: +#. Click the lock icon against the username in the **Users** table. +#. In the privileges dialog: + - Click **Add** to grant privileges + - Click the trash bin icon to revoke a privilege .. _tcm_cluster_users_roles: Managing cluster roles ---------------------- +The tools for managing cluster roles are located on the **Users** tab +of the :ref:`instance page `. + +.. important:: + + To ensure the access model consistency across the cluster, repeat all role + management operations on all read-write instances of the cluster. + To create a role on a cluster: #. Go to **Stateboard**. #. Find a replica set leader in the instances list and click it to open the instance page. #. Go to the **Users** tab and click **Add role**. -#. Enter a role name and a password and click **Add**. -#. Click the lock icon against the role name in the table to open role privileges dialog. -#. Add required privileges to the role. -#. Repeat all previous steps on all read-write instances in the cluster. -To edit or delete a role, click the corresponding button in the roles table. +To delete a role, click the trash bin icon in the **Roles** table. + +To edit a roles's privileges: +#. Click the lock icon against the role name in the **Roles** table. +#. In the privileges dialog: + - Click **Add** to grant privileges + - Click the trash bin icon to revoke a privilege From 507a9892b0a64c8092e736ccca6c17a931b1e209 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 12 Aug 2024 14:37:37 +0700 Subject: [PATCH 05/10] fix --- .../tcm/tcm_cluster_management/tcm_cluster_users.rst | 10 +++++----- doc/tooling/tcm/tcm_connect_clusters.rst | 4 ++++ 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index 1f4a24707c..b2e09a7372 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -13,16 +13,16 @@ on connected clusters. .. note:: This page describes management of :ref:`Tarantool users and roles ` - on instances of connected clusters. To learn about TCM users, see :ref:`tcm_access_control`. + on instances of connected clusters. To learn to manage |tcm| users, see :ref:`tcm_access_control`. The :ref:`Tarantool access model ` defines user access to entities -inside a single instance. Thus, to create or alter a user on a cluster, you need to +inside a single instance. Thus, to create or alter a cluster-wide user or role, you need to do this on all cluster instances. In replication clusters, changes in access model are possible only on read-write instances (replica set leaders). Changes made on -a leader instance are propagated to all instances of the same replica set automatically. +a leader instance are propagated to all instances of its replica set automatically. -Operations on cluster access model are possible only if the user that |tcm| uses -to connect to the cluster has the privileges to manage users and roles. +Operations on cluster access model are possible only if the :ref:`user ` +that |tcm| uses to connect to the cluster has the privileges to manage users and roles. You can also manage Tarantool users and roles from |tcm| using the Lua API as described in :ref:`access_control`. To do this, connect to instance consoles diff --git a/doc/tooling/tcm/tcm_connect_clusters.rst b/doc/tooling/tcm/tcm_connect_clusters.rst index b6568b394d..fa54d69d0f 100644 --- a/doc/tooling/tcm/tcm_connect_clusters.rst +++ b/doc/tooling/tcm/tcm_connect_clusters.rst @@ -32,6 +32,8 @@ Connection parameters When connecting a cluster to |tcm|, you need to provide two sets of connection parameters: for the cluster instances and for the centralized configuration storage. +.. _tcm_connect_clusters_parameters_storage: + Configuration storage connection ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -50,6 +52,8 @@ provide the corresponding encryption configuration: keys, certificates, and othe parameters. For the complete list of parameters, consult the `etcd documentation `__ or Tarantool :ref:`enterprise-iproto-encryption`. +.. _tcm_connect_clusters_parameters_tarantool: + Cluster connection ~~~~~~~~~~~~~~~~~~ From 72823633c379f6f980a4bfd6943f737c5eb3d8e0 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 12 Aug 2024 14:46:46 +0700 Subject: [PATCH 06/10] fix --- doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index b2e09a7372..5fff72b50d 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -53,6 +53,7 @@ To edit a user's privileges: #. Click the lock icon against the username in the **Users** table. #. In the privileges dialog: + - Click **Add** to grant privileges - Click the trash bin icon to revoke a privilege @@ -81,5 +82,6 @@ To edit a roles's privileges: #. Click the lock icon against the role name in the **Roles** table. #. In the privileges dialog: + - Click **Add** to grant privileges - Click the trash bin icon to revoke a privilege From 56291f4c43eb65c723b7a7901516980a83ed192d Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 12 Aug 2024 14:49:02 +0700 Subject: [PATCH 07/10] fix --- doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index 5fff72b50d..20a910b3b4 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -78,7 +78,7 @@ To create a role on a cluster: To delete a role, click the trash bin icon in the **Roles** table. -To edit a roles's privileges: +To edit a role's privileges: #. Click the lock icon against the role name in the **Roles** table. #. In the privileges dialog: From a5e0dbc66d51ee0d1d14abd4757997ca02253cb7 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 13 Aug 2024 10:57:37 +0700 Subject: [PATCH 08/10] Apply suggestions from code review Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com> --- doc/tooling/tcm/tcm_cluster_management/index.rst | 2 +- .../tcm/tcm_cluster_management/tcm_cluster_users.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/index.rst b/doc/tooling/tcm/tcm_cluster_management/index.rst index 76fa994324..99065b9dcd 100644 --- a/doc/tooling/tcm/tcm_cluster_management/index.rst +++ b/doc/tooling/tcm/tcm_cluster_management/index.rst @@ -9,7 +9,7 @@ Cluster management The main goal of |tcm_full_name| is to provide visual tools for managing various aspects of Tarantool clusters from the browser. See the pages of this section -to learn to perform various management operations on Tarantool clusters from |tcm|. +to learn how to perform various management operations on Tarantool clusters from |tcm|. .. toctree:: :maxdepth: 1 diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index 20a910b3b4..62ab7aa0af 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -21,7 +21,7 @@ do this on all cluster instances. In replication clusters, changes in access mod are possible only on read-write instances (replica set leaders). Changes made on a leader instance are propagated to all instances of its replica set automatically. -Operations on cluster access model are possible only if the :ref:`user ` +Operations on the cluster access model are possible only if the :ref:`user ` that |tcm| uses to connect to the cluster has the privileges to manage users and roles. You can also manage Tarantool users and roles from |tcm| using the Lua API @@ -47,7 +47,7 @@ To create a user on a cluster: #. Find a replica set leader in the instances list and click it to open the instance page. #. Go to the **Users** tab and click **Add user**. -To edit or delete a user, click the corresponding button in the **Users** table. +To edit or delete a user, click the **Edit** or **Delete** button in the **Users** table. To edit a user's privileges: @@ -55,7 +55,7 @@ To edit a user's privileges: #. In the privileges dialog: - Click **Add** to grant privileges - - Click the trash bin icon to revoke a privilege + - Click the **Revoke** button (the trash bin icon) to revoke a privilege .. _tcm_cluster_users_roles: From 32bb1e3b8addf4d1e2f4c02d41c055055244df5c Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 13 Aug 2024 11:11:25 +0700 Subject: [PATCH 09/10] fix --- doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index 62ab7aa0af..1b7c73f66c 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -47,7 +47,8 @@ To create a user on a cluster: #. Find a replica set leader in the instances list and click it to open the instance page. #. Go to the **Users** tab and click **Add user**. -To edit or delete a user, click the **Edit** or **Delete** button in the **Users** table. +To edit or delete a user, click the **Edit** or **Delete** button against the username +in the **Users** table. To edit a user's privileges: @@ -76,7 +77,7 @@ To create a role on a cluster: #. Find a replica set leader in the instances list and click it to open the instance page. #. Go to the **Users** tab and click **Add role**. -To delete a role, click the trash bin icon in the **Roles** table. +To delete a role, click the **Delete** button against the role name in the **Roles** table. To edit a role's privileges: From bab0d3a408458cb455ada066f3279e470245b988 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Tue, 13 Aug 2024 11:12:16 +0700 Subject: [PATCH 10/10] fix --- doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst index 1b7c73f66c..be8d48e0b7 100644 --- a/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst +++ b/doc/tooling/tcm/tcm_cluster_management/tcm_cluster_users.rst @@ -56,7 +56,7 @@ To edit a user's privileges: #. In the privileges dialog: - Click **Add** to grant privileges - - Click the **Revoke** button (the trash bin icon) to revoke a privilege + - Click **Revoke** (the trash bin icon) to revoke a privilege .. _tcm_cluster_users_roles: @@ -85,4 +85,4 @@ To edit a role's privileges: #. In the privileges dialog: - Click **Add** to grant privileges - - Click the trash bin icon to revoke a privilege + - Click **Revoke** (the trash bin icon) to revoke a privilege