Skip to content

tt cluster

Manage cluster configuration

Usage

tt cluster
tt cluster [flags] <command> [command flags]

Commands

tt cluster failover

Manage supervised failover

Usage

tt cluster failover
tt cluster failover [flags] <command> [command flags]

Aliases: fo.

Commands

tt cluster failover switch

Switch master instance

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

Usage

tt cluster failover switch <URI> <INSTANCE_NAME> [flags]

Flags

  • -p, --password string - password (used as etcd/tarantool config storage credentials)
  • -t, --timeout uint - timeout for command execution (default 30)
  • -u, --username string - username (used as etcd/tarantool config storage credentials)
  • -w, --wait - wait for the command to complete execution

Examples

tt cluster failover switch http://localhost:2379/app instance_name

tt cluster failover switch-status

Show master switching status

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

Usage

tt cluster failover switch-status <URI> <TASK_ID>

tt cluster publish

Publish an application or an instance configuration to a cluster configuration file, to an etcd URI or to a tarantool config storage URI.

An application gets the configuration in the config.yaml of its pair, or in the config storage its config.yaml points to with config.etcd or config.storage. A configuration that drops an instance of the cluster instances.yaml of the application names is refused; the instances its "*" stands for may be dropped.

The configuration is checked before anything is written; then the command asks for a confirmation that names the file or the config storage it writes into, and says what it wrote where once it has. The confirmation is asked on a terminal only: without a terminal on the standard input the command fails unless it is given --yes. --force skips the validation, not the confirmation.

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

By default, the command removes all keys in etcd with prefix '/prefix/config/' and writes the result to '/prefix/config/all'. You could work and update a target key with the 'key' argument.

Usage

tt cluster publish (<APP> | <APP>:<INSTANCE> | <URI>) file [flags]

Flags

  • --force - force publish and skip validation
  • --group string - group name
  • -p, --password string - password (used as etcd credentials only)
  • --replicaset string - replicaset name
  • --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")
  • -u, --username string - username (used as etcd credentials only)
  • -y, --yes - confirm without a prompt, as is needed when the standard input is not a terminal

Examples

tt cluster publish application_name cluster.yaml
tt cluster publish application_name:instance_name instance.yaml
tt cluster publish https://user:pass@localhost:2379/tt cluster.yaml
tt cluster publish https://user:pass@localhost:2379/tt?name=instance instance.yaml
tt cluster publish --group group --replicaset replicaset https://user:pass@localhost:2379/tt?name=instance instance.yaml

tt cluster replicaset

Manage replicasets in the cluster configuration storage

Usage

tt cluster replicaset
tt cluster replicaset [flags] <command> [command flags]

Aliases: rs.

Commands

tt cluster replicaset demote

Demote an instance

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

Usage

tt cluster replicaset demote [-f] [flags] <URI> <INSTANCE_NAME>

Flags

  • -f, --force - skip selecting a key for patching
  • -p, --password string - password (used as etcd/tarantool config storage credentials)
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

tt cluster replicaset expel

Expel an instance

The instance is removed the way the Tarantool documentation removes one from a replicaset, as tt replicaset expel removes it. Stop it first, on its host, with tt instance stop <APP>:<INSTANCE_NAME>: expel does not stop it, and does not connect to it.

The other instances of its replicaset that tt reaches are those of the project tt runs in. They are asked whether they are still connected to it, by an upstream or a downstream in box.info.replication: one that is refuses the expel. Then its entry is deleted from the config in the storage, they 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.

With no other instance of the replicaset reached the expel is refused, as there is nothing to delete the instance from _cluster on. --force expels an instance that is still connected, and, with none reached, removes it from the config alone.

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

Usage

tt cluster replicaset expel [-f] [flags] <URI> <INSTANCE_NAME>

Flags

  • -f, --force - skip selecting a key for patching, and expel an instance still connected to the replicaset or with no other instance of it reached
  • -p, --password string - password (used as etcd/tarantool config storage credentials)
  • --timeout int - seconds to wait for a writable instance to delete the instance from _cluster on (default 3)
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

tt cluster replicaset promote

Promote an instance

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

Usage

tt cluster replicaset promote [-f] [flags] <URI> <INSTANCE_NAME>

Flags

  • -f, --force - skip selecting a key for patching
  • -p, --password string - password (used as etcd/tarantool config storage credentials)
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

tt cluster replicaset roles

Add or remove roles in cluster replicaset

Usage

tt cluster replicaset roles
tt cluster replicaset roles [flags] <command> [command flags]

Commands

tt cluster replicaset roles add

Add role to an instance, group or instance

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

Usage

tt cluster replicaset roles add <URI> <ROLE_NAME> [flags]

Flags

  • -f, --force - skip selecting a key for patching
  • -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 (used as etcd/tarantool config storage credentials)
  • -r, --replicaset string - name of a target replicaset
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

Examples

tt cluster replicaset roles add http://user:pass@localhost:3301 roles.metrics-export --instance_name master

tt cluster replicaset roles remove

Remove role from instance, group, instance or globally

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

Usage

tt cluster replicaset roles remove <URI> <ROLE_NAME> [flags]

Flags

  • -f, --force - skip selecting a key for patching
  • -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 (used as etcd/tarantool config storage credentials)
  • -r, --replicaset string - name of a target replicaset
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

Examples

tt cluster replicaset roles remove http://user:pass@localhost:3301 roles.metrics-export --instance_name master

tt cluster show

Show a cluster configuration for an application, instance, from a cluster configuration file, from etcd URI or from tarantool config storage URI.

