Skip to content

Commit f2f6692

Browse files
committed
Add subheadings
1 parent b95236d commit f2f6692

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

doc/reference/tooling/tt_cli/cluster.rst

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _tt-cluster:
22

3-
Managing a cluster's configuration
4-
==================================
3+
Managing cluster configurations
4+
===============================
55

66
.. code-block:: console
77
@@ -48,6 +48,11 @@ A URI must include a prefix that is unique for the application. It can also incl
4848
credentials and other connection parameters. Find the detailed
4949
description of the URI format in :ref:`tt-cluster-uri`.
5050

51+
.. _tt-cluster-publish-instance:
52+
53+
Writing configurations of specific instances
54+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55+
5156
In addition to whole cluster configurations, ``tt cluster publish`` can edit
5257
configurations of specific instances within applications. In this case, the
5358
source file should be a YAML file with a single :ref:`instance configuration section <configuration_overview>`,
@@ -75,6 +80,11 @@ the instance name in the ``name`` argument of the storage URI:
7580
7681
$ tt cluster publish "http://localhost:2379/myapp?name=instance-002" instance.yaml
7782
83+
.. _tt-cluster-publish-validation:
84+
85+
Configuration validation
86+
~~~~~~~~~~~~~~~~~~~~~~~~
87+
7888
``tt cluster publish`` validates the provided configuration against the Tarantool
7989
configuration schema and aborts in case of an error. To skip the validation,
8090
add the ``--force`` option:
@@ -137,6 +147,11 @@ with a prefix identifying the application. For example, to print
137147
138148
$ tt cluster show "http://localhost:2379/myapp"
139149
150+
.. _tt-cluster-show-instance:
151+
152+
Printing configurations of specific instances
153+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154+
140155
``tt cluster show`` can print configurations of specific cluster instances. To
141156
print an instance configuration from a local ``config.yaml``, use the ``application:instance``
142157
argument:
@@ -152,6 +167,11 @@ the instance name in the ``name`` argument of the URI:
152167
153168
$ tt cluster show "http://localhost:2379/myapp?name=instance-002"
154169
170+
.. _tt-cluster-show-validation:
171+
172+
Configuration validation
173+
~~~~~~~~~~~~~~~~~~~~~~~~
174+
155175
To validate a cluster configuration against the Tarantool configuration schema,
156176
add the ``--validate`` option:
157177

0 commit comments

Comments
 (0)