Изменение настроек кластера ClickHouse®

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

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

Чтобы изменить класс хостов для кластера:

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

   yc managed-clickhouse cluster update --help
   

2. Запросите список доступных классов хостов (в колонке ZONE IDS указаны зоны доступности, в которых можно выбрать соответствующий класс):

   yc managed-clickhouse resource-preset list
   
   +-----------+--------------------------------+-------+----------+
   |    ID     |            ZONE IDS            | CORES |  MEMORY  |
   +-----------+--------------------------------+-------+----------+
   | s1.micro  | ru-central1-a, ru-central1-b,  |     2 | 8.0 GB   |
   |           | ru-central1-d                  |       |          |
   | ...                                                           |
   +-----------+--------------------------------+-------+----------+
   

3. Укажите нужный класс в команде изменения кластера:

   yc managed-clickhouse cluster update <имя_или_идентификатор_кластера> \
      --clickhouse-resource-preset=<идентификатор_класса>
   

   Managed Service for ClickHouse® запустит операцию изменения класса хостов для кластера.

4. Чтобы изменить класс хостов ZooKeeper, передайте нужное значение в параметре --zookeeper-resource-preset.

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

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

2. Измените в описании кластера Managed Service for ClickHouse® значение параметра resource_preset_id в блоках clickhouse.resources и zookeeper.resources для хостов ClickHouse® и ZooKeeper соответственно:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     ...
     clickhouse {
       resources {
         resource_preset_id = "<класс_хостов_ClickHouse®>"
         ...
       }
     }
     zookeeper {
       resources {
         resource_preset_id = "<класс_хостов_ZooKeeper>"
         ...
       }
     }
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

Подробнее см. в документации провайдера Terraform.

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

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

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

2. Запросите список доступных классов хостов:

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

      curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/resourcePresets'
      

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

3. Измените класс хостов на нужный:

   1. Воспользуйтесь методом 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": "configSpec.clickhouse.resources.resourcePresetId,configSpec.zookeeper.resources.resourcePresetId",
                    "configSpec": {
                      "clickhouse": {
                        "resources": {
                          "resourcePresetId": "<идентификатор_класса_хостов_ClickHouse®>"
                        }
                      },
                      "zookeeper": {
                        "resources": {
                          "resourcePresetId": "<идентификатор_класса_хостов_ZooKeeper>"
                        }
                      }
                    }
                  }'
      

      Где:

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

        Укажите нужные параметры:

        • configSpec.clickhouse.resources.resourcePresetId — если нужно изменить класс хостов ClickHouse®.
        • configSpec.zookeeper.resources.resourcePresetId — если нужно изменить класс хостов ZooKeeper.

        В примере запроса класс хостов изменяется и для хостов ClickHouse®, и для хостов ZooKeeper.

      • configSpec.clickhouse.resources.resourcePresetId — идентификатор класса хостов ClickHouse®.

      • configSpec.zookeeper.resources.resourcePresetId — идентификатор класса хостов ZooKeeper.

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

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

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

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

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

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

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

3. Запросите список доступных классов хостов:

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

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/resource_preset_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.clickhouse.v1.ResourcePresetService.List
      

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

4. Измените класс хостов на нужный:

   1. Воспользуйтесь вызовом 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": [
                    "config_spec.clickhouse.resources.resource_preset_id",
                    "config_spec.zookeeper.resources.resource_preset_id"
                  ]
                },
                "config_spec": {
                  "clickhouse": {
                    "resources": {
                      "resource_preset_id": "<идентификатор_класса_хостов_ClickHouse®>"
                    }
                  },
                  "zookeeper": {
                    "resources": {
                      "resource_preset_id": "<идентификатор_класса_хостов_ZooKeeper>"
                    }
                  }
                }
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
      

      Где:

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

        Укажите нужные параметры:

        • config_spec.clickhouse.resources.resource_preset_id — если нужно изменить класс хостов ClickHouse®.
        • config_spec.zookeeper.resources.resource_preset_id — если нужно изменить класс хостов ZooKeeper.

        В примере запроса класс хостов изменяется и для хостов ClickHouse®, и для хостов ZooKeeper.

      • config_spec.clickhouse.resources.resource_preset_id — идентификатор класса хостов ClickHouse®.

      • config_spec.zookeeper.resources.resource_preset_id — идентификатор класса хостов ZooKeeper.

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

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

