Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tt 2.5 small features #4619

Merged
merged 3 commits into from
Nov 11, 2024
Merged

Add tt 2.5 small features #4619

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
378e95f
Add tt 2.5 features: stop confirmation, extended status, incomplete i…
p7nov Nov 2, 2024
6cc3996
Replace :doc: link with :ref:
p7nov Nov 5, 2024
ab00c0a
Fix indent
p7nov Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions doc/admin/server_introspection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@ To check the instance status, run:
.. code-block:: console

$ tt status my_app
INSTANCE STATUS PID MODE
my_app RUNNING 67172 RW

$ # - OR -

Expand Down
4 changes: 2 additions & 2 deletions doc/getting_started/getting_started_db.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ Starting an instance
.. code-block:: console

$ tt status create_db
INSTANCE STATUS PID MODE
create_db:instance001 RUNNING 54560 RW
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
create_db:instance001 RUNNING 8685 RW ready running --

#. Connect to the instance with :ref:`tt connect <tt-connect>`:

Expand Down
8 changes: 4 additions & 4 deletions doc/getting_started/getting_started_tcm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,10 +253,10 @@ To deploy a local cluster based on the configuration from etcd:
.. code-block:: console

$ tt status cluster
INSTANCE STATUS PID MODE
cluster:instance-001 RUNNING 2058 RW
cluster:instance-002 RUNNING 2059 RO
cluster:instance-003 RUNNING 2060 RO
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
cluster:instance-001 RUNNING 8747 RW ready running --
cluster:instance-002 RUNNING 8748 RO ready running --
cluster:instance-003 RUNNING 8749 RO ready running --
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit strange that not all columns are aligned here.


.. _getting_started_tcm_manage:

Expand Down
14 changes: 7 additions & 7 deletions doc/platform/replication/replication_tutorials/repl_bootstrap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,9 @@ Starting instances
.. code-block:: console

$ tt status manual_leader
INSTANCE STATUS PID MODE
manual_leader:instance001 RUNNING 15272 RW
manual_leader:instance002 RUNNING 15273 RO
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
manual_leader:instance001 RUNNING 8841 RW ready running --
manual_leader:instance002 RUNNING 8842 RO ready running --


.. _replication-master_replica_status:
Expand Down Expand Up @@ -292,10 +292,10 @@ Starting an instance
.. code-block:: console

$ tt status manual_leader
INSTANCE STATUS PID MODE
manual_leader:instance001 RUNNING 15272 RW
manual_leader:instance002 RUNNING 15273 RO
manual_leader:instance003 RUNNING 15551 RO
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
manual_leader:instance001 RUNNING 8841 RW ready running --
manual_leader:instance002 RUNNING 8842 RO ready running --
manual_leader:instance003 RUNNING 8856 RO ready running --


.. _replication-add_instances-reload-config:
Expand Down
8 changes: 4 additions & 4 deletions doc/platform/replication/replication_tutorials/repl_bootstrap_auto.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,10 @@ Starting instances
.. code-block:: console

$ tt status auto_leader
INSTANCE STATUS PID MODE
auto_leader:instance001 RUNNING 24768 RO
auto_leader:instance002 RUNNING 24769 RW
auto_leader:instance003 RUNNING 24767 RO
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
auto_leader:instance001 RUNNING 9170 RO ready running --
auto_leader:instance002 RUNNING 9171 RO ready running --
auto_leader:instance003 RUNNING 9172 RW ready running --



Expand Down
6 changes: 3 additions & 3 deletions doc/platform/replication/replication_tutorials/repl_bootstrap_master_master.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ Starting instances
.. code-block:: console

$ tt status master_master
INSTANCE STATUS PID MODE
master_master:instance001 RUNNING 30818 RW
master_master:instance002 RUNNING 30819 RW
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
master_master:instance001 RUNNING 9263 RW ready running --
master_master:instance002 RUNNING 9264 RW ready running --


.. _replication-master-master-check-status:
Expand Down
11 changes: 9 additions & 2 deletions doc/tooling/tt_cli/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ Details
-------

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

By default, available versions of Tarantool Community Edition and ``tt`` are taken from their git repositories.
Their installation includes building from sources, which requires some tools and
Expand Down Expand Up @@ -144,6 +145,12 @@ Example

$ tt install tarantool

* Install the latest available patch version of Tarantool CE 3.2 release series:

.. code-block:: console

$ tt install tarantool 3.2

* Install Tarantool 2.11.1 from the local repository:

.. code-block:: console
Expand Down
17 changes: 8 additions & 9 deletions doc/tooling/tt_cli/start_stop_instance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,20 @@ To check the status of instances, execute :ref:`tt status <tt-status>`:
.. code-block:: console

$ tt status sharded_cluster_crud
INSTANCE STATUS PID MODE
sharded_cluster_crud:storage-a-001 RUNNING 2023 RW
sharded_cluster_crud:storage-a-002 RUNNING 2026 RO
sharded_cluster_crud:storage-b-001 RUNNING 2020 RW
sharded_cluster_crud:storage-b-002 RUNNING 2021 RO
sharded_cluster_crud:router-a-001 RUNNING 2022 RW
INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
sharded_cluster_crud:router-a-001 RUNNING 8382 RW ready running --
sharded_cluster_crud:storage-a-001 RUNNING 8386 RW ready running --
sharded_cluster_crud:storage-a-002 RUNNING 8390 RO ready running --
sharded_cluster_crud:storage-b-001 RUNNING 8379 RW ready running --
sharded_cluster_crud:storage-b-002 RUNNING 8380 RO ready running --

To check the status of a specific instance, you need to specify its name:

.. code-block:: console

$ tt status sharded_cluster_crud:storage-a-001
INSTANCE STATUS PID MODE
sharded_cluster_crud:storage-a-001 RUNNING 2023 RW

INSTANCE STATUS PID MODE CONFIG BOX UPSTREAM
sharded_cluster_crud:storage-a-001 RUNNING 8386 RW ready running --

.. _admin-start_stop_instance_connect:

Expand Down
17 changes: 12 additions & 5 deletions doc/tooling/tt_cli/status.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@ Checking instance status

.. code-block:: console

$ tt status [APPLICATION[:APP_INSTANCE]] [-p|--pretty]
$ tt status [APPLICATION[:APP_INSTANCE]] [OPTION ...]

``tt status`` prints the information about Tarantool applications and instances
in the current environment. This includes:

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

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

Expand Down Expand Up @@ -41,6 +44,10 @@ Examples
Options
-------

.. option:: -d, --details

Print detailed alerts.

.. option:: -p, --pretty

Print the status as a pretty-formatted table.
18 changes: 17 additions & 1 deletion doc/tooling/tt_cli/stop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Stopping a Tarantool instance
$ tt stop [APPLICATION[:APP_INSTANCE]]

``tt stop`` stops the specified running Tarantool applications or instances.
When called without arguments, stops all running applications in the current environment.
Before stopping the instances, the command prompts the user for confirmation.

When called without arguments, ``tt stop`` stops all running applications in the current environment.

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

Expand All @@ -21,9 +23,23 @@ Examples

$ tt stop app


* Stop all instances of the ``app`` application without confirmation:

.. code-block:: console

$ tt stop app -y

* Stop the ``replica`` instance of the ``app`` application:

.. code-block:: console

$ tt stop app:replica


Options
-------

.. option:: -y, --yes

Stop instances without confirmation.
Loading