Skip to content

tt replicaset (rs), subcommand status #3966

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

Closed
Tracked by #3850
TarantoolBot opened this issue Dec 26, 2023 · 0 comments · Fixed by #4185
Closed
Tracked by #3850

tt replicaset (rs), subcommand status #3966

TarantoolBot opened this issue Dec 26, 2023 · 0 comments · Fixed by #4185
Assignees
Labels

Comments

@TarantoolBot
Copy link
Collaborator

TarantoolBot commented Dec 26, 2023

Related dev. issue(s): tarantool/tt#314, tarantool/tt#317

Product: Tarantool, Cartridge, TDG, connectors, tools?
Since: 2.1.1
Root document: https://www.tarantool.io/en/doc/latest/reference/tooling/tt_cli/commands/
SME: @ oleg-jukovec

Details

To do together with other tt replicaset documentation tasks, see #3850.

The patch introduces a new module replicaset (rs shortcut). The
module has one command at this moment:

  • tt replicaset status <target> - to show a replicaset status.

The target could be an application, an instance, or remote instance.

The command automatically determines a replicaset orchestrator.
Currently, it supports:

  • cartridge - the Cartridge orchestrator for Tarantool <= 2.
  • config - the centralized config orchestrator for Tarantool >= 3.
  • custom - any other unknown orchestrator for Tarantool <= 2.

Usage:

tt replicaset status [--cartridge|--config|--custom] (<APP_NAME> | <APP_NAME:INSTANCE_NAME> | <URI>)

The URI can be specified in the following formats:

  • [tcp://][username:password@][host:port]
  • [unix://][username:password@]socketpath

The command supports the following environment variables used with URI:

  • TT_CLI_USERNAME - specifies a username for the URI case
  • TT_CLI_PASSWORD - specifies a password for the URI case

Additional flags are supported:

  • --cartridge to force the Cartridge orchestrator
  • --config to force the centralized config orchestrator
  • --custom to force a custom orchestrator
  • -p, --password string password for the URI case
  • --sslcafile string path to a trusted certificate authorities (CA)
    file for the URI case
  • --sslcertfile string path to an SSL certificate file for the URI
    case
  • --sslciphers string colon-separated (:) list of SSL cipher suites
    the replicasetion for the URI case
  • --sslkeyfile string path to a private SSL key file the URI case
  • -u, --username string username for the URI case

The example of execution:

$ tt replicaset status myapp

Orchestrator:      cartridge
Replicasets state: bootstrapped

• router
  Failover: off
  Provider: none
  Master:   single
  Roles:    failover-coordinator, vshard-router, app.roles.custom
    ★ router localhost:3301 rw
• s-1
  Failover: off
  Provider: none
  Master:   single
  Roles:    vshard-storage
    ★ s1-master localhost:3302 rw
    • s1-replica localhost:3303 read

Closes #314
Closes #317
Requested by @oleg-jukovec in tarantool/tt@afb76ff.

@andreyaksenov andreyaksenov self-assigned this Jan 10, 2024
@andreyaksenov andreyaksenov removed their assignment Jan 11, 2024
@p7nov p7nov self-assigned this Apr 24, 2024
@p7nov p7nov changed the title new module - replicaset, rs new module - replicaset, rs, subcommand status Apr 24, 2024
@p7nov p7nov changed the title new module - replicaset, rs, subcommand status tt replicaset, rs, subcommand status Apr 24, 2024
@p7nov p7nov changed the title tt replicaset, rs, subcommand status tt replicaset (rs), subcommand status Apr 24, 2024
p7nov added a commit that referenced this issue Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants