@@ -23,31 +23,29 @@ There are two ways to add a cluster to |tcm|:
23
23
24
24
.. note ::
25
25
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.
28
28
29
29
.. _tcm_connect_clusters_parameters :
30
30
31
31
Connection parameters
32
32
---------------------
33
33
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:
35
35
for the cluster instances and for the centralized configuration storage.
36
36
37
37
Configuration storage connection
38
38
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39
39
40
40
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
42
42
parameters are required:
43
43
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.
45
45
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 .
51
49
52
50
Additionally, if SSL or TLS encryption is enabled for the configuration storage,
53
51
provide the corresponding encryption configuration: keys, certificates, and other
@@ -85,11 +83,11 @@ follow these steps:
85
83
* Optionally, provide a description and select a color to mark this cluster in |tcm |.
86
84
* Optionally, enter the URLs of cluster instances.
87
85
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:
90
87
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.
93
91
* The credentials for accessing the configuration storage.
94
92
* The SSL/TLS parameters if the connection encryption is enabled on the storage.
95
93
@@ -102,7 +100,15 @@ follow these steps:
102
100
Adding a new cluster
103
101
~~~~~~~~~~~~~~~~~~~~
104
102
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:
106
112
107
113
#. Go to **Clusters** and click **Add**.
108
114
#. 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|:
111
117
* Optionally, provide a description and select a color to mark this cluster in |tcm|.
112
118
* Optionally, enter the URLs of cluster instances.
113
119
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:
118
123
119
124
* The URIs of configuration storage instances.
120
125
* 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|:
126
131
127
132
Once you add the cluster:
128
133
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.
132
137
133
138
.. _tcm_connect_clusters_edit :
134
139
0 commit comments