Skip to content

Commit f14bb93

Browse files
committed
docs: deprecate Cartridge CLI in favor of tt CLI
1 parent 986e806 commit f14bb93

File tree

3 files changed

+32
-11
lines changed

3 files changed

+32
-11
lines changed

rst/cartridge_admin.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ Then :ref:`start the instances <cartridge-run>`, for example using
4242
4343
$ cartridge start my_app --cfg demo.yml --run-dir ./tmp/run
4444
45+
.. important::
46+
47+
``cartridge-cli`` is deprecated in favor of the :ref:`tt CLI utility <tt-cli>`.
48+
This guide uses ``cartridge-cli`` as a native tool for Cartridge applications
49+
development. However, we encourage you to switch to ``tt`` in order to simplify
50+
the migration to Tarantool 3.0 and newer versions.
51+
4552
And bootstrap the cluster.
4653
You can do this via the Web interface which is available at
4754
``http://<instance_hostname>:<instance_http_port>``
@@ -875,11 +882,12 @@ YAML format.
875882
To connect to a Tarantool instance via the console, you can choose
876883
one of the commands:
877884

878-
* Old-fashioned way:
885+
886+
* Using the ``tt`` CLI utility:
879887

880888
.. code-block:: bash
881889
882-
$ tarantoolctl connect <instance_hostname>:<port>
890+
$ tt connect <instance_hostname>:<port>
883891
884892
* If you have cartridge-cli installed:
885893

@@ -893,6 +901,12 @@ one of the commands:
893901
894902
$ cartridge enter <node_name>
895903
904+
* Old-fashioned way with ``tarantoolctl``:
905+
906+
.. code-block:: bash
907+
908+
$ tarantoolctl connect <instance_hostname>:<port>
909+
896910
where the ``<instance_hostname>:<port>`` is the instance's URI.
897911

898912
.. _cartridge-monitor-storage:

rst/cartridge_dev.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ Installing Tarantool Cartridge
4444
``cartridge-cli``, a command-line tool for developing, deploying, and
4545
managing Tarantool applications.
4646

47+
.. important::
48+
49+
``cartridge-cli`` is deprecated in favor of the :ref:`tt CLI utility <tt-cli>`.
50+
This guide uses ``cartridge-cli`` as a native tool for Cartridge applications
51+
development. However, we encourage you to switch to ``tt`` in order to simplify
52+
the migration to Tarantool 3.0 and newer versions.
53+
4754
#. `Install <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`__
4855
``git``, a version control system.
4956

@@ -1141,7 +1148,7 @@ entities are additionally created:
11411148
- ``srwxr-xr-x``
11421149
- ``tarantool:tarantool``
11431150
- Unix socket to connect to the instance via the
1144-
`tarantoolctl <https://www.tarantool.io/en/doc/latest/reference/tarantoolctl/>`_
1151+
`tt CLI <https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/>`_
11451152
utility.
11461153

11471154
.. _cartridge-deploy-tgz:
@@ -1233,7 +1240,7 @@ This deployment method is intended for local testing only.
12331240

12341241
.. code-block:: bash
12351242
1236-
$ tarantoolctl rocks make
1243+
$ tt rocks make
12371244
12381245
#. Configure the instance(s).
12391246
Create a file called ``/etc/tarantool/conf.d/instances.yml``.

rst/troubleshooting.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ instances.
5757

5858
.. code-block:: bash
5959
60-
tarantoolctl connect unix/:/var/run/tarantool/<app-name>.<instance-name>.control
60+
tt connect /var/run/tarantool/<app-name>.<instance-name>.control
6161
6262
#. Inspect what's going on.
6363

@@ -126,8 +126,8 @@ option to zero. It may be accomplished in two ways:
126126

127127
.. code-block:: bash
128128
129-
echo "box.cfg({replication_connect_quorum = 0})" | tarantoolctl connect \
130-
unix/:/var/run/tarantool/<app-name>.<instance-name>.control
129+
echo "box.cfg({replication_connect_quorum = 0})" | tt connect \
130+
/var/run/tarantool/<app-name>.<instance-name>.control -f -
131131
132132
I want to run an instance with a new advertise_uri
133133
--------------------------------------------------
@@ -310,8 +310,8 @@ To change instance advertise URI you have to perform these actions:
310310

311311
.. code-block:: bash
312312
313-
echo "return box.info().uuid" | tarantoolctl connect \
314-
unix/:/var/run/tarantool/<app-name>.<instance-name>.control
313+
echo "return box.info().uuid" | tt connect \
314+
/var/run/tarantool/<app-name>.<instance-name>.control -f -
315315
316316
#. Now we need to update instance advertise URI in all instances cluster-wide
317317
configuration files on each machine. Run ``cartridge repair set-advertise-uri``
@@ -386,8 +386,8 @@ You can remove instance from cluster using ``cartridge repair`` command.
386386

387387
.. code-block:: bash
388388
389-
echo "return box.info().uuid" | tarantoolctl connect \
390-
unix/:/var/run/tarantool/<app-name>.<instance-name>.control
389+
echo "return box.info().uuid" | tt connect \
390+
/var/run/tarantool/<app-name>.<instance-name>.control -f -
391391
392392
#. Now we need to update cluster-wide config for all instances on each machine.
393393
Run ``cartridge repair remove-instance`` with ``--dry-run`` flag on each

0 commit comments

Comments
 (0)