Клиентские утилиты¶
Клиентские утилиты – набор вспомогательных скриптов, предназначенных для работы с кластером с удалённого сервера. Список доступных скриптов:
bootstrap.sh – применяет топологию кластера и выполняет первоначальный запуск (bootstrap) модуля шардирования vshard;
migrate.sh – выполняет миграции: загружает клиентский код в кластер (описание спейсов, функций);
health_check.sh – проверяет здоровье кластера (health check);
java_make_settings.sh – создает файл конфигурации для загрузки Java-коннектора с сайта tarantool.io.
bootstrap.sh¶
Утилита выполняет настройку топологии кластера.
Описание топологии должно лежать в файле $TARANTOOLDB_BOOTSTRAP_PATH/topology.json.
Скрипт утилиты лежит в файле ./client/utils/bootstrap.sh.
Переменные окружения:
TARANTOOLDB_BOOTSTRAP_PATH– путь к папкеbootstrap. Значение по умолчанию:/bootstrap/.TARANTOOLDB_TARGET_URI– адрес роутера, на который отправляются команды. Значение по умолчанию:localhost:8081;TARANTOOLDB_HEADERS– заголовки запросов к кластеру. Пример:Authorization: Bearer 123.
Пример использования: Запуск кластера через Docker compose.
migrate.sh¶
Утилита загружает клиентский код в кластер, а затем запускает миграции.
Клиентский код лежит в папке $TARANTOOLDB_BOOTSTRAP_PATH/migrations/source.
Скрипт утилиты лежит в файле ./client/utils/migrate.sh.
Переменные окружения:
TARANTOOLDB_BOOTSTRAP_PATH– путь к папкеbootstrap. Значение по умолчанию:/bootstrap/.TARANTOOLDB_TARGET_URI– адрес роутера, на который отправляются команды. Значение по умолчанию:localhost:8081;TARANTOOLDB_HEADERS– заголовки запросов к кластеру. Пример:Authorization: Bearer 123.
Пример использования: Выполнение миграций с удалённой машины.
health_check.sh¶
Утилита выполняет проверку здоровья (health check) всего кластера.
Скрипт предназначен для вызова перед скриптом migrate.sh.
Скрипт утилиты лежит в файле ./client/utils/health_check.sh.
Переменные окружения:
TARANTOOLDB_TARGET_URI– адрес роутера, на который отправляются команды. Значение по умолчанию:localhost:8081.
Пример использования: Запуск кластера через Docker compose.
java_make_settings.sh¶
Утилита генерирует файл конфигурации для загрузки Java-коннектора с сайта tarantool.io.
Инструкция по установке tarantool-java-ee приведена в разделе Установка клиента tarantool-java-ee.
Скрипт утилиты лежит в файле ./client/utils/java_make_settings.sh.
Переменные окружения:
USER_NAME– имя пользователя учётной записи на сайте tarantool.io;PASSWORD– пароль учётной записи на сайте tarantool.io.
Пример
$ USER_NAME=email PASSWORD=password ./java_make_settings.sh