Создание, запуск и остановка клики

Примечание

Описанные ниже операции и действия не запускают вычисления, а лишь подготавливают клику к началу работы.

Как создать новую клику

Новую клику можно создать двумя способами:

  1. В главном меню YTsaurus перейдите в раздел Cliques.
  2. В открывшемся разделе CHYT cliques нажмите в правом верхнем углу кнопку Create clique.
  3. Заполните поля формы:
    • Alias name — название клики;

    • Instance count — количество инстансов клики (от 1 до 100);

    • Pool tree — дерево пулов, выберите значение из списка или оставьте значение по умолчанию;

    • Pool — название вычислительного пула, в котором необходимо запускать операцию клики.

      Примечание

      На этапе создания клики эта опция необязательна. Её необходимо задать до запуска клики.

  4. Чтобы завершить создание, нажмите кнопку Confirm.

После подтверждения вы попадёте в интерфейс созданной клики, и она станет доступна в списке клик в разделе CHYT cliques.

  1. Установите CHYT CLI в составе пакета ytsaurus-client, если вы этого ещё не сделали.

  2. Сохраните адрес прокси в переменную окружения. Это нужно, чтобы не указывать кластер YTsaurus в каждой команде через аргумент --proxy.

    export YT_PROXY=<cluster_name>
    
  3. Задайте переменную окружения с адресом контроллера:

    export CHYT_CTL_ADDRESS=<address>
    

    , где <address> — адрес контроллера. Например, для демо-кластера адрес имеет вид: https://strawberry-XXXXXXXX.demo.ytsaurus.tech.
    Адрес контроллера можно получить из поля controller из результата выполнения команды

    yt get //sys/strawberry/chyt/<alias>/@strawberry_info_state
    
  4. Сохраните в переменную окружения имя кластера:

    export CLUSTER_NAME=<cluster_name>
    

    , где <cluster_name> — имя кластера. Например, имя демо-кластера: ytdemo.

  5. Создайте клику с помощью команды из CHYT Controller CLI:

    yt clickhouse ctl create chyt_example_clique
    

Настройка опций для запуска

После создания клики её нужно настроить — задать необходимые опции. Основная опция для запуска клики — это pool, в неё нужно передать название вычислительного пула, где будет запускаться операция с инстансами для клики.

Перед установкой опции pool убедитесь, что у вас есть право Use на указываемый пул. Проверьте свои права на вкладке ACL на Панели вкладок в разделе Object permissions. Если вы не знаете, какой пул использовать, обратитесь к администратору кластера YTsaurus.

Задать опцию pool можно через:

  1. Откройте интерфейс клики, как описано в разделе Как перейти в интерфейс клики.
  2. Нажмите кнопку edit speclet в правом верхнем углу, в блоке Кнопки действий, или Edit speclet на вкладке Speclet на Панели вкладок.
  3. В открывшемся окне настроек, в поле Pool введите название вычислительного пула.
  4. Для завершения нажмите кнопку Confirm.

Примечание

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

  1. Установите CHYT CLI в составе пакета ytsaurus-client, если вы этого ещё не сделали.

  2. Сохраните адрес прокси в переменную окружения. Это нужно, чтобы не указывать кластер YTsaurus в каждой команде через аргумент --proxy.

    export YT_PROXY=<cluster_name>
    
  3. Задайте переменную окружения с адресом контроллера:

    export CHYT_CTL_ADDRESS=<address>
    

    , где <address> — адрес контроллера. Например, для демо-кластера адрес имеет вид: https://strawberry-XXXXXXXX.demo.ytsaurus.tech.
    Адрес контроллера можно получить из поля controller из результата выполнения команды

    yt get //sys/strawberry/chyt/<alias>/@strawberry_info_state
    
  4. Сохраните в переменную окружения имя кластера:

    export CLUSTER_NAME=<cluster_name>
    

    , где <cluster_name> — имя кластера. Например, имя демо-кластера: ytdemo.

  5. Установите опцию с помощью команды:

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