Если у вас еще нет интерфейса командной строки 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 <имя_или_идентификатор_кластера> \
     --clickhouse-disk-size <размер_хранилища_ГБ> \
     --clickhouse-disk-type <тип_диска>
   

   Новый размер хранилища должен быть не меньше, чем значение disk_size в свойствах кластера.

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

3. Чтобы изменить тип диска и увеличить размер хранилища хостов ZooKeeper, передайте нужные значения в параметре --zookeeper-disk-size.

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

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

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

2. Измените в описании кластера Managed Service for ClickHouse® значения параметров disk_size и disk_type_id в блоках clickhouse.resources и zookeeper.resources для хостов ClickHouse® и ZooKeeper соответственно:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     ...
     clickhouse {
       resources {
         disk_size = <размер_хранилища_ГБ>
         disk_type_id = "<тип_диска>"
         ...
       }
     }
     zookeeper {
       resources {
         disk_size = <размер_хранилища_ГБ>
         disk_type_id = "<тип_диска>"
         ...
       }
     }
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
  ...
  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": "configSpec.clickhouse.resources.diskSize,configSpec.clickhouse.resources.diskTypeId,configSpec.zookeeper.resources.diskSize,configSpec.zookeeper.resources.diskTypeId",
                 "configSpec": {
                   "clickhouse": {
                     "resources": {
                       "diskSize": "<размер_хранилища_в_байтах>",
                       "diskTypeId": "<тип_диска>"
                     }
                   },
                   "zookeeper": {
                     "resources": {
                       "diskSize": "<размер_хранилища_в_байтах>",
                       "diskTypeId": "<тип_диска>"
                     }
                   }
                 }
               }'
   

   Где:

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

     Укажите нужные параметры:

     • configSpec.clickhouse.resources.diskSize,configSpec.clickhouse.resources.diskTypeId — если нужно изменить тип диска и увеличить размер хранилища хостов ClickHouse®.
     • configSpec.zookeeper.resources.diskSize,configSpec.zookeeper.resources.diskTypeId — если нужно изменить тип диска и увеличить размер хранилища хостов ZooKeeper.

     В примере запроса размер хранилища и тип диска изменяются и для хостов ClickHouse®, и для хостов ZooKeeper.

   • configSpec.clickhouse.resources.diskSize — размер хранилища хостов ClickHouse® в байтах.

   • configSpec.clickhouse.resources.diskTypeId — тип диска хостов ClickHouse®.

   • configSpec.zookeeper.resources.diskSize — размер хранилища хостов ZooKeeper в байтах.

   • configSpec.zookeeper.resources.diskTypeId — тип диска хостов ZooKeeper.

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

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": [
                 "config_spec.clickhouse.resources.disk_size",
                 "config_spec.clickhouse.resources.disk_type_id",
                 "config_spec.zookeeper.resources.disk_size",
                 "config_spec.zookeeper.resources.disk_type_id"
               ]
             },
             "config_spec": {
               "clickhouse": {
                 "resources": {
                   "disk_size": "<размер_хранилища_в_байтах>",
                   "disk_type_id": "<тип_диска>"
                 }
               },
               "zookeeper": {
                 "resources": {
                   "disk_size": "<размер_хранилища_в_байтах>",
                   "disk_type_id": "<тип_диска>"
                 }
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Где:

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

     Укажите нужные параметры:

     • config_spec.clickhouse.resources.disk_size — если нужно увеличить размер хранилища хостов ClickHouse®.
     • config_spec.clickhouse.resources.disk_type_id — если нужно изменить тип диска хостов ClickHouse®.
     • config_spec.zookeeper.resources.disk_size — если нужно увеличить размер хранилища хостов ZooKeeper.
     • config_spec.zookeeper.resources.disk_type_id — если нужно изменить тип диска хостов ZooKeeper.

     В примере запроса размер хранилища и тип диска изменяются и для хостов ClickHouse®, и для хостов ZooKeeper.

   • config_spec.clickhouse.resources.disk_size — размер хранилища хостов ClickHouse® в байтах.

   • config_spec.clickhouse.resources.disk_type_id — тип диска хостов ClickHouse®.

   • config_spec.zookeeper.resources.disk_size — размер хранилища хостов ZooKeeper в байтах.

   • config_spec.zookeeper.resources.disk_type_id — тип диска хостов ZooKeeper.

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

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

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

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

1. Чтобы включить режим управления пользователями через SQL:

   • задайте значение true для параметра --enable-sql-user-management;
   • задайте пароль для пользователя admin в параметре --admin-password.

   yc managed-clickhouse cluster update <имя_или_идентификатор_кластера> \
      ...
      --enable-sql-user-management true \
      --admin-password "<пароль_пользователя_admin>"
   

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

   • задайте значение true для параметров --enable-sql-user-management и --enable-sql-database-management;
   • задайте пароль для пользователя admin в параметре --admin-password.

   yc managed-clickhouse cluster update <имя_или_идентификатор_кластера> \
      ...
      --enable-sql-user-management true \
      --enable-sql-database-management true \
      --admin-password "<пароль_пользователя_admin>"
   

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

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

2. Чтобы включить режим управления пользователями через SQL, добавьте к описанию кластера поле sql_user_management со значением true и поле admin_password с паролем пользователя admin:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     name                = "<имя_кластера>"
     ...
     admin_password      = "<пароль_пользователя_admin>"
     sql_user_management = true
     ...
   }
   

3. Чтобы включить режим управления базами данных через SQL, добавьте к описанию кластера поля sql_user_management и sql_database_management со значением true, а также поле admin_password с паролем пользователя admin:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     name                    = "<имя_кластера>"
     ...
     admin_password          = "<пароль_пользователя_admin>"
     sql_database_management = true
     sql_user_management     = true
     ...
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
  ...
  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": "configSpec.adminPassword,configSpec.sqlUserManagement,configSpec.sqlDatabaseManagement",
                 "configSpec": {
                   "adminPassword": "<пароль_пользователя_admin>",
                   "sqlUserManagement": <управление_пользователями_через_SQL>,
                   "sqlDatabaseManagement": <управление_базами_данных_через_SQL>
                 }
               }'
   

   Где:

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

     Укажите нужные параметры:

     • configSpec.adminPassword — пароль пользователя admin, с помощью которого осуществляется управление.
     • configSpec.sqlUserManagement — если нужно включить управление пользователями через SQL.
     • configSpec.sqlDatabaseManagement — если нужно включить управление базами данных через SQL.

     В примере запроса включается и управление пользователями, и управление базами данных черех SQL.

   • configSpec.adminPassword — пароль пользователя admin.

   • configSpec.sqlUserManagement — режим управления пользователями через SQL: true или false.

   • configSpec.sqlDatabaseManagement — режим управления базами данных через SQL: true или false. Необходимо, чтобы был включен режим управления пользователями через SQL.

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

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": [
                 "config_spec.admin_password",
                 "config_spec.sql_user_management",
                 "config_spec.sql_database_management"
               ]
             },
             "config_spec": {
               "admin_password": "<пароль_пользователя_admin>",
               "sql_user_management": <управление_пользователями_через_SQL>,
               "sql_database_management": <управление_базами_данных_через_SQL>
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Где:

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

     Укажите нужные параметры:

     • config_spec.admin_password — пароль пользователя admin, с помощью которого осуществляется управление.
     • config_spec.sql_user_management — если нужно включить управление пользователями через SQL.
     • config_spec.sql_database_management — если нужно включить управление базами данных через SQL.

     В примере запроса включается и управление пользователями, и управление базами данных черех SQL.

   • config_spec.admin_password — пароль пользователя admin.

   • config_spec.sql_user_management — режим управления пользователями через SQL: true или false.

   • config_spec.sql_database_management — режим управления базами данных через SQL: true или false. Необходимо, чтобы был включен режим управления пользователями через SQL.

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

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 <имя_или_идентификатор_кластера> \
      --backup-window-start <время_начала_резервного_копирования> \
      --backup-retain-period-days <срок_хранения_автоматических_резервных_копий> \
      --datalens-access=<true_или_false> \
      --metrika-access=<true_или_false> \
      --serverless-access=<true_или_false> \
      --websql-access=<true_или_false> \
      --yandexquery-access=<true_или_false> \
      --deletion-protection \
      --disk-size-autoscaling clickhouse-disk-size-limit=<максимальный_размер_хранилища_ГБ>,`
                             `clickhouse-planned-usage-threshold=<порог_для_планового_увеличения_в_процентах>,`
                             `clickhouse-emergency-usage-threshold=<порог_для_незамедлительного_увеличения_в_процентах>,`
                             `zookeeper-disk-size-limit=<максимальный_размер_хранилища_ГБ>,`
                             `zookeeper-planned-usage-threshold=<порог_для_планового_увеличения_в_процентах>,`
                             `zookeeper-emergency-usage-threshold=<порог_для_незамедлительного_увеличения_в_процентах> \
      --maintenance-window type=<тип_технического_обслуживания>,`
                          `day=<день_недели>,`
                          `hour=<час_дня>
   

Вы можете изменить следующие настройки:

• --backup-window-start — время начала резервного копирования кластера, задается по UTC в формате HH:MM:SS. Если время не задано, резервное копирование начнется в 22:00 UTC.

• --backup-retain-period-days – срок хранения автоматических резервных копий (в днях).

• --datalens-access — разрешает доступ из DataLens. Значение по умолчанию — false. Подробнее о настройке подключения см. в разделе Подключение из DataLens.

• --metrika-access — разрешает импорт данных из AppMetrika в кластер. Значение по умолчанию — false.

• --serverless-access — разрешает доступ к кластеру из сервиса Yandex Cloud Functions. Значение по умолчанию — false. Подробнее о настройке доступа см. в документации Cloud Functions.

• --websql-access — разрешает выполнять SQL-запросы к базам данных кластера из консоли управления Yandex Cloud с помощью сервиса Yandex WebSQL. Значение по умолчанию — false.

• --yandexquery-access=true — разрешает доступ к кластеру из сервиса Yandex Query. Функциональность находится на стадии Preview. Значение по умолчанию — false.

• --deletion-protection — защита кластера от непреднамеренного удаления: true или false.

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

• --disk-size-autoscaling — настройки автоматического увеличения размера хранилища:

  • clickhouse-disk-size-limit — максимальный размер хранилища ClickHouse®, в гигабайтах.

  • clickhouse-planned-usage-threshold — порог заполнения хранилища ClickHouse® в процентах, при достижении которого оно будет увеличено в следующее окно обслуживания. По умолчанию — 0 (автоматическое увеличение отключено).

    Допустимые значения: от 0 до 100.

  • clickhouse-emergency-usage-threshold — порог заполнения хранилища ClickHouse® в процентах, при достижении которого оно будет увеличено незамедлительно. По умолчанию — 0 (автоматическое увеличение отключено).

    Допустимые значения: от 0 до 100.

  • zookeeper-disk-size-limit — максимальный размер хранилища ZooKeeper, в гигабайтах.

  • zookeeper-planned-usage-threshold — порог заполнения хранилища ZooKeeper в процентах, при достижении которого оно будет увеличено в следующее окно обслуживания. По умолчанию — 0 (автоматическое увеличение отключено).

    Допустимые значения: от 0 до 100.

  • zookeeper-emergency-usage-threshold — порог заполнения хранилища ZooKeeper в процентах, при достижении которого оно будет увеличено незамедлительно. По умолчанию — 0 (автоматическое увеличение отключено).

    Допустимые значения: от 0 до 100.

  Важно

  • Если заданы оба порога для ClickHouse®, значение clickhouse-emergency-usage-threshold должно быть не меньше clickhouse-planned-usage-threshold.

  • Если заданы оба порога для ZooKeeper, значение zookeeper-emergency-usage-threshold должно быть не меньше zookeeper-planned-usage-threshold.

  • При использовании параметров clickhouse-planned-usage-threshold и zookeeper-planned-usage-threshold необходимо настроить окно технического обслуживания.

  Настройки автоматического увеличения размера хранилища, заданные для ClickHouse®, применяются ко всем существующим шардам. При добавлении нового шарда значения настройки берутся с самого старого шарда. Эти значения не сохраняются в конфигурации ClickHouse® и не отображаются при выводе команды yc managed-clickhouse cluster get.

  Чтобы посмотреть информацию о конкретном шарде, включая настройки автоматического увеличения размера хранилища, используйте команду:

  yc managed-clickhouse shards get <имя_шарда> --cluster-id <идентификатор_кластера>
  

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

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

• --maintenance-window — настройки времени технического обслуживания (в т. ч. для выключенных кластеров), где type — тип технического обслуживания:

  • anytime (по умолчанию) — в любое время.
  • weekly — по расписанию. Для этого значения дополнительно укажите:
    • day — день недели: MON, TUE, WED, THU, FRI, SAT или SUN.
    • hour — час дня по UTC: от 1 до 24.

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

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

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

2. Чтобы изменить время начала резервного копирования, добавьте к описанию кластера Managed Service for ClickHouse® блок backup_window_start.

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     ...
     backup_window_start {
       hours   = <час_начала_резервного_копирования>
       minutes = <минута_начала_резервного_копирования>
     }
     ...
   }
   

