[Epic] tt CLI 2.0-2.2 Q2

[p7nov]

Related dev. issue(s): GitHub link(s)

Product: tt cli
Since: tt 2.0-2.2
Audience/target: all
Root document: https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/
SME: @ psergee

Details

Update tt CLI docs according to changes in releases 2.0.0-2.2.1. See also: Migration from older versions.

Important changes of tt 2.0

Key changes of tt 2.0 were documented in scope of #3996.

Tasks

23 sp:

• tt cluster show/publish works with Tarantool config storage #3932
• User should not set box.cfg.background = true with tt start #4079
• tt-ee tdg2 import/export #4145
• tt cluster show: ssl_ciphers URI parameter for Tarantool config storage #3933
• Document generating per-application systemd service #4078
• Document environment variables supported by tt  #3828
• tt replicaset:
  • tt replicaset (rs), subcommand status #3966
  • tt replicaset promote, tt cluster replicaset promote promotes an instance #4088
  • tt replicaset promote for cartridge #4109
  • tt replicaset demote, tt cluster replicaset demote demotes an instance #4121
• TT CLI: new module - download #4032
• tt binaries switch: switching between program versions #4026
• tt kill reference #4222
• tt cluster failover commands #4249
• tt status: new option pretty and changed output #4288
• New TT_CLI_CFG env variable: the path to the configuration file #4289
• tt crud import: new option --keep-bucket-id and changed default behavior #4290
• tt coredump updates #4291
• New built-in template for tt create: single_instance #4188

[andreyaksenov]

It would be useful to have a doc page that describes scenarios for working with tt. Here are some of my thoughts on how tt commands can be divided depending on a usage scenario:

Prerequisites: install tt

1) Tips and tricks:
version
help
completion

2) Initialize the environment:
init
cfg

3) Install Tarantool:
search
install
uninstall
binaries

4) Developing the app:
create
instances
run
check
build
rocks
pack

5) Admininstration:
- (instances)
start	Start a Tarantool instance
status	Get the current status of a Tarantool instance
connect	Connect to a Tarantool instance
stop	Stop a Tarantool instance
restart	Restart a Tarantool instance
clean	Clean instance files

- (maintenance)
cat	Print the contents of .snap or .xlog files into stdout
play	Play the contents of .snap or .xlog files to another Tarantool instance

- (logs)
logrotate	Rotate instance logs

- (data)
crud	Interact with the CRUD module (Enterprise only)
export	Export data to a file (Enterprise only)
import	Import data from a file (Enterprise only)

6) Debugging:
coredump	Manipulate Tarantool core dumps

At least, we can try to group commands on this page instead of the current alphabetical list:
https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/commands/

[andreyaksenov]

tt connect example with SSL:

% ls
client.crt      client.key
% tt connect 127.0.0.1:3301 \
           --username admin --password topsecret \
           --sslcertfile client.crt --sslkeyfile client.key
   • Connecting to the instance...
   • Connected to 127.0.0.1:3301

127.0.0.1:3301>

Without the cert and key files provided, the following error is thrown:

⨯ failed to run interactive console: failed to create new console: failed to connect: failed to dial: SSL errors: SSL routines::sslv3 alert handshake failure

Username and password can be also specified using env vars:

* TT_CLI_USERNAME - specifies a username
* TT_CLI_PASSWORD - specifies a password