-
Notifications
You must be signed in to change notification settings - Fork 43
Replace tarantoolctl with tt (CE part) #3706
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
Conversation
doc/book/admin/logs.rst
Outdated
By default, logs are written to a file as defined in ``tarantoolctl`` | ||
defaults. ``tarantoolctl`` automatically detects if an instance is using | ||
By default, logs are written to a file as defined in ``tt`` | ||
defaults. ``tt`` automatically detects if an instance is using |
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.
As I know, tt
does not detect instance logging method. I'm not sure if tarantoolctl
is able to do it. @LeonidVas do you know something about this functionality?
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.
I've rechecked this page. Seems like it needs a bigger update. Will rewrite it to reflect the tt
usage and behavior.
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.
Rewrote the logs page, please check.
doc/book/admin/os_notes.rst
Outdated
@@ -10,7 +10,7 @@ Notes for operating systems | |||
Mac OS | |||
-------------------------------------------------------------------------------- | |||
|
|||
On Mac OS, you can administer Tarantool instances only with ``tarantoolctl``. | |||
On Mac OS, you can administer Tarantool instances only with :ref:`tt <tt-cli>`. |
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.
Section FreeBSD, lines 22, 32, 28-30:
- tarantoolctl or tt?
- improve bullet list:
default
fortarantoolctl
defaults (see example below)instances.available
for all available instance filesinstances.enabled
for instance files to be auto-started by sysvinit
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.
Moved this part to tarantooctl page; no FreeBSD specifics for tt (at least for now).
Co-authored-by: Kseniia Antonova <73473519+xuniq@users.noreply.github.com>
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.
LGTM, several minor fixes and suggestions
-------------------------------------------------------------------------------- | ||
Utility `tarantoolctl` | ||
-------------------------------------------------------------------------------- | ||
Utility tarantoolctl (deprecated) |
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.
Maybe, rename to tarantoolctl utility (deprecated)
for consistency with a neighboring tt CLI utility
?
|
||
``tarantoolctl`` is deprecated in favor of :ref:`tt CLI <tt-cli>`. | ||
Find the instructions on switching from ``tarantoolctl`` to ``tt`` in | ||
:ref:`Migration from tarantoolctl to tt <tarantoolctl-migration-to-tt>`. |
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.
See also
tarantoolctl
usage examples in :ref:Server administration <admin>
section.
Am I correct that there are no more examples for tarantoolctl and this sentence can be removed?
A multi-purpose tool for working with Tarantool from the command line, ``tt`` is | ||
a potential replacement for :ref:`tarantoolctl <tarantoolctl>` | ||
and :doc:`Cartridge CLI </book/cartridge/cartridge_cli/index>`. | ||
|
||
``tt`` is developed in its own `GitHub repository <https://github.com/tarantool/tt>`_. | ||
Here you can find its source code, the changelog, and usage examples. |
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.
... , and usage examples.
Given that documentation also contains usage examples (and, I believe, documentation is the main source of examples), this reference confuses me a bit.
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.
Rephrased.
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
Resolves #3501
Deployment: https://docs.d.tarantool.io/ru/doc/gh-3501-tarantoolctl-to-tt/
Affected pages (to check specific changes on staging):