Клиентские утилиты

Клиентские утилиты — набор вспомогательных скриптов, предназначенных для работы с кластером с удалённого сервера. Список доступных скриптов:

• bootstrap.sh — применяет топологию кластера и выполняет первоначальный запуск (bootstrap) модуля шардирования vshard;
• get_tdb2_config.lua — создает конфигурацию для кластера Tarantool DB 2.x на основе конфигурации Tarantool DB 1.x;
• migrate.sh — выполняет миграции: загружает клиентский код в кластер (описание спейсов, функций);
• health_check.sh — проверяет здоровье кластера (health check);
• download_java_tarantool.sh — загружает Java-коннектор с сайта tarantool.io.

Начиная с версии Tarantool DB 1.1.0, клиентские утилиты хранятся в директории tools/client. До версии 1.1.0 клиентские утилиты лежали в директории client/utils.

Утилита bootstrap.sh выполняет настройку топологии кластера. Описание топологии должно лежать в JSON-файле $TARANTOOLDB_BOOTSTRAP_PATH/TARANTOOLDB_TOPOLOGY_FILENAME. Скрипт утилиты лежит в файле ./tools/client/bootstrap.sh.

Переменные окружения:

• TARANTOOLDB_BOOTSTRAP_PATH — путь к папке bootstrap. Значение по умолчанию: /bootstrap/.
• TARANTOOLDB_TARGET_URI — адрес роутера, на который отправляются команды. Значение по умолчанию: localhost:8081;
• TARANTOOLDB_HEADERS — заголовки запросов к кластеру. Пример: Authorization: Bearer 123;
• TARANTOOLDB_TOPOLOGY_FILENAME — название файла с описанием топологии. Доступно с версии 1.2.0. Значение по умолчанию: topology.json.

Пример использования: Запуск кластера через Docker compose.

Доступно с версии 1.2.1.

Утилита get_tdb2_config.lua конвертирует конфигурацию кластера Tarantool DB 1.x в конфигурацию для Tarantool DB 2.x. Для Tarantool DB 2.x используется конфигурация на основе Tarantool 3.x. Выполняйте скрипт с машины, у которой есть доступ к экземпляру Tarantool.

Пример

 
./tarantool tools/client/get_tdb2_config.lua admin:secret-cluster-cookie@instance_uri:3301 > result_config.yml

Здесь:

• result_config.yml — файл, в который записывается созданная конфигурация Tarantool 3.x.

Утилита migrate.sh загружает клиентский код в кластер, а затем запускает миграции. Клиентский код лежит в папке $TARANTOOLDB_BOOTSTRAP_PATH/migrations/source. Скрипт утилиты лежит в файле ./tools/client/migrate.sh.

Переменные окружения:

• TARANTOOLDB_BOOTSTRAP_PATH — путь к папке bootstrap. Значение по умолчанию: /bootstrap/.
• TARANTOOLDB_TARGET_URI — адрес роутера, на который отправляются команды. Значение по умолчанию: localhost:8081;
• TARANTOOLDB_HEADERS — заголовки запросов к кластеру. Пример: Authorization: Bearer 123.

Пример использования: Выполнение миграций с удалённой машины.

Утилита health_check.sh выполняет проверку здоровья (health check) всего кластера. Скрипт предназначен для вызова перед скриптом migrate.sh. Скрипт утилиты лежит в файле ./tools/client/health_check.sh.

Переменные окружения:

• TARANTOOLDB_TARGET_URI — адрес роутера, на который отправляются команды. Значение по умолчанию: localhost:8081.

Пример использования: Запуск кластера через Docker compose.

Утилита download_java_tarantool.sh загружает Java-коннектор с сайта tarantool.io. Инструкция по установке tarantool-java-ee приведена в разделе Установка клиента tarantool-java-ee. Скрипт утилиты лежит в файле ./tools/client/download_java_tarantool.sh.

Переменные окружения:

• username — имя пользователя учётной записи на сайте tarantool.io;
• password — пароль учётной записи на сайте tarantool.io;
• version — версия Java-коннектора tarantool-java-ee.

Пример

 
$ ./download_java_tarantool.sh username password version