Skip to content

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

Merged
merged 17 commits into from
Sep 21, 2023
Merged

Conversation

p7nov
Copy link
Contributor

@p7nov p7nov commented Sep 12, 2023

Resolves #3501

Deployment: https://docs.d.tarantool.io/ru/doc/gh-3501-tarantoolctl-to-tt/

Affected pages (to check specific changes on staging):

@p7nov p7nov marked this pull request as draft September 12, 2023 08:48
@p7nov p7nov changed the title Replace tarantoolctl with tt -- draft Replace tarantoolctl with tt (CE part) Sep 13, 2023
@p7nov p7nov requested a review from psergee September 19, 2023 09:55
@p7nov p7nov marked this pull request as ready for review September 19, 2023 09:57
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
Copy link
Contributor

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?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

@@ -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>`.
Copy link
Contributor

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:

  1. tarantoolctl or tt?
  2. improve bullet list:
  • default for tarantoolctl defaults (see example below)
  • instances.available for all available instance files
  • instances.enabled for instance files to be auto-started by sysvinit

Copy link
Contributor Author

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>
Copy link
Contributor

@andreyaksenov andreyaksenov left a 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)
Copy link
Contributor

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>`.
Copy link
Contributor

@andreyaksenov andreyaksenov Sep 21, 2023

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.
Copy link
Contributor

@andreyaksenov andreyaksenov Sep 21, 2023

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrased.

p7nov and others added 3 commits September 21, 2023 14:44
Co-authored-by: Andrey Aksenov <38073144+andreyaksenov@users.noreply.github.com>
@p7nov p7nov merged commit 41aaa14 into latest Sep 21, 2023
@p7nov p7nov deleted the gh-3501-tarantoolctl-to-tt branch September 21, 2023 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate tarantoolctl and cartridge-cli in docs
4 participants