Как запустить клику

Запустить сконфигурированную клику можно через:

  1. Откройте интерфейс клики, как описано в разделе Как перейти в интерфейс клики.

  2. Нажмите кнопку start в правом верхнем углу, в блоке Кнопки действий.

  3. Убедитесь, что:

    • параметр Health перешёл в состояние Pending и через некоторое время сменился на Good,
    • параметр State принял значение Active.

    Посмотреть статусы этих параметров можно в интерфейсе клики — в блоке с характеристиками.

  4. Проверьте работоспособность клики. Для этого сделайте тестовый запрос в интерфейсе Query Tracker:

    • нажмите кнопку sql в правом верхнем углу, в блоке Кнопки действий;
    • в открывшемся окне введите и выполните SQL-запрос.
  1. Установите CHYT CLI в составе пакета ytsaurus-client, если вы этого ещё не сделали.

  2. Сохраните адрес прокси в переменную окружения. Это нужно, чтобы не указывать кластер YTsaurus в каждой команде через аргумент --proxy.

    export YT_PROXY=<cluster_name>
    
  3. Задайте переменную окружения с адресом контроллера:

    export CHYT_CTL_ADDRESS=<address>
    

    , где <address> — адрес контроллера. Например, для демо-кластера адрес имеет вид: https://strawberry-XXXXXXXX.demo.ytsaurus.tech.
    Адрес контроллера можно получить из поля controller из результата выполнения команды

    yt get //sys/strawberry/chyt/<alias>/@strawberry_info_state
    
  4. Сохраните в переменную окружения имя кластера:

    export CLUSTER_NAME=<cluster_name>
    

    , где <cluster_name> — имя кластера. Например, имя демо-кластера: ytdemo.

  5. Запустите клику с помощью команды:

    yt clickhouse ctl start chyt_example_clique
    
  6. Проверьте статус клики с помощью команды 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/<some_hash>";
      }
    
  7. Убедитесь, что клика работает. Для этого сделайте тестовый запрос, например:

    yt clickhouse execute --proxy <cluster_name> --alias chyt_example_clique 'select 42'
    

Важно

Если клика остаётся недоступной более 10 минут, проверьте статус YT-операции:

  • в веб-интерфейсе — по ссылке из параметра YT operation id;
  • в CLI — по ссылке operation_url из вывода команды status.

Если самостоятельно разобраться не удалось, обратитесь за помощью в чат YTsaurus или в ваш персональный канал поддержки.

Как остановить клику

Остановить клику можно через:

  1. Откройте интерфейс клики, как описано в разделе Как перейти в интерфейс клики.

  2. Нажмите кнопку stop в правом верхнем углу, в блоке Кнопки действий.

  3. Убедитесь, что:

    • параметр Health перешёл в состояние Pending и через некоторое время сменился на Failed,
    • параметр State принял значение Inactive.

    Посмотреть статусы этих параметров можно в интерфейсе клики — в блоке с характеристиками.

  1. Установите CHYT CLI в составе пакета ytsaurus-client, если вы этого ещё не сделали.

  2. Сохраните адрес прокси в переменную окружения. Это нужно, чтобы не указывать кластер YTsaurus в каждой команде через аргумент --proxy.

    export YT_PROXY=<cluster_name>
    
  3. Задайте переменную окружения с адресом контроллера:

    export CHYT_CTL_ADDRESS=<address>
    

    , где <address> — адрес контроллера. Например, для демо-кластера адрес имеет вид: https://strawberry-XXXXXXXX.demo.ytsaurus.tech.
    Адрес контроллера можно получить из поля controller из результата выполнения команды

    yt get //sys/strawberry/chyt/<alias>/@strawberry_info_state
    
  4. Сохраните в переменную окружения имя кластера:

    export CLUSTER_NAME=<cluster_name>
    

    , где <cluster_name> — имя кластера. Например, имя демо-кластера: ytdemo.

  5. Остановите клику с помощью команды:

    yt clickhouse ctl stop chyt_example_clique