Update tt docs to 2.3.0 (misc changes) (#4324)

p7nov · lenkis · web-flow · commit 691ac041b7b5 · 2024-07-01T11:26:44.000+07:00
Resolves #4188, #4288, #4289, #4290, #4291 TT_CLI_CFG env variable tt coredump: -s option tt status: mode in output and --pretty option tt import: --keep-bucket-id tt create: list of built-in templates Co-authored-by: Elena Shebunyaeva <elena.shebunyaeva@gmail.com>
diff --git a/doc/book/admin/server_introspection.rst b/doc/book/admin/server_introspection.rst
@@ -79,8 +79,8 @@ To check the instance status, run:
 .. code-block:: console
 
     $ tt status my_app
-    INSTANCE     STATUS      PID
-    my_app       RUNNING     67172
+    INSTANCE     STATUS      PID   MODE
+    my_app       RUNNING     67172 RW
 
     $ # - OR -
 
diff --git a/doc/book/admin/start_stop_instance.rst b/doc/book/admin/start_stop_instance.rst
@@ -73,20 +73,20 @@ To check the status of instances, execute :ref:`tt status <tt-status>`:
 .. code-block:: console
 
     $ tt status sharded_cluster
-    INSTANCE                          STATUS      PID
-    sharded_cluster:storage-a-001     RUNNING     2023
-    sharded_cluster:storage-a-002     RUNNING     2026
-    sharded_cluster:storage-b-001     RUNNING     2020
-    sharded_cluster:storage-b-002     RUNNING     2021
-    sharded_cluster:router-a-001      RUNNING     2022
+    INSTANCE                          STATUS      PID   MODE
+    sharded_cluster:storage-a-001     RUNNING     2023  RW
+    sharded_cluster:storage-a-002     RUNNING     2026  RO
+    sharded_cluster:storage-b-001     RUNNING     2020  RW
+    sharded_cluster:storage-b-002     RUNNING     2021  RO
+    sharded_cluster:router-a-001      RUNNING     2022  RW
 
 To check the status of a specific instance, you need to specify its name:
 
 .. code-block:: console
 
     $ tt status sharded_cluster:storage-a-001
-    INSTANCE                          STATUS      PID
-    sharded_cluster:storage-a-001     RUNNING     2023
+    INSTANCE                          STATUS      PID   MODE
+    sharded_cluster:storage-a-001     RUNNING     2023  RW
 
 
 .. _admin-start_stop_instance_connect:
diff --git a/doc/how-to/getting_started_db.rst b/doc/how-to/getting_started_db.rst
@@ -76,8 +76,8 @@ Starting an instance
     ..  code-block:: console
 
         $ tt status create_db
-        INSTANCE                       STATUS      PID
-        create_db:instance001          RUNNING     54560
+        INSTANCE                       STATUS      PID   MODE
+        create_db:instance001          RUNNING     54560 RW
 
 #.  Connect to the instance with :ref:`tt connect <tt-connect>`:
 
diff --git a/doc/how-to/getting_started_tcm.rst b/doc/how-to/getting_started_tcm.rst
@@ -253,10 +253,10 @@ To deploy a local cluster based on the configuration from etcd:
     .. code-block:: console
 
         $ tt status cluster
-        INSTANCE               STATUS      PID
-        cluster:instance-001     RUNNING     2058
-        cluster:instance-002     RUNNING     2059
-        cluster:instance-003     RUNNING     2060
+        INSTANCE                 STATUS      PID   MODE
+        cluster:instance-001     RUNNING     2058  RW
+        cluster:instance-002     RUNNING     2059  RO
+        cluster:instance-003     RUNNING     2060  RO
 
 ..  _getting_started_tcm_manage:
 
diff --git a/doc/how-to/replication/repl_bootstrap.rst b/doc/how-to/replication/repl_bootstrap.rst
@@ -137,9 +137,9 @@ Starting instances
     .. code-block:: console
 
         $ tt status manual_leader
-        INSTANCE                      STATUS      PID
-        manual_leader:instance001     RUNNING     15272
-        manual_leader:instance002     RUNNING     15273
+        INSTANCE                      STATUS      PID   MODE
+        manual_leader:instance001     RUNNING     15272 RW
+        manual_leader:instance002     RUNNING     15273 RO
 
 
 .. _replication-master_replica_status:
@@ -292,10 +292,10 @@ Starting an instance
     .. code-block:: console
 
         $ tt status manual_leader
-        INSTANCE                      STATUS      PID
-        manual_leader:instance001     RUNNING     15272
-        manual_leader:instance002     RUNNING     15273
-        manual_leader:instance003     RUNNING     15551
+        INSTANCE                      STATUS      PID   MODE
+        manual_leader:instance001     RUNNING     15272 RW
+        manual_leader:instance002     RUNNING     15273 RO
+        manual_leader:instance003     RUNNING     15551 RO
 
 
 ..  _replication-add_instances-reload-config:
diff --git a/doc/how-to/replication/repl_bootstrap_auto.rst b/doc/how-to/replication/repl_bootstrap_auto.rst
@@ -135,10 +135,10 @@ Starting instances
     .. code-block:: console
 
         $ tt status auto_leader
-        INSTANCE                    STATUS      PID
-        auto_leader:instance001     RUNNING     24768
-        auto_leader:instance002     RUNNING     24769
-        auto_leader:instance003     RUNNING     24767
+        INSTANCE                    STATUS      PID   MODE
+        auto_leader:instance001     RUNNING     24768 RO
+        auto_leader:instance002     RUNNING     24769 RW
+        auto_leader:instance003     RUNNING     24767 RO
 
 
 
diff --git a/doc/how-to/replication/repl_bootstrap_master_master.rst b/doc/how-to/replication/repl_bootstrap_master_master.rst
@@ -141,9 +141,9 @@ Starting instances
     .. code-block:: console
 
         $ tt status master_master
-        INSTANCE                      STATUS      PID
-        master_master:instance001     RUNNING     30818
-        master_master:instance002     RUNNING     30819
+        INSTANCE                      STATUS      PID   MODE
+        master_master:instance001     RUNNING     30818 RW
+        master_master:instance002     RUNNING     30819 RW
 
 
 .. _replication-master-master-check-status:
diff --git a/doc/reference/tooling/tt_cli/configuration.rst b/doc/reference/tooling/tt_cli/configuration.rst
@@ -9,12 +9,30 @@ Configuration file
 ------------------
 
 The key artifact that defines the ``tt`` environment and various aspects of its
-execution is its configuration file.
+execution is its configuration file. You can generate it with a :ref:`tt init <tt-init>` call.
+In the :ref:`default launch mode <tt-config_modes-default>`, the file is generated
+in the current directory, making it the environment root.
 
-By default, the configuration file is called ``tt.yaml``. The location
-where ``tt`` searches for it depends on the :ref:`launch mode <tt-config_modes>`.
-You can also pass the configuration file explicitly in the ``--cfg``
-:ref:`global option <tt-global-options>`.
+.. _tt-config_file_name:
+
+Name and location
+~~~~~~~~~~~~~~~~~
+
+By default, the configuration file is called ``tt.yaml`` and located in the ``tt``
+environment root directory. It depends on the :ref:`launch mode <tt-config_modes>`.
+
+It is also possible to pass the configuration file name and location explicitly using
+the following ways:
+
+#.  ``-c``/``--cfg`` :ref:`global option <tt-global-options>`
+#.  ``TT_CLI_CFG`` environment variable.
+
+The ``TT_CLI_CFG`` variable has a lower priority than the ``--cfg`` option.
+
+.. _tt-config_file_structure:
+
+Structure
+~~~~~~~~~
 
 The ``tt`` configuration file is a YAML file with the following structure:
 
@@ -159,6 +177,8 @@ configuration file. There are three launch modes:
 *   system
 *   local
 
+.. _tt-config_modes-default:
+
 Default launch
 ~~~~~~~~~~~~~~
 
diff --git a/doc/reference/tooling/tt_cli/coredump.rst b/doc/reference/tooling/tt_cli/coredump.rst
@@ -12,15 +12,20 @@ Manipulating Tarantool core dumps
 To be able to investigate Tarantool crashes, make sure that core dumps are enabled
 on the host. Here is the :ref:`instruction on enabling core dumps on Unix systems <admin-core_dumps>`.
 
+``COMMAND`` is one of the following:
+
+*   :ref:`pack <tt-coredump-pack>`
+*   :ref:`unpack <tt-coredump-unpack>`
+*   :ref:`inspect <tt-coredump-inspect>`
+
 ..  important::
 
-        ``tt coredump`` does not support macOS.
+    ``tt coredump`` is not supported on macOS.
 
-Commands
---------
+.. _tt-coredump-pack:
 
 pack
-~~~~
+----
 
 ..  code-block:: console
 
@@ -32,57 +37,62 @@ It includes:
 *   the Tarantool executable
 *   Tarantool version information
 *   OS information
-*   Shared libraries
+*   shared libraries
+*   the `GNU debugger <https://www.sourceware.org/gdb/>`__ with extensions.
 
-Option: a path to a core dump file.
+Pack a ``tar.gz`` file with a Tarantool core dump and supporting data:
+
+..  code-block:: console
+
+    $ tt coredump pack name.core
+
+.. _tt-coredump-unpack:
 
 unpack
-~~~~~~
+------
 
 ..  code-block:: console
 
     $ tt coredump unpack ARCHIVE
 
-Unpack a Tarantool core dump created with ``tt coredump pack`` into a new directory.
-
-Option: a path to a ``tar.gz`` archive packed by ``tt coredump pack``.
-
-inspect
-~~~~~~~
+Unpack a Tarantool core dump archive created with ``tt coredump pack`` into a new directory:
 
 ..  code-block:: console
 
-    $ tt coredump inspect DIRECTORY
+    $ tt coredump unpack tarantool-core-dump.tar.gz
 
-Inspect a Tarantool core dump directory with the `GNU debugger <https://www.sourceware.org/gdb/>`__ (``gdb``)
-The directory being inspected must have the same structure as the core dump archive
-created by ``tt coredump pack``.
 
-.. note::
+.. _tt-coredump-inspect:
 
-    ``tt coredump inspect`` requires ``gdb`` installed on the host.
+inspect
+-------
 
-Option: a path to a directory with an unpacked core dump archive.
+..  code-block:: console
 
-Examples
---------
+    $ tt coredump inspect [ARCHIVE|DIRECTORY] [-s]
 
-*   Pack a ``tar.gz`` file with a Tarantool core dump and supporting data:
+Inspect a Tarantool core dump with the `GNU debugger <https://www.sourceware.org/gdb/>`__ (``gdb``).
+The command argument can be either an archive file produced with ``tt coredump pack``
+or directory where such an archive is extracted.
 
-    ..  code-block:: console
+Inspect the core dump archive with ``gdb``:
 
-        $ tt coredump pack name.core
+..  code-block:: console
+
+    $ tt coredump inspect tarantool-core-dump.tar.gz
 
+Inspect the unpacked core dump directory with ``gdb``:
 
-*   Unpack a ``tar.gz`` archive packed by ``tt coredump pack``:
+..  code-block:: console
 
-    ..  code-block:: console
+    $ tt coredump inspect tarantool-core-dump
 
-        $ tt coredump unpack tarantool-core-dump.tar.gz
 
+Options
+-------
 
-*   Inspect the unpacked core dump with ``gdb``:
+..  option:: -s
 
-    ..  code-block:: console
+    **Applicable to**: ``inspect``
 
-        $ tt coredump inspect tarantool-core-dump
+    Specify the location of Tarantool sources.
diff --git a/doc/reference/tooling/tt_cli/create.rst b/doc/reference/tooling/tt_cli/create.rst
diff --git a/doc/reference/tooling/tt_cli/global_options.rst b/doc/reference/tooling/tt_cli/global_options.rst
diff --git a/doc/reference/tooling/tt_cli/import.rst b/doc/reference/tooling/tt_cli/import.rst
diff --git a/doc/reference/tooling/tt_cli/status.rst b/doc/reference/tooling/tt_cli/status.rst
