Skip to content

Commit 6d50929

Browse files
committed
Add TCM connecting clusters
1 parent beb0e32 commit 6d50929

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

doc/reference/tooling/tcm/tcm_connect_clusters.rst

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,31 +23,29 @@ There are two ways to add a cluster to |tcm|:
2323

2424
.. note::
2525

26-
In this case, be sure to deploy and start Tarantool on the cluster nodes using
27-
the :ref:`tt-cli` or another suitable way.
26+
In the latter case, you need to deploy Tarantool and start the cluster
27+
instances using the :ref:`tt-cli` or another suitable way.
2828

2929
.. _tcm_connect_clusters_parameters:
3030

3131
Connection parameters
3232
---------------------
3333

34-
When connecting a cluster to |tcm|, you need to provide twp sets of connection parameters:
34+
When connecting a cluster to |tcm|, you need to provide two sets of connection parameters:
3535
for the cluster instances and for the centralized configuration storage.
3636

3737
Configuration storage connection
3838
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3939

4040
The cluster configuration can be stored in either an :ref:`etcd <configuration_etcd>`
41-
cluster or separate Tarantool-based storage. In both cases, the following connection
41+
cluster or a separate Tarantool-based storage. In both cases, the following connection
4242
parameters are required:
4343

44-
* **Prefix**. A key prefix used to identify the cluster in the configuration storage.
44+
* A key prefix used to identify the cluster in the configuration storage.
4545
A prefix must be unique for each cluster in storage.
46-
* **Endpoints**. URIs of all instances of the configuration storage (an etcd cluster
47-
or a Tarantool cluster).
48-
* **Username** and **Password**. The credentials for accessing the configuration
49-
storage: an `etcd user <https://etcd.io/docs/v3.5/op-guide/authentication/rbac/>`__
50-
or a :ref:`Tarantool user <authentication>`.
46+
* URIs of all instances of the configuration storage.
47+
* The credentials for accessing the configuration storage: an `etcd user <https://etcd.io/docs/v3.5/op-guide/authentication/rbac/>`__
48+
or a :ref:`Tarantool user <authentication>` and .
5149

5250
Additionally, if SSL or TLS encryption is enabled for the configuration storage,
5351
provide the corresponding encryption configuration: keys, certificates, and other
@@ -85,11 +83,11 @@ follow these steps:
8583
* Optionally, provide a description and select a color to mark this cluster in |tcm|.
8684
* Optionally, enter the URLs of cluster instances.
8785

88-
#. Provide the details of the cluster configuration storage: etcd or a Tarantool-based
89-
storage:
86+
#. Provide the details of the cluster configuration storage:
9087

91-
* The prefix specified in the cluster configuration.
92-
* The URIs of configuration storage instances.
88+
* Storage type: **etcd** or **tarantool**.
89+
* The **Prefix** specified in the cluster configuration.
90+
* The URIs of the configuration storage instances.
9391
* The credentials for accessing the configuration storage.
9492
* The SSL/TLS parameters if the connection encryption is enabled on the storage.
9593

@@ -102,7 +100,15 @@ follow these steps:
102100
Adding a new cluster
103101
~~~~~~~~~~~~~~~~~~~~
104102

105-
If you don't have a cluster yet, you can start from adding it to |tcm|:
103+
If you don't have a cluster yet, you can add one in |tcm| and write its configuration
104+
from scratch using the :ref:`built-in configuration editor <tcm_configuring_clusters>.
105+
106+
.. important::
107+
108+
When adding a new cluster, you need to have a storage for its configuration up
109+
and running so that |tcm| can connect to it. Cluster instances can be deployed later.
110+
111+
To add a new cluster:
106112

107113
#. Go to **Clusters** and click **Add**.
108114
#. Fill in the general cluster information:
@@ -111,10 +117,9 @@ If you don't have a cluster yet, you can start from adding it to |tcm|:
111117
* Optionally, provide a description and select a color to mark this cluster in |tcm|.
112118
* Optionally, enter the URLs of cluster instances.
113119

114-
#. Define a unique prefix for identifying this cluster in the configuration storage.
115-
116-
#. Provide the connection details for the cluster configuration storage: etcd or a Tarantool-based
117-
storage.
120+
#. Select the type of the cluster configuration storage: **etcd** or **tarantool**.
121+
#. Define a unique **Prefix** for identifying this cluster in the configuration storage.
122+
#. Provide the connection details for the cluster configuration storage:
118123

119124
* The URIs of configuration storage instances.
120125
* The credentials for accessing the configuration storage.
@@ -126,9 +131,9 @@ If you don't have a cluster yet, you can start from adding it to |tcm|:
126131

127132
Once you add the cluster:
128133

129-
* set up the cluster configuration using the |tcm| :ref:`configuration editor <tcm_cluster_config>`
130-
* deploy Tarantool on the cluster nodes using the :ref:`tt-cli` or other suitable tools
131-
* start the cluster instances
134+
* Set up the cluster configuration using the |tcm| :ref:`configuration editor <tcm_cluster_config>`.
135+
* Deploy Tarantool on the cluster nodes using the :ref:`tt-cli` or other suitable tools.
136+
* Start the cluster using the :ref:`tt-cli` or other suitable tools.
132137

133138
.. _tcm_connect_clusters_edit:
134139

0 commit comments

Comments
 (0)