Skip to content

Add tt install/search/uninstall docs #3362

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.

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

Merged
merged 2 commits into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions doc/reference/tooling/tt_cli/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ help for the given command.
- Display help for ``tt`` or a specific command
* - :doc:`init <init>`
- Create a new ``tt`` environment in the current directory
* - :doc:`install <install>`
- Install Tarantool or ``tt``
* - :doc:`logrotate <logrotate>`
- Rotate instance logs
* - :doc:`play <play>`
Expand All @@ -40,12 +42,16 @@ help for the given command.
- Restart a Tarantool instance
* - :doc:`rocks <rocks>`
- Use the LuaRocks package manager
* - :doc:`search <search>`
- Search available Tarantool and ``tt`` versions
* - :doc:`start <start>`
- Start a Tarantool instance
* - :doc:`status <status>`
- Get the current status of a Tarantool instance
* - :doc:`stop <stop>`
- Stop a Tarantool instance
* - :doc:`uninstall <uninstall>`
- Uninstall Tarantool or ``tt``
* - :doc:`version <version>`
- Show the ``tt`` version information

Expand All @@ -61,11 +67,14 @@ help for the given command.
coredump <coredump>
create <create>
help <help>
install <install>
logrotate <logrotate>
play <play>
restart <restart>
rocks <rocks>
search <search>
start <start>
status <status>
stop <stop>
uninstall <uninstall>
version <version>
4 changes: 4 additions & 0 deletions doc/reference/tooling/tt_cli/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,16 @@ app section
* ``restart_on_failure`` -- restart the instance on failure: ``true`` or ``false``.
Default: ``false``.

.. _tt-config_file_repo:

repo section
~~~~~~~~~~~~

* ``rocks`` -- the directory where rocks files are stored.
* ``distfiles`` -- the directory where installation files are stored.

.. _tt-config_file_ee:

ee section
~~~~~~~~~~

Expand Down
85 changes: 85 additions & 0 deletions doc/reference/tooling/tt_cli/install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
.. _tt-install:

Installing Tarantool software
=============================

.. code-block:: bash

tt install PROGRAM_NAME[=version] [flags]

``tt install`` installs the latest or an explicitly specified version of Tarantool
or ``tt``. The possible values of ``PROGRAM_NAME`` are:

* ``tarantool``
* ``tarantool-ee``
* ``tt``

.. note::

For ``tarantool-ee``, account credentials are required. Specify them in a file
(see the :ref:`ee section <tt-config_file_ee>` of the configuration file) or
provide them interactively.

Flags
-----

.. container:: table

.. list-table::
:widths: 20 80
:header-rows: 0

* - ``-f``

``--force``
- Skip dependency check before installation
* - ``--local-repo``
- Install a program from the local repository, which is specified
in the :ref:`repo section <tt-config_file_repo>` of the ``tt``
configuration file
* - ``--no-clean``
- Don't delete temporary files
* - ``--reinstall``
- Reinstall a previously installed program
* - ``--use-docker``
- Build Tarantool in an Ubuntu 16.04 Docker container

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>`.

By default, available versions of Tarantool CE and ``tt`` are taken from their git repositories.
Their installation includes building from sources, which requires some tools and
dependencies, such as a C compiler. Make sure they are available in the system.

Tarantool EE is installed from prebuilt packages.

You can also set up a local repository with installation files you need.
To use it, specify its location in the :ref:`repo section` of the ``tt`` configuration
file and run ``tt install`` with the ``--local-repo`` flag.

To uninstall a Tarantool or ``tt`` version, use :doc:`tt uninstall <uninstall>`.

Example
--------

* Install the latest available version of Tarantool:

.. code-block:: bash

tt install tarantool

* Install Tarantool 2.10.5 from the local repository:

.. code-block:: bash

tt install tarantool=2.10.5 --local-repo

* Reinstall Tarantool 2.10.5:

.. code-block:: bash

tt install tarantool=2.10.5 --reinstall
2 changes: 1 addition & 1 deletion doc/reference/tooling/tt_cli/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Using package managers

On Linux systems, you can install with ``yum`` or ``apt`` package managers from
the ``tarantool/modules`` repository. Learn how to `add this repository
<https://www.tarantool.io/en/download/os-installation/ubuntu/>`_.
<https://www.tarantool.io/en/download/os-installation/>`_.

The installation command looks like this:

Expand Down
50 changes: 50 additions & 0 deletions doc/reference/tooling/tt_cli/search.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. _tt-search:

Listing available Tarantool versions
====================================

.. code-block:: bash

tt search PROGRAM_NAME [flags]

``tt search`` lists versions of Tarantool and ``tt`` that are available for
installation. The possible values of ``PROGRAM_NAME`` are:

* ``tarantool``
* ``tarantool-ee``
* ``tt``

.. note::

For ``tarantool-ee``, account credentials are required. Specify them in a file
(see the :ref:`ee section <tt-config_file_ee>` of the configuration file) or
provide interactively.

Flags
-----

.. container:: table

.. list-table::
:widths: 20 80
:header-rows: 0

* - ``--local-repo``
- Search in the local repository, which is specified in the
:ref:`repo section <tt-config_file_repo>` of the ``tt``
configuration file.

Example
--------

* List available Tarantool versions:

.. code-block:: bash

tt search tarantool

* List available ``tt`` versions from the local repository:

.. code-block:: bash

tt search tt --local-repo
19 changes: 19 additions & 0 deletions doc/reference/tooling/tt_cli/uninstall.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. _tt-uninstall:

Uninstalling Tarantool software
===============================

.. code-block:: bash

tt uninstall PROGRAM_NAME

``tt uninstall`` uninstalls a previously :doc:`installed <install>` Tarantool version.

Example
--------

Uninstall Tarantool 2.10.4:

.. code-block:: bash

tt uninstall tarantool=2.10.4