3. Чтобы разрешить доступ к кластеру из других сервисов и выполнение SQL-запросов из консоли управления с помощью Yandex WebSQL, измените значения соответствующих полей в блоке access:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     ...
     access {
       data_lens    = <доступ_из_DataLens>
       metrika      = <доступ_из_Метрики_и_AppMetrika>
       serverless   = <доступ_из_Cloud_Functions>
       web_sql      = <выполнение_SQL-запросов_из_консоли_управления>
       yandex_query = <доступ_из_Yandex_Query>
     }
     ...
   }
   

   Где:

   • data_lens — доступ из DataLens: true или false.

   • metrika — доступ из Метрики и AppMetrika: true или false.

   • serverless — доступ из Cloud Functions: true или false.

   • yandex_query — доступ из Yandex Query: true или false.

   • web_sql — выполнение SQL-запросов из консоли управления: true или false.

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

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

   Где:

   • type — тип технического обслуживания. Принимает значения:
     • ANYTIME — в любое время.
     • WEEKLY — по расписанию.
   • day — день недели для типа WEEKLY: MON, TUE, WED, THU, FRI, SAT или SUN.
   • hour — час дня по UTC для типа WEEKLY: от 1 до 24.

5. Чтобы включить защиту кластера от непреднамеренного удаления пользователем вашего облака, добавьте к описанию кластера поле deletion_protection со значением true:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     ...
     deletion_protection = <защита_кластера_от_удаления>
   }
   

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

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

