Техническое обслуживание кластера ClickHouse®

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

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

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

Чтобы перенести обслуживание на новую дату и время:

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

   yc managed-clickhouse cluster reschedule-maintenance --help
   

2. Чтобы перенести обслуживание на ближайшее окно, выполните команду, указав тип переноса next-available-window. Чтобы перенести обслуживание на определенную дату и время, укажите тип переноса specific-time:

   yc managed-clickhouse cluster reschedule-maintenance <имя_или_идентификатор_кластера> \
      --reschedule-type <тип_переноса> \
      --delayed-until <временная_метка>
   

   Временная метка должна иметь один из следующих форматов:

   • RFC-3339
   • ЧЧ:ММ:СС
   • количество часов и минут, на которые нужно сдвинуть обслуживание.

   Например: 2006-01-02T15:04:05Z, 15:04:05, 2h или 3h30m ago. При выборе типа переноса next-available-window параметр --delayed-until указывать не нужно.

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

Чтобы перенести обслуживание на новую дату и время:

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

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

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

   curl \
   --request POST \
   --header "Authorization: Bearer $IAM_TOKEN" \
   --header "Content-Type: application/json" \
   --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<идентификатор_кластера>:rescheduleMaintenance' \
   --data '{
               "rescheduleType": <тип_переноса>,
               "delayedUntil": <временная_метка>
           }'
   

   Где rescheduleType — тип переноса, принимает одно из двух значений:

   • NEXT_AVAILABLE_WINDOW — перенести обслуживание на ближайшее окно;
   • SPECIFIC_TIME — перенести обслуживание на определенную дату и время.

   Временная метка должна иметь формат RFC-3339, например: 2006-01-02T15:04:05Z. При выборе типа переноса NEXT_AVAILABLE_WINDOW параметр delayedUntil указывать не нужно.

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

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

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

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

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

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

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

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

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<идентификатор_кластера>",
           "reschedule_type": <тип_переноса>,
           "delayed_until": <временная_метка>
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.ClusterService.RescheduleMaintenance
   

   Где reschedule_type — тип переноса, принимает одно из двух значений:

   • NEXT_AVAILABLE_WINDOW — перенести обслуживание на ближайшее окно;
   • SPECIFIC_TIME — перенести обслуживание на определенную дату и время.

   Временная метка должна иметь формат RFC-3339, например: 2006-01-02T15:04:05Z. При выборе типа переноса NEXT_AVAILABLE_WINDOW параметр delayed_until указывать не нужно.

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

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

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

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

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

Чтобы провести запланированное обслуживание кластера немедленно:

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

   yc managed-clickhouse cluster reschedule-maintenance --help
   

2. Выполните команду, указав тип переноса immediate:

   yc managed-clickhouse cluster reschedule-maintenance <имя_или_идентификатор_кластера> \
      --reschedule-type immediate
   

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

Чтобы провести запланированное обслуживание кластера немедленно:

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

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

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

   curl \
   --request POST \
   --header "Authorization: Bearer $IAM_TOKEN" \
   --header "Content-Type: application/json" \
   --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<идентификатор_кластера>:rescheduleMaintenance' \
   --data '{
               "rescheduleType": "IMMEDIATE"
           }'
   

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

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

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

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

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

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

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

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

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<идентификатор_кластера>",
           "reschedule_type": "IMMEDIATE"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.ClusterService.RescheduleMaintenance
   

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

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

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

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

Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

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

   yc managed-clickhouse cluster update --help
   

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

   yc managed-clickhouse 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 с планом инфраструктуры.

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

   Полный список доступных для изменения полей конфигурации кластера Managed Service for ClickHouse® в документации провайдера Terraform.

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

   resource "yandex_mdb_clickhouse_cluster_v2" "<имя_кластера>" {
     ...
     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.

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

   Ограничения по времени

   Провайдер Terraform ограничивает время на выполнение операций с кластером Managed Service for ClickHouse®:

   • создание, в т. ч. путем восстановления из резервной копии, — 60 минут;
   • изменение — 90 минут;
   • удаление — 30 минут.

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

   Как изменить эти ограничения?

   Добавьте к описанию кластера блок timeouts, например:

   resource "yandex_mdb_clickhouse_cluster_v2" "<имя_кластера>" {
     ...
     timeouts = {
       create = "1h30m" # Полтора часа
       update = "2h"    # 2 часа
       delete = "30m"   # 30 минут
     }
   }
   

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://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<идентификатор_кластера>' \
     --data '{
               "updateMask": "maintenanceWindow",
               "maintenanceWindow": {
                 "weeklyMaintenanceWindow": {
                   "day": "<день_недели>",
                   "hour": "<порядковый_номер_часового_интервала>"
                 }
               }
             }'
   

   Где:

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

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

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

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

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

       • day — день недели в формате DDD: 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/mdb/clickhouse/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": "<порядковый_номер_часового_интервала>"
             }
           }
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Где:

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

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

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

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

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

       • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN;

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

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

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

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