diff --git a/doc/reference/tt_cli/commands.rst b/doc/reference/tt_cli/commands.rst index b99b83fe1e..47a6f7e35e 100644 --- a/doc/reference/tt_cli/commands.rst +++ b/doc/reference/tt_cli/commands.rst @@ -10,13 +10,13 @@ help for the given command. :widths: 30 70 :header-rows: 0 - * - ``start`` - - Start a Tarantool :ref:`instance ` - * - ``stop`` + * - :doc:`start ` + - Start a Tarantool instance + * - :doc:`stop ` - Stop a Tarantool instance - * - ``status`` + * - :doc:`status ` - Get the current status of a Tarantool instance - * - ``restart`` + * - :doc:`restart ` - Restart a Tarantool instance * - ``version`` - Show the ``tt`` version information @@ -35,4 +35,12 @@ help for the given command. * - ``cat`` - Print the contents of ``.snap`` or ``.xlog`` files into stdout * - ``play`` - - Play the contents of ``.snap`` or ``.xlog`` files to another Tarantool instance \ No newline at end of file + - Play the contents of ``.snap`` or ``.xlog`` files to another Tarantool instance + +.. toctree:: + :hidden: + + start + stop + status + restart \ No newline at end of file diff --git a/doc/reference/tt_cli/configuration.rst b/doc/reference/tt_cli/configuration.rst index 07aee78d71..57564261b6 100644 --- a/doc/reference/tt_cli/configuration.rst +++ b/doc/reference/tt_cli/configuration.rst @@ -36,6 +36,8 @@ modules section * ``directory`` -- the directory where external modules are stored. .. // TODO: add link to external modules doc page when it's ready +.. _tt-config_file_app: + app section ~~~~~~~~~~~ diff --git a/doc/reference/tt_cli/restart.rst b/doc/reference/tt_cli/restart.rst new file mode 100644 index 0000000000..37387e315d --- /dev/null +++ b/doc/reference/tt_cli/restart.rst @@ -0,0 +1,20 @@ +Restarting a Tarantool instance +=============================== + +.. code-block:: bash + + tt restart INSTANCE + +``tt restart`` restarts the specified running Tarantool instance. +A ``tt restart`` call is equivalent to consecutive calls of +:doc:`tt stop ` and :doc:`tt start `. + +Examples +-------- + +Restart the ``app`` instance: + +.. code-block:: bash + + tt restart app + diff --git a/doc/reference/tt_cli/start.rst b/doc/reference/tt_cli/start.rst new file mode 100644 index 0000000000..7a705c77db --- /dev/null +++ b/doc/reference/tt_cli/start.rst @@ -0,0 +1,36 @@ +.. _tt-start: + +Starting a Tarantool instance +============================= + +.. code-block:: bash + + tt start INSTANCE + +``tt start`` starts the specified Tarantool :ref:`instance `. + +Details +------- + +``INSTANCE`` is the name of an instance from the ``instances_available`` directory +specified in the :ref:`tt configuration file `. This can be: + +* the name of an :ref:`instance file ` without the ``.lua`` extension. +* the name of a directory containing the ``init.lua`` file. + + +Examples +-------- + +* Start the ``app.lua`` instance from the ``instances_available`` directory: + + .. code-block:: bash + + tt start app + + +* Start the ``init.lua`` instance from the ``instance1/`` directory inside ``instances_available``: + + .. code-block:: bash + + tt start instance1 \ No newline at end of file diff --git a/doc/reference/tt_cli/status.rst b/doc/reference/tt_cli/status.rst new file mode 100644 index 0000000000..9142e667e2 --- /dev/null +++ b/doc/reference/tt_cli/status.rst @@ -0,0 +1,17 @@ +Checking instance status +======================== + +.. code-block:: bash + + tt status INSTANCE + +``tt status`` prints the current status of the specified Tarantool instance. + +Examples +-------- + +Check the status of the ``app`` instance: + +.. code-block:: bash + + tt status app \ No newline at end of file diff --git a/doc/reference/tt_cli/stop.rst b/doc/reference/tt_cli/stop.rst new file mode 100644 index 0000000000..5ecd8bc6d6 --- /dev/null +++ b/doc/reference/tt_cli/stop.rst @@ -0,0 +1,19 @@ +.. _tt-stop: + +Stopping a Tarantool instance +============================= + +.. code-block:: bash + + tt stop INSTANCE + +``tt stop`` stops the specified running Tarantool instance. + +Examples +-------- + +Stop the ``app`` instance: + +.. code-block:: bash + + tt stop app \ No newline at end of file