Skip to content

Commit 1f0af92

Browse files
authored
Add tt 2.5 small features (#4619)
Resolves #4607, #4606, #4566
1 parent b4ac572 commit 1f0af92

File tree

10 files changed

+68
-41
lines changed

10 files changed

+68
-41
lines changed

doc/admin/server_introspection.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,6 @@ To check the instance status, run:
7979
.. code-block:: console
8080
8181
$ tt status my_app
82-
INSTANCE STATUS PID MODE
83-
my_app RUNNING 67172 RW
8482
8583
$ # - OR -
8684

doc/getting_started/getting_started_db.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ Starting an instance
7676
.. code-block:: console
7777
7878
$ tt status create_db
79-
INSTANCE STATUS PID MODE
80-
create_db:instance001 RUNNING 54560 RW
79+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
80+
create_db:instance001 RUNNING 8685 RW ready running --
8181
8282
#. Connect to the instance with :ref:`tt connect <tt-connect>`:
8383

doc/getting_started/getting_started_tcm.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -253,10 +253,10 @@ To deploy a local cluster based on the configuration from etcd:
253253
.. code-block:: console
254254
255255
$ tt status cluster
256-
INSTANCE STATUS PID MODE
257-
cluster:instance-001 RUNNING 2058 RW
258-
cluster:instance-002 RUNNING 2059 RO
259-
cluster:instance-003 RUNNING 2060 RO
256+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
257+
cluster:instance-001 RUNNING 8747 RW ready running --
258+
cluster:instance-002 RUNNING 8748 RO ready running --
259+
cluster:instance-003 RUNNING 8749 RO ready running --
260260
261261
.. _getting_started_tcm_manage:
262262

doc/platform/replication/replication_tutorials/repl_bootstrap.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@ Starting instances
137137
.. code-block:: console
138138
139139
$ tt status manual_leader
140-
INSTANCE STATUS PID MODE
141-
manual_leader:instance001 RUNNING 15272 RW
142-
manual_leader:instance002 RUNNING 15273 RO
140+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
141+
manual_leader:instance001 RUNNING 8841 RW ready running --
142+
manual_leader:instance002 RUNNING 8842 RO ready running --
143143
144144
145145
.. _replication-master_replica_status:
@@ -292,10 +292,10 @@ Starting an instance
292292
.. code-block:: console
293293
294294
$ tt status manual_leader
295-
INSTANCE STATUS PID MODE
296-
manual_leader:instance001 RUNNING 15272 RW
297-
manual_leader:instance002 RUNNING 15273 RO
298-
manual_leader:instance003 RUNNING 15551 RO
295+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
296+
manual_leader:instance001 RUNNING 8841 RW ready running --
297+
manual_leader:instance002 RUNNING 8842 RO ready running --
298+
manual_leader:instance003 RUNNING 8856 RO ready running --
299299
300300
301301
.. _replication-add_instances-reload-config:

doc/platform/replication/replication_tutorials/repl_bootstrap_auto.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,10 @@ Starting instances
135135
.. code-block:: console
136136
137137
$ tt status auto_leader
138-
INSTANCE STATUS PID MODE
139-
auto_leader:instance001 RUNNING 24768 RO
140-
auto_leader:instance002 RUNNING 24769 RW
141-
auto_leader:instance003 RUNNING 24767 RO
138+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
139+
auto_leader:instance001 RUNNING 9170 RO ready running --
140+
auto_leader:instance002 RUNNING 9171 RO ready running --
141+
auto_leader:instance003 RUNNING 9172 RW ready running --
142142
143143
144144

doc/platform/replication/replication_tutorials/repl_bootstrap_master_master.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ Starting instances
141141
.. code-block:: console
142142
143143
$ tt status master_master
144-
INSTANCE STATUS PID MODE
145-
master_master:instance001 RUNNING 30818 RW
146-
master_master:instance002 RUNNING 30819 RW
144+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
145+
master_master:instance001 RUNNING 9263 RW ready running --
146+
master_master:instance002 RUNNING 9264 RW ready running --
147147
148148
149149
.. _replication-master-master-check-status:

doc/tooling/tt_cli/install.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ or ``tt``. The possible values of ``PROGRAM_NAME`` are:
2424
Additionally, ``tt install`` can build open source programs ``tarantool`` and ``tt``
2525
from a specific commit or a pull request on their GitHub repositories.
2626

27-
To uninstall a Tarantool or ``tt`` version, use :doc:`tt uninstall <uninstall>`.
27+
To uninstall a Tarantool or ``tt`` version, use :ref:`tt uninstall <tt-uninstall>`.
2828

2929
Options
3030
-------
@@ -62,8 +62,9 @@ Details
6262
-------
6363

6464
When called without an explicitly specified version, ``tt install`` installs the
65-
latest available version. To check versions available for installation, use
66-
:doc:`tt search <search>`.
65+
latest available version. If the version is specified in the incomplete format ``<MAJOR>.<MINOR>``,
66+
the command installs the latest available patch version in the series.
67+
To check versions available for installation, use :ref:`tt search <tt-search>`.
6768

6869
By default, available versions of Tarantool Community Edition and ``tt`` are taken from their git repositories.
6970
Their installation includes building from sources, which requires some tools and
@@ -144,6 +145,12 @@ Example
144145
145146
$ tt install tarantool
146147
148+
* Install the latest available patch version of Tarantool CE 3.2 release series:
149+
150+
.. code-block:: console
151+
152+
$ tt install tarantool 3.2
153+
147154
* Install Tarantool 2.11.1 from the local repository:
148155

149156
.. code-block:: console
@@ -172,4 +179,4 @@ Example
172179

173180
.. code-block:: console
174181
175-
$ tt install tarantool-dev ~/src/tarantool/build
182+
$ tt install tarantool-dev ~/src/tarantool/build

doc/tooling/tt_cli/start_stop_instance.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,21 +73,20 @@ To check the status of instances, execute :ref:`tt status <tt-status>`:
7373
.. code-block:: console
7474
7575
$ tt status sharded_cluster_crud
76-
INSTANCE STATUS PID MODE
77-
sharded_cluster_crud:storage-a-001 RUNNING 2023 RW
78-
sharded_cluster_crud:storage-a-002 RUNNING 2026 RO
79-
sharded_cluster_crud:storage-b-001 RUNNING 2020 RW
80-
sharded_cluster_crud:storage-b-002 RUNNING 2021 RO
81-
sharded_cluster_crud:router-a-001 RUNNING 2022 RW
76+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
77+
sharded_cluster_crud:router-a-001 RUNNING 8382 RW ready running --
78+
sharded_cluster_crud:storage-a-001 RUNNING 8386 RW ready running --
79+
sharded_cluster_crud:storage-a-002 RUNNING 8390 RO ready running --
80+
sharded_cluster_crud:storage-b-001 RUNNING 8379 RW ready running --
81+
sharded_cluster_crud:storage-b-002 RUNNING 8380 RO ready running --
8282
8383
To check the status of a specific instance, you need to specify its name:
8484

8585
.. code-block:: console
8686
8787
$ tt status sharded_cluster_crud:storage-a-001
88-
INSTANCE STATUS PID MODE
89-
sharded_cluster_crud:storage-a-001 RUNNING 2023 RW
90-
88+
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
89+
sharded_cluster_crud:storage-a-001 RUNNING 8386 RW ready running --
9190
9291
.. _admin-start_stop_instance_connect:
9392

doc/tooling/tt_cli/status.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,18 @@ Checking instance status
55

66
.. code-block:: console
77
8-
$ tt status [APPLICATION[:APP_INSTANCE]] [-p|--pretty]
8+
$ tt status [APPLICATION[:APP_INSTANCE]] [OPTION ...]
99
1010
``tt status`` prints the information about Tarantool applications and instances
1111
in the current environment. This includes:
1212

13-
- Application and instance names
14-
- Instance statuses: running or not
15-
- PIDs
16-
- Instance modes: read-write or read-only
13+
- ``INSTANCE`` -- application and instance names
14+
- ``STATUS`` -- instance status: running, not running, or terminated with an error
15+
- ``PID`` -- process IDs
16+
- ``MODE`` -- instance modes: read-write or read-only
17+
- ``CONFIG`` -- the instances' states in regard to configuration for Tarantool 3.0 or later (see :ref:`config.info() <config_api_reference_info>`)
18+
- ``BOX`` -- the instances' :ref:`box.info() <box_info_info>` statuses
19+
- ``UPSTREAM`` -- the instances' :ref:`box.info.replication[*].upstream <box_info_replication>` statuses
1720

1821
When called without arguments, prints the status of all enabled applications in the current environment.
1922

@@ -41,6 +44,10 @@ Examples
4144
Options
4245
-------
4346

47+
.. option:: -d, --details
48+
49+
Print detailed alerts.
50+
4451
.. option:: -p, --pretty
4552

4653
Print the status as a pretty-formatted table.

doc/tooling/tt_cli/stop.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Stopping a Tarantool instance
88
$ tt stop [APPLICATION[:APP_INSTANCE]]
99
1010
``tt stop`` stops the specified running Tarantool applications or instances.
11-
When called without arguments, stops all running applications in the current environment.
11+
Before stopping the instances, the command prompts the user for confirmation.
12+
13+
When called without arguments, ``tt stop`` stops all running applications in the current environment.
1214

1315
See also: :ref:`tt-start`, :ref:`tt-restart`, :ref:`tt-status`.
1416

@@ -21,9 +23,23 @@ Examples
2123
2224
$ tt stop app
2325
26+
27+
* Stop all instances of the ``app`` application without confirmation:
28+
29+
.. code-block:: console
30+
31+
$ tt stop app -y
32+
2433
* Stop the ``replica`` instance of the ``app`` application:
2534

2635
.. code-block:: console
2736
2837
$ tt stop app:replica
2938
39+
40+
Options
41+
-------
42+
43+
.. option:: -y, --yes
44+
45+
Stop instances without confirmation.

0 commit comments

Comments
 (0)