Подробнее см. в документации провайдера Terraform.

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

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

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

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

   Важно

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

   1. Создайте файл body.json и добавьте в него следующее содержимое:

      {
        "updateMask": "<перечень_изменяемых_настроек>",
        "configSpec": {
          "backupWindowStart": {
            "hours": "<часы>",
            "minutes": "<минуты>",
            "seconds": "<секунды>",
            "nanos": "<наносекунды>"
          },
          "clickhouse": {
            "diskSizeAutoscaling": {
              "plannedUsageThreshold": "<порог_для_планового_увеличения_в_процентах>",
              "emergencyUsageThreshold": "<порог_для_незамедлительного_увеличения_в_процентах>",
              "diskSizeLimit": "<максимальный_размер_хранилища_в_байтах>"
            }
          },
          "zookeeper": {
            "diskSizeAutoscaling": {
              "plannedUsageThreshold": "<порог_для_планового_увеличения_в_процентах>",
              "emergencyUsageThreshold": "<порог_для_незамедлительного_увеличения_в_процентах>",
              "diskSizeLimit": "<максимальный_размер_хранилища_в_байтах>"
            }
          },
          "access": {
            "dataLens": <доступ_из_DataLens>,
            "webSql": <выполнение_SQL-запросов>,
            "metrika": <импорт_данных_из_AppMetrica>,
            "serverless": <доступ_из_Yandex Cloud Functions>,
            "dataTransfer": <доступ_из_Yandex Data Transfer>,
            "yandexQuery": <доступ_из_Yandex Query>
          }    
        },
        "maintenanceWindow": {
          "anytime": {},
          "weeklyMaintenanceWindow": {
            "day": "<день_недели>",
            "hour": "<час_дня_по_UTC>"
          }
        },
        "deletionProtection": <защита_кластера_от_удаления>
      }
      

      Где:

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

      • configSpec.backupWindowStart — время начала резервного копирования (UTC):

        • hours — часы в 24-часовом формате.
        • minutes — минуты.
        • seconds — секунды.
        • nanos — наносекунды.

      • configSpec.access — настройки, которые разрешают доступ к кластеру из других сервисов и выполнение SQL-запросов из консоли управления с помощью Yandex WebSQL:

        • dataLens — разрешить доступ из DataLens: true или false. Значение по умолчанию — false. Подробнее о настройке подключения см. в разделе Подключение из DataLens.

        • webSql — разрешить выполнять SQL-запросы к базам данных кластера из консоли управления Yandex Cloud с помощью сервиса Yandex WebSQL: true или false. Значение по умолчанию — false.

        • metrika — разрешить импорт данных из AppMetrika в кластер: true или false. Значение по умолчанию — false.

        • serverless — разрешить доступ к кластеру из сервиса Yandex Cloud Functions: true или false. Значение по умолчанию — false. Подробнее о настройке доступа см. в документации Cloud Functions.

        • dataTransfer — разрешить доступ к кластеру из сервиса Yandex Data Transfer в Serverless-режиме: true или false. Значение по умолчанию — false.

          Это позволит через специальную сеть подключаться к Yandex Data Transfer, запущенному в Kubernetes. В результате будут быстрее выполняться, например, запуск и деактивация трансфера.

        • yandexQuery — разрешить доступ к кластеру из сервиса Yandex Query: true или false. Функциональность находится на стадии Preview. Значение по умолчанию — false.

      • configSpec.clickhouse.diskSizeAutoscaling — настройки автоматического увеличения размера хранилища ClickHouse®:

        • plannedUsageThreshold — порог заполнения хранилища ClickHouse® в процентах, при достижении которого оно будет увеличено в следующее окно обслуживания. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • emergencyUsageThreshold — порог заполнения хранилища ClickHouse® в процентах, при достижении которого оно будет увеличено незамедлительно. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • diskSizeLimit — максимальный размер хранилища ClickHouse®, в байтах.

        Важно

        • Если заданы оба порога, значение emergencyUsageThreshold должно быть не меньше plannedUsageThreshold.

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

        Настройки автоматического увеличения размера хранилища, заданные для ClickHouse®, применяются ко всем существующим шардам. При добавлении нового шарда значения настройки берутся с самого старого шарда. Эти значения не сохраняются в конфигурации ClickHouse®.

        Чтобы посмотреть информацию о конкретном шарде, включая настройки автоматического увеличения размера хранилища, воспользуйтесь методом Cluster.GetShard и передайте в запросе идентификатор кластера и имя шарда.

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

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

      • configSpec.zookeeper.diskSizeAutoscaling — настройки автоматического увеличения размера хранилища ZooKeeper:

        • plannedUsageThreshold — порог заполнения хранилища ZooKeeper в процентах, при достижении которого оно будет увеличено в следующее окно обслуживания. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • emergencyUsageThreshold — порог заполнения хранилища ZooKeeper в процентах, при достижении которого оно будет увеличено незамедлительно. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • diskSizeLimit — максимальный размер хранилища ZooKeeper, в байтах.

        Важно

        • Если заданы оба порога, значение emergencyUsageThreshold должно быть не меньше plannedUsageThreshold.

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

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

        • anytime — (по умолчанию) — в любое время.
        • weeklyMaintenanceWindow — по расписанию:
          • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN.
          • hour — час дня по UTC в формате HH: от 1 до 24.

      • deletionProtection — защита кластера от непреднамеренного удаления: true или false. Значение по умолчанию — false.

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

   2. Выполните запрос:

      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 '@body.json'
      

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

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>"
       ]
   }
   

   1. Создайте файл body.json и добавьте в него следующее содержимое:

      {
        "cluster_id": "<идентификатор_кластера>",
        "update_mask": {
          "paths": [
            <перечень_изменяемых_настроек>
          ]
        },
        "config_spec": {
          "backup_window_start": {
            "hours": "<часы>",
            "minutes": "<минуты>",
            "seconds": "<секунды>",
            "nanos": "<наносекунды>"
          },
          "clickhouse": {
            "disk_size_autoscaling": {
              "planned_usage_threshold": "<порог_для_планового_увеличения_в_процентах>",
              "emergency_usage_threshold": "<порог_для_незамедлительного_увеличения_в_процентах>",
              "disk_size_limit": "<максимальный_размер_хранилища_в_байтах>"
            }
          },
          "zookeeper": {
            "disk_size_autoscaling": {
              "planned_usage_threshold": "<порог_для_планового_увеличения_в_процентах>",
              "emergency_usage_threshold": "<порог_для_незамедлительного_увеличения_в_процентах>",
              "disk_size_limit": "<максимальный_размер_хранилища_в_байтах>"
            }
          },
          "access": {
            "data_lens": <доступ_из_DataLens>,
            "web_sql": <выполнение_SQL-запросов>,
            "metrika": <импорт_данных_из_AppMetrica>,
            "serverless": <доступ_из_Yandex Cloud Functions>,
            "data_transfer": <доступ_из_Yandex Data Transfer>,
            "yandex_query": <доступ_из_Yandex Query>
          }
        },
        "maintenance_window": {
          "anytime": {},
          "weekly_maintenance_window": {
            "day": "<день_недели>",
            "hour": "<час_дня_по_UTC>"
          }
        },
        "deletion_protection": <защита_кластера_от_удаления>
      }
      

      Где:

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

      • config_spec.backup_window_start — время начала резервного копирования (UTC):

        • hours — часы в 24-часовом формате.
        • minutes — минуты.
        • seconds — секунды.
        • nanos — наносекунды.

      • config_spec.access — настройки, которые разрешают доступ к кластеру из других сервисов и выполнение SQL-запросов из консоли управления с помощью Yandex WebSQL:

        • data_lens — разрешить доступ из DataLens: true или false. Значение по умолчанию — false. Подробнее о настройке подключения см. в разделе Подключение из DataLens.

        • web_sql — разрешить выполнять SQL-запросы к базам данных кластера из консоли управления Yandex Cloud с помощью сервиса Yandex WebSQL: true или false. Значение по умолчанию — false.

        • metrika — разрешить импорт данных из AppMetrika в кластер: true или false. Значение по умолчанию — false.

        • serverless — разрешить доступ к кластеру из сервиса Yandex Cloud Functions: true или false. Значение по умолчанию — false. Подробнее о настройке доступа см. в документации Cloud Functions.

        • data_transfer — разрешить доступ к кластеру из сервиса Yandex Data Transfer в Serverless-режиме: true или false. Значение по умолчанию — false.

          Это позволит через специальную сеть подключаться к Yandex Data Transfer, запущенному в Kubernetes. В результате будут быстрее выполняться, например, запуск и деактивация трансфера.

        • yandex_query — разрешить доступ к кластеру из сервиса Yandex Query: true или false. Функциональность находится на стадии Preview. Значение по умолчанию — false.

      • config_spec.clickhouse.disk_size_autoscaling — настройки автоматического увеличения размера хранилища ClickHouse®:

        • planned_usage_threshold — порог заполнения хранилища ClickHouse® в процентах, при достижении которого оно будет увеличено в следующее окно обслуживания. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • emergency_usage_threshold — порог заполнения хранилища ClickHouse® в процентах, при достижении которого оно будет увеличено незамедлительно. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • disk_size_limit — максимальный размер хранилища ClickHouse®, в байтах.

        Важно

        • Если заданы оба порога, значение emergency_usage_threshold должно быть не меньше planned_usage_threshold.

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

        Настройки автоматического увеличения размера хранилища, заданные для ClickHouse®, применяются ко всем существующим шардам. При добавлении нового шарда значения настройки берутся с самого старого шарда. Эти значения не сохраняются в конфигурации ClickHouse®.

        Чтобы посмотреть информацию о конкретном шарде, включая настройки автоматического увеличения размера хранилища, воспользуйтесь методом ClusterService.GetShard и передайте в запросе идентификатор кластера и имя шарда.

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

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

      • config_spec.zookeeper.disk_size_autoscaling — настройки автоматического увеличения размера хранилища ZooKeeper:

        • planned_usage_threshold — порог заполнения хранилища ZooKeeper в процентах, при достижении которого оно будет увеличено в следующее окно обслуживания. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • emergency_usage_threshold — порог заполнения хранилища ZooKeeper в процентах, при достижении которого оно будет увеличено незамедлительно. По умолчанию — 0 (автоматическое увеличение отключено).

          Допустимые значения: от 0 до 100.

        • disk_size_limit — максимальный размер хранилища ZooKeeper, в байтах.

        Важно

        • Если заданы оба порога, значение emergency_usage_threshold должно быть не меньше planned_usage_threshold.

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

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

        • anytime — (по умолчанию) — в любое время.
        • weekly_maintenance_window — по расписанию:
          • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN.
          • hour — час дня по UTC в формате HH: от 1 до 24.

      • deletion_protection — защита кластера от непреднамеренного удаления: true или false. Значение по умолчанию — false.

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

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

   2. Выполните запрос:

      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 @ \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.clickhouse.v1.ClusterService.Update \
        < body.json
      

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

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

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

