Техническое обслуживание кластера Yandex Managed Service for Apache Airflow™

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

1. Посмотрите описание команды CLI для изменения окна обслуживания:

   yc managed-airflow cluster update --help
   

2. Выполните команду:

   yc managed-airflow cluster update <имя_или_идентификатор_кластера> \
       --maintenance-window type=<тип_технического_обслуживания>,`
                           `day=<день_недели>,`
                           `hour=<порядковый_номер_часового_интервала>
   

   Где type — тип технического обслуживания:

   • anytime (по умолчанию) — в любое время.
   • weekly — по расписанию. Для этого значения дополнительно укажите:

     • day — день недели: MON, TUE, WED, THU, FRI, SAT или SUN.

     • hour — порядковый номер часового интервала по UTC: от 1 до 24.

       Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

   Имя и идентификатор кластера можно получить со списком кластеров в каталоге.

1. Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.

   Инструкция по созданию файла описана в разделе Создание кластера.

2. Чтобы настроить время технического обслуживания, добавьте к описанию кластера блок maintenance_window:

   resource "yandex_airflow_cluster" "<имя_кластера>" {
     ...
     maintenance_window = {
       type = "<тип_технического_обслуживания>"
       day  = "<день_недели>"
       hour = <порядковый_номер_часового_интервала>
     }
     ...
   }
   

   Где:

   • type — тип технического обслуживания. Принимает значения:

     • ANYTIME — в любое время.
     • WEEKLY — по расписанию.

   • day — день недели для типа WEEKLY: MON, TUE, WED, THU, FRI, SAT или SUN.

   • hour — порядковый номер часового интервала по UTC для типа WEEKLY: от 1 до 24.

     Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

3. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

4. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

1. Получите IAM-токен для аутентификации в API и поместите его в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например с помощью cURL:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре updateMask (одной строкой через запятую).

   curl \
     --request PATCH \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters/<идентификатор_кластера>' \
     --data '{
               "updateMask": "maintenanceWindow",
               "maintenanceWindow": {
                 "weeklyMaintenanceWindow": {
                   "day": "<день_недели>",
                   "hour": "<порядковый_номер_часового_интервала>"
                 }
               }
             }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • maintenanceWindow — настройки времени технического обслуживания (в т. ч. для выключенных кластеров). Передайте один из двух параметров:

     • anytime — техническое обслуживание проводится в произвольное время.

     • weeklyMaintenanceWindow — техническое обслуживание проводится раз в неделю в указанное время:

       • day — день недели: MON, TUE, WED, THU, FRI, SAT или SUN;

       • hour — порядковый номер часового интервала по UTC: от 1 до 24.

         Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите его в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например с помощью gRPCurl:

   Важно

   Метод API переопределит все параметры изменяемого объекта, которые не были явно переданы в запросе, на значения по умолчанию. Чтобы избежать этого, перечислите настройки, которые вы хотите изменить, в параметре update_mask (в виде массива строк paths[]).

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/airflow/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<идентификатор_кластера>",
           "update_mask": {
             "paths": ["maintenance_window"]
           },
           "maintenance_window": {
             "weekly_maintenance_window": {
               "day": "<день_недели>",
               "hour": "<порядковый_номер_часового_интервала>"
             }
           }
         }' \
     airflow.api.cloud.yandex.net:443 \
     yandex.cloud.airflow.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • maintenance_window — настройки времени технического обслуживания (в т. ч. для выключенных кластеров). Передайте один из двух параметров:

     • anytime — техническое обслуживание проводится в произвольное время.

     • weekly_maintenance_window — техническое обслуживание проводится раз в неделю в указанное время:

       • day — день недели: MON, TUE, WED, THU, FRI, SAT или SUN;

       • hour — порядковый номер часового интервала по UTC: от 1 до 24.

         Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

   Идентификатор кластера можно запросить со списком кластеров в каталоге.

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.