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

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

• wait_config_ready.sh — ждет завершения загрузки конфигурации;
• wait_etcd_ready.sh — дожидается готовности узла etcd-кластера;
• wait_instance_ready.sh — дожидается готовности узла кластера Tarantool DB;
• get_config_master.sh — возвращает адрес мастер-узла в хранилище конфигурации;
• download_java_tarantool.sh — загружает Java-коннектор с сайта tarantool.io.

Утилита wait_config_ready.sh ждет, пока завершится загрузка конфигурации. Если заданное время ожидания в секундах истекло, а конфигурация осталась недоступна, скрипт генерирует ошибку.

 
./wait_config_ready.sh <максимальное_время_ожидания_сек> <адрес_конфигурации>

Пример

 
tools/client/wait_config_ready.sh 25 http://client:secret@tarantool-config-storage-1:3301/tdb

Утилита wait_etcd_ready.sh дожидается готовности узла etcd-кластера. Если заданное время ожидания в секундах истекло, но узел etcd-кластера не поднялся, скрипт генерирует ошибку.

 
./wait_etcd_ready.sh <максимальное_время_ожидания_сек> <строка_подключения> <путь_к_CA> <путь_к_сертификату_клиента> <путь_к_ключу_клиента>

Параметры сертификата и ключа клиента должны быть оба указаны одновременно, иначе они будут проигнорированы.

Примеры

Ожидание готовности etcd без TLS:

 
tools/client/wait_etcd_ready.sh 15 http://192.168.0.20:2379

Ожидание готовности etcd с TLS:

 
tools/client/wait_etcd_ready.sh 15 https://192.168.0.20:2379 /etc/ssl/ca.pem /etc/ssl/client.pem /etc/ssl/client-key.pem

Утилита wait_instance_ready.sh дожидается готовности узла кластера Tarantool DB. Если заданное время ожидания в секундах истекло, но узел не поднялся, скрипт генерирует ошибку.

 
./wait_instance_ready.sh <максимальное_время_ожидания_сек> <строка_подключения>

Для аутентификации укажите учётные данные через переменные окружения:

• TT_CLI_USERNAME — имя пользователя;
• TT_CLI_PASSWORD — пароль.

Для поддержки TLS укажите следующие переменные окружения:

• TT_CLI_SSLCERTFILE — путь к клиентскому TLS-сертификату;
• TT_CLI_SSLKEYFILE — путь к приватному ключу клиента.

Примеры

Ожидание готовности локального экземпляра:

 
tools/client/wait_instance_ready.sh 15 ./var/run/config-storage-1/tarantool.control

Ожидание готовности с TLS и аутентификацией:

 
TT_CLI_USERNAME=admin \TT_CLI_PASSWORD=secret-cluster-cookie \TT_CLI_SSLCERTFILE=/etc/tt/client.pem \TT_CLI_SSLKEYFILE=/etc/tt/client.key \tools/client/wait_instance_ready.sh 15 tarantool-router:3301

Утилита get_config_master.sh возвращает URI мастер-узла в наборе реплик для хранилища конфигурации.

 
source ./get_config_master.sh <адрес_узла>

Здесь:

• адрес_узла — адрес любого узла набора реплик в хранилище конфигурации.

Пример

 
source tools/client/get_config_master.sh client:secret@tarantool-config-storage-1:3301

Утилита 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