Управление приложением Cartridge

 
$ tt cartridge COMMAND {[OPTION ...]|SUBCOMMAND}

Команда tt cartridge используется для управления приложением Cartridge.

COMMAND может принимать одно из следующих значений:

• admin;
• bench;
• failover;
• repair;
• replicasets.

 
$ tt cartridge admin ADMIN_FUNC_NAME [ADMIN_OPTION ...]

Команда tt cartridge admin вызывает административные функции, предоставляемые приложением.

(Обязательный) Имя приложения.

Вывести список доступных административных функций.

Имя экземпляра для подключения.

Адрес для подключения.

Каталог для хранения PID-файлов и файлов сокетов. По умолчанию /var/run/tarantool.

Получение списка доступных административных функций:

 
$ tt cartridge admin --name APPNAME --list   • Available admin functions:probe  Probe instance

Получение справки по конкретной функции:

 
$ tt cartridge admin --name APPNAME probe --help   • Admin function "probe" usage:Probe instanceArgs:  --uri string  Instance URI

Вызов функции с аргументом:

 
$ tt cartridge admin --name APPNAME probe --uri localhost:3301   • Probe "localhost:3301": OK

 
$ tt cartridge bench [BENCH_OPTION ...]

Команда tt cartridge bench запускает тесты производительности для Tarantool.

Адрес экземпляра Tarantool (по умолчанию 127.0.0.1:3301).

Имя пользователя для подключения к экземпляру (по умолчанию guest).

Пароль для подключения к экземпляру.

Количество одновременных подключений (по умолчанию 10).

Количество одновременных запросов на одно подключение (по умолчанию 10).

Длительность теста производительности в секундах (по умолчанию 10).

Размер ключевой части тестовых данных в байтах (по умолчанию 10).

Размер части значения тестовых данных в байтах (по умолчанию 20).

Доля операций вставки в процентах (по умолчанию 100).

Доля операций выборки в процентах.

Доля операций обновления в процентах.

Количество записей для предварительного заполнения спейса (по умолчанию 1000000).

 
$ tt cartridge failover COMMAND [COMMAND_OPTION ...]

Команда tt cartridge failover используется для управления отказоустойчивостью приложения. Доступны следующие команды:

• set;
• setup;
• status;
• disable.

 
$ tt cartridge failover set MODE [FAILOVER_SET_OPTION ...]

Настройка отказоустойчивости в указанном режиме:

• stateful;
• eventual;
• disabled.

Параметры:

• --state-provider STRING: Провайдер состояния для отказоустойчивости. Может принимать значение stateboard или etcd2. Используется только в режиме stateful.
• --params STRING: Параметры отказоустойчивости, заданные в строке формата JSON, например "{'fencing_timeout': 10', 'fencing_enabled': true}".
• --provider-params STRING: Параметры провайдера отказоустойчивости, заданные в строке формата JSON, например "{'lock_delay': 14}".

 
$ tt cartridge failover setup --file STRING

Настройка отказоустойчивости с параметрами, описанными в файле. По умолчанию используется файл конфигурации failover.yml.

Файл failover.yml может выглядеть следующим образом:

 
mode: statefulstate_provider: stateboardstateboard_params:    uri: localhost:4401    password: passwdfailover_timeout: 15

 
$ tt cartridge failover status

Получение текущего статуса отказоустойчивости.

 
$ tt cartridge failover disable

Отключение отказоустойчивости.

Имя приложения. Значение по умолчанию – "package" из rockspec.

Путь к файлу с настройками отказоустойчивости. По умолчанию failover.yml.

 
$ tt cartridge repair COMMAND [REPAIR_OPTION ...]

Команда tt cartridge repair используется для восстановления работающего приложения. Доступны следующие команды:

• list-topology;
• remove-instance;
• set-advertise-uri;
• set-leader.

 
$ tt cartridge repair list-topology [REPAIR_OPTION ...]

Получение сводки текущей топологии кластера.

 
$ tt cartridge repair remove-instance UUID [REPAIR_OPTION ...]