The configuration of an application or a file is shown as Tarantool reads it: merged with the TT_* environment variables and with the config storage the file points to with config.etcd or config.storage. A target is a file when it has a slash or ends in .yaml or .yml, such as ./config.yaml or /etc/app/config.yaml:instance_name.

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

Usage

tt cluster show (<APP> | <APP>:<INSTANCE> | <FILE> | <FILE>:<INSTANCE> | <URI>) [flags]

Flags

  • -p, --password string - password (used as etcd credentials only)
  • --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")
  • -u, --username string - username (used as etcd credentials only)
  • --validate - validate the configuration

Examples

tt cluster show application_name
tt cluster show application_name:instance_name
tt cluster show ./config.yaml
tt cluster show ./config.yaml:instance_name
tt cluster show https://user:pass@localhost:2379/tt
tt cluster show https://user:pass@localhost:2379/tt?name=instance

tt cluster topology

Discover and print the current cluster topology by connecting to cluster nodes via net.box.

The cluster configuration can be loaded from a file, etcd, or Tarantool Config Storage. It determines the instances and their listen URIs. Each instance is contacted and the live topology is merged into one view.

<APP> names an application tt runs, found as the instance commands find it, with --scope and --template: the cluster configuration is the one of its pair, and a relative unix socket is taken against the application directory its instances run in. With -c a relative unix socket is taken against the directory of the configuration file.

JSON output contains replicasets keyed by UUID and their instances (instance_uuid, instance_name, hostname, mode, status). If a replicaset is unreachable and its UUID is not configured, its name is used as the key. Unreachable instances have status "not reachable".

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix[?arguments]

  • prefix - a base path to Tarantool configuration in etcd or tarantool config storage.

Possible arguments:

  • key - a target configuration key in the prefix.
  • name - a name of an instance in the cluster configuration.
  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

HTTPS connection behavior:

  • The https:// scheme enables TLS for both etcd and Tarantool Config Storage (TCS), even when no ssl_* URL arguments are specified.
  • For etcd, certificate verification is skipped if neither ssl_ca_file nor ssl_ca_path is specified. A configured CA enables verification unless explicitly disabled.
  • TCS keeps the certificate verification behavior of its TLS backend. The default Go backend uses system CAs unless ssl_ca_file is specified.
  • Do not mix http:// and https:// addresses in an etcd endpoint list. If any endpoint uses https://, TLS is enabled for all endpoints.

Usage

tt cluster topology (<APP> | -c <CLUSTER_CONFIG|URI>) [flags]

Flags

  • --auth-type string - authentication method: auto, chap-sha1 or pap-sha256; pap-sha256 needs TLS and Tarantool EE or CE 3.9+ (default auto)
  • -c, --config string - path or URI of the cluster configuration
  • --connect-timeout duration - timeout for establishing a binary connection (default 1s)
  • --format string - output format: table or json (default table)
  • -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 cluster worker

Manage worker configuration

Usage

tt cluster worker
tt cluster worker [flags] <command> [command flags]

Commands

tt cluster worker delete

Delete a worker configuration

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix/host-name/worker-name[?arguments]

  • prefix - a base path to the worker configuration.
  • host-name - a name of the host.
  • worker-name - a name of the worker.

Possible arguments:

  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

Usage

tt cluster worker delete <URI>

Flags

  • --force - force delete and skip existence check
  • -p, --password string - password (used as etcd/tarantool config storage credentials)
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

Examples

tt cluster worker delete https://user:pass@localhost:2379/tdb-workers/tdb-cluster/host1/http-server-1

tt cluster worker publish

Publish a worker configuration

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix/host-name/worker-name[?arguments]

  • prefix - a base path to the worker configuration.
  • host-name - a name of the host.
  • worker-name - a name of the worker.

Possible arguments:

  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

Usage

tt cluster worker publish <URI> <FILE>

Flags

  • --force - force publish and skip checking existence
  • -p, --password string - password (used as etcd/tarantool config storage credentials)
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

Examples

tt cluster worker publish https://user:pass@localhost:2379/tdb-workers/tdb-cluster/host1/http-server-1 worker.yaml

tt cluster worker show

Show a worker configuration

The URL specifies the etcd or tarantool config storage connection settings in the following format: http(s)://[username:password@]host:port/prefix/host-name/worker-name[?arguments]

  • prefix - a base path to the worker configuration.
  • host-name - a name of the host.
  • worker-name - a name of the worker.

Possible arguments:

  • timeout - a request timeout in seconds (default 3.0).
  • ssl_key_file - a path to a private SSL key file.
  • ssl_cert_file - a path to an SSL certificate file.
  • ssl_ca_file - a path to a trusted certificate authorities (CA) file.
  • ssl_ca_path - a path to a trusted certificate authorities (CA) directory.
  • ssl_ciphers - a list of allowed SSL ciphers.
  • verify_host - set off (default true) verification of the certificate’s name against the host.
  • verify_peer - set off (default true) verification of the peer’s SSL certificate.

The command supports the following environment variables:

  • TT_CLI_USERNAME - specifies the Tarantool username;
  • TT_CLI_PASSWORD - specifies the Tarantool password.
  • TT_CLI_ETCD_USERNAME - specifies the etcd username;
  • TT_CLI_ETCD_PASSWORD - specifies the etcd password.

The priority of credentials: environment variables < command flags < URL credentials.

Usage

tt cluster worker show <URI>

Flags

  • -p, --password string - password (used as etcd/tarantool config storage credentials)
  • -u, --username string - username (used as etcd/tarantool config storage credentials)

Examples

tt cluster worker show https://user:pass@localhost:2379/tdb-workers/tdb-cluster/host1/http-server-1