From febec1a64e7a9a19f1ddc62b881777afcdda2a80 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Thu, 2 Mar 2023 13:03:17 +0700 Subject: [PATCH 1/2] Add tt install/search/uninstall docs --- doc/reference/tooling/tt_cli/commands.rst | 9 ++ .../tooling/tt_cli/configuration.rst | 4 + doc/reference/tooling/tt_cli/install.rst | 85 +++++++++++++++++++ doc/reference/tooling/tt_cli/installation.rst | 2 +- doc/reference/tooling/tt_cli/search.rst | 50 +++++++++++ doc/reference/tooling/tt_cli/uninstall.rst | 19 +++++ 6 files changed, 168 insertions(+), 1 deletion(-) create mode 100644 doc/reference/tooling/tt_cli/install.rst create mode 100644 doc/reference/tooling/tt_cli/search.rst create mode 100644 doc/reference/tooling/tt_cli/uninstall.rst diff --git a/doc/reference/tooling/tt_cli/commands.rst b/doc/reference/tooling/tt_cli/commands.rst index 6a9f9f50a0..1370c12e56 100644 --- a/doc/reference/tooling/tt_cli/commands.rst +++ b/doc/reference/tooling/tt_cli/commands.rst @@ -32,6 +32,8 @@ help for the given command. - Display help for ``tt`` or a specific command * - :doc:`init ` - Create a new ``tt`` environment in the current directory + * - :doc:`install ` + - Install Tarantool or ``tt`` * - :doc:`logrotate ` - Rotate instance logs * - :doc:`play ` @@ -40,12 +42,16 @@ help for the given command. - Restart a Tarantool instance * - :doc:`rocks ` - Use the LuaRocks package manager + * - :doc:`search ` + - Search available Tarantool and ``tt`` versions * - :doc:`start ` - Start a Tarantool instance * - :doc:`status ` - Get the current status of a Tarantool instance * - :doc:`stop ` - Stop a Tarantool instance + * - :doc:`uninstall ` + - Uninstall Tarantool or ``tt`` * - :doc:`version ` - Show the ``tt`` version information @@ -61,11 +67,14 @@ help for the given command. coredump create help + install logrotate play restart rocks + search start status stop + uninstall version diff --git a/doc/reference/tooling/tt_cli/configuration.rst b/doc/reference/tooling/tt_cli/configuration.rst index a881f21886..7a32a59c1a 100644 --- a/doc/reference/tooling/tt_cli/configuration.rst +++ b/doc/reference/tooling/tt_cli/configuration.rst @@ -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 ~~~~~~~~~~ diff --git a/doc/reference/tooling/tt_cli/install.rst b/doc/reference/tooling/tt_cli/install.rst new file mode 100644 index 0000000000..7f266aab66 --- /dev/null +++ b/doc/reference/tooling/tt_cli/install.rst @@ -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 ` 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 ` 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 `. + +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 `. + +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 \ No newline at end of file diff --git a/doc/reference/tooling/tt_cli/installation.rst b/doc/reference/tooling/tt_cli/installation.rst index 795ad0a721..cd2f1b43d4 100644 --- a/doc/reference/tooling/tt_cli/installation.rst +++ b/doc/reference/tooling/tt_cli/installation.rst @@ -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 -`_. +`_. The installation command looks like this: diff --git a/doc/reference/tooling/tt_cli/search.rst b/doc/reference/tooling/tt_cli/search.rst new file mode 100644 index 0000000000..2680cf69c5 --- /dev/null +++ b/doc/reference/tooling/tt_cli/search.rst @@ -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 ` 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 ` 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 \ No newline at end of file diff --git a/doc/reference/tooling/tt_cli/uninstall.rst b/doc/reference/tooling/tt_cli/uninstall.rst new file mode 100644 index 0000000000..0685fdc85d --- /dev/null +++ b/doc/reference/tooling/tt_cli/uninstall.rst @@ -0,0 +1,19 @@ +.. _tt-uninstall: + +Uninstalling Tarantool software +=============================== + +.. code-block:: bash + + tt uninstall PROGRAM_NAME + +``tt uninstall`` a previously :doc:`installed ` Tarantool version. + +Example +-------- + +Uninstall Tarantool 2.10.4: + +.. code-block:: bash + + tt uninstall tarantool=2.10.4 \ No newline at end of file From f70782f34d3c227d3f14516b092d09cb9ebfb848 Mon Sep 17 00:00:00 2001 From: Pavel Semyonov Date: Mon, 6 Mar 2023 11:07:31 +0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Kseniia Antonova <73473519+xuniq@users.noreply.github.com> --- doc/reference/tooling/tt_cli/uninstall.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/reference/tooling/tt_cli/uninstall.rst b/doc/reference/tooling/tt_cli/uninstall.rst index 0685fdc85d..48a7593d94 100644 --- a/doc/reference/tooling/tt_cli/uninstall.rst +++ b/doc/reference/tooling/tt_cli/uninstall.rst @@ -7,7 +7,7 @@ Uninstalling Tarantool software tt uninstall PROGRAM_NAME -``tt uninstall`` a previously :doc:`installed ` Tarantool version. +``tt uninstall`` uninstalls a previously :doc:`installed ` Tarantool version. Example --------