Чтобы переместить кластер:

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

   yc managed-clickhouse cluster move --help
   

2. Укажите каталог назначения в команде перемещения кластера:

   yc managed-clickhouse cluster move <имя_или_идентификатор_кластера> \
      --destination-folder-name=<имя_каталога_назначения>
   

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

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

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

2. Измените или добавьте в описании кластера Managed Service for ClickHouse® значение параметра folder_id:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     ...
     folder_id = "<идентификатор_каталога_назначения>"
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

Подробнее см. в документации провайдера Terraform.

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

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

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

2. Воспользуйтесь методом Cluster.Move и выполните запрос, например с помощью 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/<идентификатор_кластера>:move' \
       --data '{
                 "destinationFolderId": "<идентификатор_каталога_назначения>"
               }'
   

   Где destinationFolderId — идентификатор каталога назначения, в который нужно переместить кластер. Этот идентификатор можно запросить со списком каталогов в облаке.

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

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

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

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

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

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

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

3. Воспользуйтесь вызовом ClusterService.Move и выполните запрос, например с помощью 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": "<идентификатор_кластера>",
             "destination_folder_id": "<идентификатор_каталога_назначения>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Move
   

   Где destination_folder_id — идентификатор каталога назначения, в который нужно переместить кластер. Этот идентификатор можно запросить со списком каталогов в облаке.

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

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 <имя_кластера> \
      --security-group-ids <список_идентификаторов_групп_безопасности>
   

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

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