Удаление экземпляра с указанным UUID из кластера. Если экземпляр не найден, возникает ошибка.

 
$ tt cartridge repair set-advertise-uri INSTANCE-UUID NEW-URI [REPAIR_OPTION ...]

Изменение advertise URI экземпляра. Если экземпляр не найден или исключен из кластера, возникает ошибка.

 
$ tt cartridge repair set-leader REPLICASET-UUID INSTANCE-UUID [REPAIR_OPTION ...]

Назначение экземпляра лидером набора реплик. Ошибка возникает в следующих случаях:

• Набор реплик или экземпляр с указанным UUID не существует.
• Экземпляр не принадлежит набору реплик.
• Экземпляр отключен или исключен из кластера.

Следующие параметры работают с любой подкомандой repair:

(Обязательный) Имя приложения.

Каталог, содержащий рабочие каталоги экземпляров. По умолчанию /var/lib/tarantool.

Следующие параметры работают с любой командой repair, кроме list-topology:

Каталог для хранения PID-файлов и файлов сокетов. По умолчанию /var/run/tarantool.

Запуск в режиме dry-run: показать изменения, но не применять их.

Включить перезагрузку конфигурации экземпляра после применения исправлений.

 
$ tt cartridge replicasets COMMAND [COMMAND_OPTION ...]

Команда tt cartridge replicasets используется для управления наборами реплик приложения. Доступны следующие команды:

• setup;
• save;
• list;
• join;
• list-roles;
• list-vshard-groups;
• add-roles;
• remove-roles;
• set-weight;
• set-failover-priority;
• bootstrap-vshard;
• expel.

 
$ tt cartridge replicasets setup [--file FILEPATH] [--bootstrap-vshard]

Настройка наборов реплик с помощью файла.

Параметры:

• --file: Файл с конфигурацией наборов реплик. По умолчанию replicasets.yml.
• --bootstrap-vshard: Выполнить начальную загрузку vshard при настройке.

 
$ tt cartridge replicasets save [--file FILEPATH]

Сохранение текущей конфигурации наборов реплик в файл.

Параметры:

• --file: Файл для сохранения конфигурации. По умолчанию replicasets.yml.

 
$ tt cartridge replicasets list [--replicaset STRING]

Вывод текущей топологии кластера.

Параметры:

• --replicaset STRING: Имя набора реплик.

 
$ tt cartridge replicasets join INSTANCE_NAME ... [--replicaset STRING]

Подключение экземпляра к кластеру. Если набор реплик с указанным псевдонимом не найден в кластере, он создается. В противном случае экземпляры добавляются в существующий набор реплик.

Параметры:

• --replicaset STRING: Имя набора реплик.

 
$ tt cartridge replicasets list-roles

Вывод списка доступных ролей.

 
$ tt cartridge replicasets list-vshard-groups

Вывод списка доступных групп vshard.

 
$ tt cartridge replicasets add-roles ROLE_NAME ... [--replicaset STRING] [--vshard-group STRING]

Добавление ролей к набору реплик.

Параметры:

• --replicaset STRING: Имя набора реплик.
• --vshard-group STRING: Группа vshard для наборов реплик vshard-storage.

 
$ tt cartridge replicasets remove-roles ROLE_NAME ... [--replicaset STRING]

Удаление ролей из набора реплик.

Параметры:

• --replicaset STRING: Имя набора реплик.

 
$ tt cartridge replicasets set-weight WEIGHT [--replicaset STRING]

Установка веса набора реплик.

Параметры:

• --replicaset STRING: Имя набора реплик.

 
$ tt cartridge replicasets set-failover-priority INSTANCE_NAME ... [--replicaset STRING]

Настройка приоритета отказоустойчивости набора реплик.

Параметры:

• --replicaset STRING: Имя набора реплик.

 
$ tt cartridge replicasets bootstrap-vshard

Начальная загрузка vshard.

 
$ tt cartridge replicasets expel INSTANCE_NAME ...

Исключение одного или нескольких экземпляров из кластера.