-
Notifications
You must be signed in to change notification settings - Fork 43
Add tt commands start, stop, status, restart #3022
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
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
cc9e5b5
Add tt commands start, stop, status, restart
p7nov e586ef2
fix
p7nov 5e5ac9e
fix
p7nov 0a03a55
markup
p7nov c905203
fix
p7nov f186730
remove argument brackets
p7nov 089d627
Review fixes
p7nov 4de9ec2
Remove redundant sentence
p7nov 4cc5461
Fix markup
p7nov 199bfcc
Fix
p7nov 8c50197
Apply suggestions from code review
p7nov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <stop>` and :doc:`tt start <start>`. | ||
|
||
Examples | ||
-------- | ||
|
||
Restart the ``app`` instance: | ||
|
||
.. code-block:: bash | ||
|
||
tt restart app | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
.. _tt-start: | ||
|
||
Starting a Tarantool instance | ||
============================= | ||
|
||
.. code-block:: bash | ||
|
||
tt start INSTANCE | ||
|
||
``tt start`` starts the specified Tarantool :ref:`instance <admin-instance_file>`. | ||
|
||
Details | ||
------- | ||
|
||
``INSTANCE`` is the name of an instance from the ``instances_available`` directory | ||
specified in the :ref:`tt configuration file <tt-config_file_app>`. This can be: | ||
|
||
* the name of an :ref:`instance file <admin-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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the default value for the
instances_available
directory? The user might have the same question when reading this document. Consider indicating the default on the config page.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now it's the current working directory but it's not the final decision, please see this comment. We decided to skip this detail so that readers don't rely on it.