tt replicaset¶
Manage replicasets
Usage
tt replicaset
tt replicaset [flags] <command> [command flags]
Aliases: rs.
Commands
tt replicaset bootstrap- Bootstrap an application or instancett replicaset demote- Demote an instancett replicaset downgrade- Downgrade tarantool clustertt replicaset expel- Expel an instance from a replicasettt replicaset promote- Promote an instancett replicaset rebootstrap- Re-bootstraps an instancett replicaset roles- Adds or removes roles for Tarantool 3 orchestratortt replicaset status- Show a replicaset statustt replicaset upgrade- Upgrade tarantool clustertt replicaset vshard- Manage vshard
tt replicaset bootstrap¶
Bootstrap an application or instance.
Without a target, the command acts on the project of the current directory, as tt instance does.
Usage
tt replicaset bootstrap [--timeout secs] [flags] [<APP> | <APP>:<INSTANCE>]
Flags
--bootstrap-vshard- bootstrap vshard--config- to force the centralized config orchestrator--custom- to force a custom orchestrator--replicaset string- replicaset name for an instance bootstrapping--scope string- scope the application is looked for in: project, user or system--template string- template of the application the instances are described in (default "default")--timeout int- timeout (default10)
tt replicaset demote¶
Demote an instance.
Usage
tt replicaset demote [-f] [--timeout secs] [flags] <APP>:<INSTANCE>
Flags
--config- to force the centralized config orchestrator--custom- to force a custom orchestrator-f,--force- skip instances not found locally--scope string- scope the application is looked for in: project, user or system--template string- template of the application the instances are described in (default "default")--timeout int- timeout (default3)
tt replicaset downgrade¶
Downgrade tarantool cluster.
The command supports the following Tarantool environment variables:
- TT_CLI_USERNAME - specifies the Tarantool username
- TT_CLI_PASSWORD - specifies the Tarantool password
Usage
tt replicaset downgrade (<APP> | <URI>) VERSION [flags]
The URI can be specified in the following formats:
* [tcp://][username:password@][host:port]
* [unix://][username:password@]socketpath
To specify relative path without `unix://` use `./`.
Flags
--auth-type string- authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (defaultauto)--config- to force the centralized config orchestrator--connect-timeout duration- timeout for establishing a binary connection (default1s)--custom- to force a custom orchestrator-p,--password string- password for the URI case-r,--replicaset stringArray- specify the replicaset name(s) to downgrade--scope string- scope the application is looked for in: project, user or system--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 for the URI case--sslkeyfile string- path to a private SSL key file for the URI case--sslpassword string- password for decrypting the private SSL key file for a cluster connection--sslpasswordfile string- path to a file containing the private SSL key password for a cluster connection--template string- template of the application the instances are described in (default "default")-t,--timeout int- timeout for waiting the LSN synchronization (in seconds) (default5)-u,--username string- username for the URI case
tt replicaset expel¶
Expel an instance from a replicaset.
With the centralized config, the instance is removed the way the Tarantool documentation removes one. Stop it first, on its host, with tt instance stop <APP>:<INSTANCE>: expel does not stop it, and does not connect to it. The other instances of the replicaset are asked instead: one that is still connected to the instance, by its upstream or downstream in box.info.replication, refuses the expel. Then the entry of the instance is deleted from the config, the other instances of the replicaset reload the config, and the instance is deleted from the _cluster space on the writable one of them, waiting up to --timeout seconds for one.
The leader of a replicaset with manual failover is refused: promote another instance first. --force expels an instance that is still connected, and goes on without the other instances that cannot be reached. The data of the expelled instance is left on disk, and an instances.yaml that names it still does.
Usage
tt replicaset expel [-f] [--config|--custom] [--timeout secs] <APP>:<INSTANCE> [flags]
Flags
--config- to force the centralized config orchestrator--custom- to force a custom orchestrator-f,--force- expel an instance still connected to the replicaset, and skip instances not found locally--scope string- scope the application is looked for in: project, user or system--template string- template of the application the instances are described in (default "default")--timeout int- timeout (default3)
tt replicaset promote¶
Promote an instance.
The command supports the following Tarantool environment variables:
- TT_CLI_USERNAME - specifies the Tarantool username
- TT_CLI_PASSWORD - specifies the Tarantool password
Usage
tt replicaset promote [--config|--custom] [-f] [--timeout secs] [flags] (<APP>:<INSTANCE> | <URI>)
The URI can be specified in the following formats:
* [tcp://][username:password@][host:port]
* [unix://][username:password@]socketpath
To specify relative path without `unix://` use `./`.
Flags
--auth-type string- authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (defaultauto)--config- to force the centralized config orchestrator--connect-timeout duration- timeout for establishing a binary connection (default1s)--custom- to force a custom orchestrator-f,--force- to force a promotion: * config: skip instances not found locally-p,--password string- password for the URI case--scope string- scope the application is looked for in: project, user or system--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 for the URI case--sslkeyfile string- path to a private SSL key file for the URI case--sslpassword string- password for decrypting the private SSL key file for a cluster connection--sslpasswordfile string- path to a file containing the private SSL key password for a cluster connection--template string- template of the application the instances are described in (default "default")--timeout int- promoting timeout (default3)-u,--username string- username for the URI case
tt replicaset rebootstrap¶
Re-bootstraps an instance
Usage
tt replicaset rebootstrap <APP>:<INSTANCE>
Flags
--scope string- scope the application is looked for in: project, user or system--template string- template of the application the instances are described in (default "default")-y,--yes- automatically confirm rebootstrap
tt replicaset roles¶
Adds or removes roles for Tarantool 3 orchestrator
Usage
tt replicaset roles
tt replicaset roles [flags] <command> [command flags]
Commands
tt replicaset roles add- Adds a role for Tarantool 3 orchestratortt replicaset roles remove- Removes a role for Tarantool 3 orchestrator
tt replicaset roles add¶
Adds a role for Tarantool 3 orchestrator
Usage
tt replicaset roles add [--config|--custom] [-f] [--timeout secs] <APP>:<INSTANCE> <ROLE_NAME> [flags]
Flags
--auth-type string- authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (defaultauto)--config- to force the centralized config orchestrator--connect-timeout duration- timeout for establishing a binary connection (default1s)--custom- to force a custom orchestrator-f,--force- to force a promotion: * config: skip instances not found locally-G,--global- global config context-g,--group string- name of a target group-i,--instance string- name of a target instance-p,--password string- password for the URI case-r,--replicaset string- name of a target replicaset--scope string- scope the application is looked for in: project, user or system--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 for the URI case--sslkeyfile string- path to a private SSL key file for the URI case--sslpassword string- password for decrypting the private SSL key file for a cluster connection--sslpasswordfile string- path to a file containing the private SSL key password for a cluster connection--template string- template of the application the instances are described in (default "default")--timeout int- adding timeout (default3)-u,--username string- username for the URI case
tt replicaset roles remove¶
Removes a role for Tarantool 3 orchestrator
Usage
tt replicaset roles remove [--config|--custom] [-f] [--timeout secs] <APP>:<INSTANCE> <ROLE_NAME> [flags]
Flags
--auth-type string- authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (defaultauto)--config- to force the centralized config orchestrator--connect-timeout duration- timeout for establishing a binary connection (default1s)--custom- to force a custom orchestrator-f,--force- to force a promotion: * config: skip instances not found locally-G,--global- global config context-g,--group string- name of a target group-i,--instance string- name of a target instance-p,--password string- password for the URI case-r,--replicaset string- name of a target replicaset--scope string- scope the application is looked for in: project, user or system--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 for the URI case--sslkeyfile string- path to a private SSL key file for the URI case--sslpassword string- password for decrypting the private SSL key file for a cluster connection--sslpasswordfile string- path to a file containing the private SSL key password for a cluster connection--template string- template of the application the instances are described in (default "default")--timeout int- adding timeout (default3)-u,--username string- username for the URI case
tt replicaset status¶
Show a replicaset status.
Without a target, the command acts on the project of the current directory, as tt instance does.
The command supports the following Tarantool environment variables:
- TT_CLI_USERNAME - specifies the Tarantool username
- TT_CLI_PASSWORD - specifies the Tarantool password
Usage
tt replicaset status [--config|--custom] [flags] [<APP> | <APP>:<INSTANCE> | <URI>]
The URI can be specified in the following formats:
* [tcp://][username:password@][host:port]
* [unix://][username:password@]socketpath
To specify relative path without `unix://` use `./`.
Flags
--auth-type string- authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (defaultauto)--config- to force the centralized config orchestrator--connect-timeout duration- timeout for establishing a binary connection (default1s)--custom- to force a custom orchestrator-p,--password string- password for the URI case--scope string- scope the application is looked for in: project, user or system--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 for the URI case--sslkeyfile string- path to a private SSL key file for the URI case--sslpassword string- password for decrypting the private SSL key file for a cluster connection--sslpasswordfile string- path to a file containing the private SSL key password for a cluster connection--template string- template of the application the instances are described in (default "default")-u,--username string- username for the URI case
tt replicaset upgrade¶
Upgrade tarantool cluster.
The command supports the following Tarantool environment variables:
- TT_CLI_USERNAME - specifies the Tarantool username
- TT_CLI_PASSWORD - specifies the Tarantool password
Usage
tt replicaset upgrade (<APP> | <URI>) [flags]
The URI can be specified in the following formats:
* [tcp://][username:password@][host:port]
* [unix://][username:password@]socketpath
To specify relative path without `unix://` use `./`.
Flags
--auth-type string- authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (defaultauto)--config- to force the centralized config orchestrator--connect-timeout duration- timeout for establishing a binary connection (default1s)--custom- to force a custom orchestrator-p,--password string- password for the URI case-r,--replicaset stringArray- specify the replicaset name(s) to upgrade--scope string- scope the application is looked for in: project, user or system--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 for the URI case--sslkeyfile string- path to a private SSL key file for the URI case--sslpassword string- password for decrypting the private SSL key file for a cluster connection--sslpasswordfile string- path to a file containing the private SSL key password for a cluster connection--template string- template of the application the instances are described in (default "default")-t,--timeout int- timeout for waiting the LSN synchronization (in seconds) (default5)-u,--username string- username for the URI case
tt replicaset vshard¶
Manage vshard
Usage
tt replicaset vshard
tt replicaset vshard [flags] <command> [command flags]
Aliases: vs.
Commands
tt replicaset vshard bootstrap- Bootstrap vshard in the cluster
tt replicaset vshard bootstrap¶
Bootstrap vshard in the cluster.
Without a target, the command acts on the project of the current directory, as tt instance does.
The command supports the following Tarantool environment variables:
- TT_CLI_USERNAME - specifies the Tarantool username
- TT_CLI_PASSWORD - specifies the Tarantool password
Usage
tt replicaset vshard bootstrap [--config|--custom] [--timeout secs] [flags] [<APP> | <APP>:<INSTANCE> | <URI>]
The URI can be specified in the following formats:
* [tcp://][username:password@][host:port]
* [unix://][username:password@]socketpath
To specify relative path without `unix://` use `./`.
Flags
--auth-type string- authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (defaultauto)--config- to force the centralized config orchestrator--connect-timeout duration- timeout for establishing a binary connection (default1s)--custom- to force a custom orchestrator-p,--password string- password for the URI case--scope string- scope the application is looked for in: project, user or system--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 for the URI case--sslkeyfile string- path to a private SSL key file for the URI case--sslpassword string- password for decrypting the private SSL key file for a cluster connection--sslpasswordfile string- path to a file containing the private SSL key password for a cluster connection--template string- template of the application the instances are described in (default "default")--timeout int- timeout (default10)-u,--username string- username for the URI case