Skip to content

Commit b5c085f

Browse files
committed
Add TCM cluster config
1 parent 6d50929 commit b5c085f

File tree

1 file changed

+113
-3
lines changed

1 file changed

+113
-3
lines changed

doc/reference/tooling/tcm/tcm_cluster_config.rst

Lines changed: 113 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _tcm_connect_clusters:
1+
.. _tcm_configuring_clusters:
22

33
Configuring clusters
44
====================
@@ -7,6 +7,116 @@ Configuring clusters
77
:start-after: ee_note_tcm_start
88
:end-before: ee_note_tcm_end
99

10-
|tcm_full_name| features a built-in editor for Tarantool EE cluster configurations.
10+
|tcm_full_name| features a built-in text editor for Tarantool EE cluster configurations.
11+
12+
When you :ref:`connect a cluster <tcm_connect_cluster>` to |tcm|, it gains access
13+
to the cluster's centralized configuration storage: an etcd or a Tarantool cluster.
14+
|tcm| has both read and write access to the cluster configuration. This enables
15+
the configuration editor to work in two ways:
16+
17+
* If a configuration already exists, the editor shows its current state.
18+
* When you change the configuration in the editor and apply changes, they
19+
are sent to the configuration storage.
20+
21+
To learn how to write Tarantool cluster configurations, see :ref:`configuration`.
22+
23+
.. _tcm_configuring_clusters_manage:
24+
25+
Managing a cluster's configuration
26+
----------------------------------
27+
28+
The configuration editor is available on the **Cluster** > **Configuration** page.
29+
30+
To start managing a cluster's configuration, select this cluster in the **Cluster**
31+
drop-down and go to the **Configuration** page.
32+
33+
.. _tcm_configuring_clusters_add_file:
34+
35+
Adding a configuration file
36+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
37+
38+
A cluster configuration in |tcm| can consist of one or multiple YAML files.
39+
When there are multiple files, they are all considered parts of a single cluster
40+
configuration. You can use this for structuring big cluster configurations.
41+
42+
To add a cluster configuration file, click the plus icon (**+**) below the page title.
43+
44+
The empty configuration file appears in the editor window on the right. Now you
45+
can add content to it.
46+
47+
.. _tcm_configuring_clusters_edit_file:
48+
49+
Editing a configuration file
50+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51+
52+
To edit a cluster configuration file:
53+
54+
#. Select the cluster in the **Cluster** drop-down and go to the **Configuration** page.
55+
56+
#. Select the file to edit in the file list on the left.
57+
It open in the interactive text editor window on the right.
58+
59+
60+
.. _tcm_configuring_clusters_download:
61+
62+
Deleting a configuration file
63+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64+
65+
To delete a cluster configuration file:
66+
67+
#. Select the cluster in the **Cluster** drop-down and go to the **Configuration** page.
68+
69+
#. Select the file to delete in the file list on the left.
70+
71+
#. Click the **Delete** button beside the filename and confirm the deletion.
72+
Now the file is deleted from |tcm|, but the actual configuration that the cluster
73+
uses remains unchanged
74+
75+
#. Click **Apply** to send the changes to the configuration storage.
76+
77+
.. warning::
78+
79+
When you apply changes after deleting a file, the corresponding configuration
80+
part is *actually deleted* from the configuration storage. The can break the
81+
cluster's functioning once its configuration is reloaded.
82+
83+
.. _tcm_configuring_clusters_save:
84+
85+
Saving a configuration draft
86+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87+
88+
89+
you can either save it in |tcm| or
90+
send to the configuration storage and apply to the cluster.
91+
92+
93+
To save a cluster configuration draft after editing, click **Save** in the **Cluster configuration** page.
94+
95+
.. warning::
96+
97+
All unsaved changes are discarded when you leave the **Cluster configuration** page.
98+
99+
If conf
100+
101+
.. _tcm_configuring_clusters_apply:
102+
103+
Applying a configuration
104+
~~~~~~~~~~~~~~~~~~~~~~~~
105+
106+
When you finish editing configuration files and the configuration is ready to use,
107+
apply it to the cluster.
108+
To apply a cluster configuration, click
109+
110+
.. _tcm_configuring_clusters_download:
111+
112+
Downloading a configuration
113+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
114+
115+
To download a cluster configuration file:
116+
117+
#. Select the cluster in the **Cluster** drop-down and go to the **Configuration** page.
118+
119+
#. Select the file to download in the file list on the left.
120+
121+
#. Click the **Download** button beside the filename.
11122

12-
It is synchronized with the

0 commit comments

Comments
 (0)