Skip to content

Commit e4c9021

Browse files
committed
Add TCM cluster config
1 parent b5c085f commit e4c9021

File tree

1 file changed

+22
-63
lines changed

1 file changed

+22
-63
lines changed

doc/reference/tooling/tcm/tcm_cluster_config.rst

Lines changed: 22 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -30,93 +30,52 @@ The configuration editor is available on the **Cluster** > **Configuration** pag
3030
To start managing a cluster's configuration, select this cluster in the **Cluster**
3131
drop-down and go to the **Configuration** page.
3232

33-
.. _tcm_configuring_clusters_add_file:
34-
35-
Adding a configuration file
36-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
37-
3833
A cluster configuration in |tcm| can consist of one or multiple YAML files.
3934
When there are multiple files, they are all considered parts of a single cluster
4035
configuration. You can use this for structuring big cluster configurations.
36+
All cluster configuration files are listed on the left side of the **Cluster configuration** page.
4137

4238
To add a cluster configuration file, click the plus icon (**+**) below the page title.
4339

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:
40+
To edit an existing cluster configuration file, click its name in the list.
6641

67-
#. Select the cluster in the **Cluster** drop-down and go to the **Configuration** page.
42+
To delete a cluster configuration file, click the **Delete** button beside the filename.
6843

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.
44+
To download a cluster configuration file, click the **Download** button beside the filename.
7645

7746
.. warning::
7847

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.
48+
All configuration changes are discarded when you leave the **Cluster configuration** page.
49+
:ref`Save <tcm_configuring_clusters_save>` the configuration if you want to continue
50+
editing it later or :ref:`apply <tcm_configuring_clusters_apply>` it
51+
to start using it on the cluster.
8252

8353
.. _tcm_configuring_clusters_save:
8454

8555
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.
56+
----------------------------
9157

58+
|tcm| can store configurations drafts. If you want to leave an unfinished configuration
59+
and return to it later, save it in |tcm|. Saving applies to whole configurations:
60+
it records the edits of all files, file additions, and file deletions.
9261

9362
To save a cluster configuration draft after editing, click **Save** in the **Cluster configuration** page.
9463

95-
.. warning::
96-
97-
All unsaved changes are discarded when you leave the **Cluster configuration** page.
64+
All unsaved changes are discarded when you leave the **Cluster configuration** page.
9865

99-
If conf
66+
If you have a saved configuration draft, you can reset the changes for each of its
67+
files individually. A reset returns the file into the state that is currently used
68+
by a cluster (that is, saved in the configuration storage). If you reset a newly
69+
added file, it is deleted.
10070

10171
.. _tcm_configuring_clusters_apply:
10272

10373
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.
74+
------------------------
11875

119-
#. Select the file to download in the file list on the left.
76+
When you finish editing a configuration and it's ready to use, apply the updated
77+
configuration to the cluster. To apply a cluster configuration, click **Apply**
78+
on the **Cluster configuration** page. This sends the new configuration to the cluster
79+
configuration storage, and it comes into effect upon the cluster configuration reload.
12080

121-
#. Click the **Download** button beside the filename.
12281

0 commit comments

Comments
 (0)