Skip to content

tt tcm

TCM, the Tarantool Cluster Manager, is the web interface of the clusters of Tarantool Enterprise. Each application has a TCM of its own, a record with kind: tcm in its instances.yaml, which runs as any instance does: tt instance start, stop, restart, status and logs, and tt service systemd. tt tcm init declares it.

Usage

tt tcm
tt tcm [flags] <command> [command flags]

Commands

  • tt tcm init - Declare TCM in the instances.yaml of a template and in the manifest

tt tcm init

Add the record of TCM, kind: tcm, to .templates/<template>/instances.yaml of the project, and require a version of TCM in [platform].tcm of app.manifest.toml, which tt package pack bundles into the package.

The version is --version: a version, which becomes the lowest one allowed, such as >=1.3, or a constraint. Without it [platform].tcm is kept when it is set, and set from the newest TCM tt binary installed otherwise; with none installed the command fails, as only the customer zone of tarantool.io lists the versions of TCM.

A project that has TCM already is left as it is, and the record is reported. A project of Tarantool Community Edition is refused: TCM is Tarantool Enterprise only. In a project without app.manifest.toml only the record is added.

Usage

tt tcm init [flags]

Flags

  • -C, --directory string - work on the project in DIR itself, not on the one the current directory is in
  • --http string - the address TCM listens on, host:port (default 127.0.0.1:8080)
  • --template string - the template whose instances.yaml declares TCM (default default)
  • --version string - the version of TCM, or a constraint, for [platform].tcm

Examples

# Declare TCM in the default template, at its default address.
$ tt tcm init --version 1.3

# Another address, in the template prod.
$ tt tcm init --http 0.0.0.0:8081 --template prod