2. Измените значение параметра security_group_ids в описании кластера:

   resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
     ...
     security_group_ids = [ <список_идентификаторов_групп_безопасности_кластера> ]
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

Подробнее см. в документации провайдера Terraform.

resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
  ...
  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": "securityGroupIds",
                 "securityGroupIds": [
                   <список_идентификаторов_групп_безопасности>
                 ]
               }'
   

   Где:

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

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

   • securityGroupIds — массив строк. Каждая строка — идентификатор группы безопасности.

     Важно

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

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

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

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": [
                 "security_group_ids"
               ]
             },
             "security_group_ids": [
               <список_идентификаторов_групп_безопасности>
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Где:

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

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

   • security_group_ids — массив строк. Каждая строка — идентификатор группы безопасности.

     Важно

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

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

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

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

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": "<перечень_изменяемых_настроек>",
                 "configSpec": {
                   "cloudStorage": {
                     "enabled": <использование_гибридного_хранилища>,
                     "moveFactor": "<доля_свободного_места>",
                     "dataCacheEnabled": <временное_хранение_файлов>,
                     "dataCacheMaxSize": "<максимальный_объем_памяти_для_хранения_файлов>",
                     "preferNotToMerge": <отключение_слияния_кусков_данных>
                   }
                 }
               }'
   

   Где:

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

   • configSpec.cloudStorage — настройки гибридного хранилища:

     • enabled — включить гибридное хранилище в кластере, если оно выключено: true или false. Значение по умолчанию — false (выключено).

       Примечание

       Включенное однажды гибридное хранилище нельзя отключить.

     • moveFactor — минимальная доля свободного места в кластерном хранилище. Если доля свободного места меньше этого значения, данные переносятся в Yandex Object Storage.

       Минимальное значение — 0, максимальное — 1, по умолчанию — 0.01.

     • dataCacheEnabled — разрешить временное хранение файлов в кластерном хранилище: true или false.

       По умолчанию — true (разрешено).

     • dataCacheMaxSize — максимальный объем памяти (в байтах), выделяемый в кластерном хранилище для временного хранения файлов.

       По умолчанию — 1073741824 (1 ГБ).

     • preferNotToMerge — отключить слияние кусков данных в кластерном и объектном хранилищах: true или false.

       Чтобы отключить слияние, укажите значение true. Чтобы оставить слияние включенным, укажите значение false.

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

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": [
                 <перечень_изменяемых_настроек>
               ]
             },
             "config_spec": {
               "cloud_storage": {
                 "enabled": <использование_гибридного_хранилища>,
                 "move_factor": "<доля_свободного_места>",
                 "data_cache_enabled": <временное_хранение_файлов>,
                 "data_cache_max_size": "<максимальный_объем_памяти_для_хранения_файлов>",
                 "prefer_not_to_merge": <отключение_слияния_кусков_данных>
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Где:

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

   • config_spec.cloud_storage — настройки гибридного хранилища:

     • enabled — включить гибридное хранилище в кластере, если оно выключено: true или false. Значение по умолчанию — false (выключено).

       Примечание

       Включенное однажды гибридное хранилище нельзя отключить.

     • move_factor — минимальная доля свободного места в кластерном хранилище. Если доля свободного места меньше этого значения, данные переносятся в Yandex Object Storage.

       Минимальное значение — 0, максимальное — 1, по умолчанию — 0.01.

     • data_cache_enabled — разрешить временное хранение файлов в кластерном хранилище: true или false.

       По умолчанию — true (разрешено).

     • data_cache_max_size — максимальный объем памяти (в байтах), выделяемый в кластерном хранилище для временного хранения файлов.

       По умолчанию — 1073741824 (1 ГБ).

     • prefer_not_to_merge — отключить слияние кусков данных в кластерном и объектном хранилищах: true или false.

       Чтобы отключить слияние, укажите значение true. Чтобы оставить слияние включенным, укажите значение false.

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

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