Rewrite Starting and stopping instances to use tt CLI #3739
Conversation
psergee
left a comment
psergee
left a comment
There was a problem hiding this comment.
Shouldn't we add an example of multi-instance application?
| • Result of check: syntax of file '/etc/tarantool/instances.enabled/my_app.lua' is OK | ||
| .. code-block:: console | ||
| * ``tt status`` -- check the instance's status: |
Thanks for the idea. |
|
|
||
| While a Lua application is executed by Tarantool, an instance file is executed | ||
| by ``tarantoolctl`` which is a Tarantool script. | ||
| Quick start |
There was a problem hiding this comment.
Honestly, I'd remove this heading as some people might call this not a "quick" start. For example, the instance file link leads us to a huge section of text without any kind of hello world instance file example, so starting an instance might be not very simple. I think, the text below works good as an introduction without a heading.
|
|
||
| All the instance files or directories placed in the ``instances_enabled`` directory | ||
| specified in :ref:`tt configuration <tt-config_file>` are called *enabled instances*. | ||
| If there are several enabled instances, ``tt start`` starts a separate instance for each of them. |
There was a problem hiding this comment.
The unfolded sentence sounds a bit weird: .. starts a separate instance for each of the instances. Looks like the enabled instance term adds some confusion with a Tarantool instance. Maybe smth like this?
If there are several enabled instances, ``tt start`` starts them separately.
or use Tarantool instance to add some contrast:
If there are several enabled instances, ``tt start`` starts a separate Tarantool instance...
| • Starting an instance [my_app]... | ||
| .. code-block:: console | ||
| .. note:: |
There was a problem hiding this comment.
Maybe, it's better to format this as a regular sentence. A note takes too much space and attention.
| * stop a specific instance of an application or all its instances | ||
|
|
||
| .. code-block:: lua | ||
| Application layout |
There was a problem hiding this comment.
Future task: we need to think about a new place for this section as it not directly related to administration. Ideally, this section should contain only the Managing multi-instance applications content.
| Sometimes you may need to run a Tarantool instance locally, for example, for test | ||
| purposes. ``tt`` runs in a local environment if it finds a ``tt.yaml`` configuration | ||
| file in the current directory or any of its enclosing directories. | ||
| To force ``tt`` into the local mode, add the ``-L`` or ``--local`` argument. |
There was a problem hiding this comment.
Let's add a link to https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/configuration/#launch-modes somewhere. And I didn't quite understand which tt command should be run with the -L flag.
There was a problem hiding this comment.
moved the part about --local in the end of the section with a separate example.
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
Resolves #3718
ttCLI.tarantoolctlto the tarantoolctl doc page.Deployment: https://docs.d.tarantool.io/en/doc/gh-3718-starting-instance-tt/book/admin/start_stop_instance/