Как запустить приватную клику

Приватная клика — это клика, доступ к которой имеют только определённые пользователи или подразделения.

Условия запуска

Для запуска приватной клики понадобится выделенный вычислительный пул с гарантиями (strong_guarantee_resources) по CPU. Если его нет, следует:

узнать у коллег, можно ли найти вычислительный пул с недоизрасходованными ресурсами;
сделать заказ новых ресурсов на будущее;
запустить клику без гарантий (не рекомендуется).

Порядок запуска

Установить CHYT CLI в составе пакета ytsaurus-client.
Запустить клику. Ниже приведён пример клики из пяти инстансов с настройками по умолчанию (16 ядер на инстанс) в пуле chyt с названием chyt_example_clique.

Заказ CPU квоты

Для поднятия клики с N инстансами на кластере <cluster_name> необходимо:

<cluster_name> <pool_tree_name> <running_operations> — 1 (клика – это одна YTsaurus операция, которая запущена всегда);
<cluster_name> <pool_tree_name> <total_operations> — 1 (должен быть больше либо равен лимиту на количество выполняющихся операций);
<cluster_name> <pool_tree_name> <CPU strong guarantee> — N * 16 (по умолчанию в 1 инстансе 16 ядер CPU).

Чтобы не указывать в каждой команде кластер YTsaurus через аргумент --proxy, первым шагом установите значение по умолчанию через переменную окружения:

export YT_PROXY=<cluster_name>

Далее необходимо создать клику, используя команду из CHYT Controller CLI:

yt clickhouse ctl create chyt_example_clique

После создания клики необходимо её настроить, задать все необходимые опции. Для всех клик есть одна обязательная опция pool, в которой должно быть передано название вычислительного пула, где будет запускаться операция с инстансами для клики. Так как операции для клики запускаются из-под системного робота robot-strawberry-controller, предварительно необходимо выдать право Use на указываемый пул этому роботу.

При установке опции pool убедитесь, что у вас есть право Use на указываемый пул (иначе команда завершится ошибкой):

yt clickhouse ctl set-option pool chyt_example_pool --alias chyt_example_clique

Установите нужное количество инстансов с помощью опции instance_count:

yt clickhouse ctl set-option instance_count 2 --alias chyt_example_clique

Теперь клика настроена и все настройки сохранены в Кипарисе. Осталось запустить сконфигурированную клику:

yt clickhouse ctl start chyt_example_clique

Посмотреть статус клики можно с помощью команды status. Когда операция клики будет запущена, значение поля status должно стать Ok, а operation_state перейдёт в running:

$ yt clickhouse ctl status chyt_example_clique
{
    "status" = "Waiting for restart: oplet does not have running yt operation";
}
# a few moments later
$ yt clickhouse ctl status chyt_example_clique
{
    "status" = "Ok";
    "operation_state" = "running";
    "operation_url" = "https://domain.com/<cluster_name>/operations/48bdec5d-ed641014-3fe03e8-4289d62e";
}

После запуска операции нужно немного подождать, чтобы инстансы клики успели запуститься и начали принимать входящие запросы. Чтобы убедиться, что клика работает, сделайте в ней тестовый запрос к таблице //sys/clickhouse/sample_table — эта таблица доступна на всех кластерах, на которых есть CHYT:

$ yt clickhouse execute --proxy <cluster_name> --alias chyt_example_clique 'select avg(a) from `//sys/clickhouse/sample_table`'
224.30769230769232

Если клика остаётся недоступной более 10 минут, попытайтесь понять, что с кликой не так, перейдя по ссылке operation_url из команды status в веб-интерфейсе операции. Если самостоятельно разобраться не удалось, обратитесь за помощью в чат YTsaurus.