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

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --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 минут
  }
}

Чтобы изменить класс хостов, воспользуйтесь методом REST API update для ресурса Cluster или вызовом gRPC API ClusterService/Update и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.

• Нужные значения в параметре configSpec.clickhouse.resources.resourcePresetId (для ZooKeeper — configSpec.zookeeper.resources.resourcePresetId).

  Список поддерживаемых значений запрашивайте методом list для ресурсов ResourcePreset.

• Список настроек, которые необходимо изменить, в параметре updateMask.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

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

   yc managed-clickhouse cluster update --help
   

2. Укажите нужный размер хранилища в команде изменения кластера (должен быть не меньше, чем значение disk_size в свойствах кластера):

   yc managed-clickhouse cluster update <имя_или_идентификатор_кластера> \
     --clickhouse-disk-size <размер_хранилища_ГБ>
   

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

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

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

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

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

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

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 минут
  }
}

Чтобы увеличить размер хранилища, воспользуйтесь методом REST API update для ресурса Cluster или вызовом gRPC API ClusterService/Update и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Нужный размер хранилища хостов ClickHouse® в параметре configSpec.clickhouse.resources.diskSize.
• Нужный размер хранилища хостов ZooKeeper в параметре configSpec.zookeeper.resources.diskSize.
• Список полей конфигурации кластера, которые необходимо изменить, в параметре updateMask.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --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 минут
  }
}

Чтобы включить управление пользователями и базами данных через SQL, воспользуйтесь методом REST API update для ресурса Cluster или вызовом gRPC API ClusterService/Update и передайте в запросе нужные значения в параметре configSpec.clickhouse.config:

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

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

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

   yc managed-clickhouse cluster update --help
   

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

   yc managed-clickhouse cluster update <имя_или_идентификатор_кластера> \
      --backup-window-start <время_начала_резервного_копирования> \
      --datalens-access=<true_или_false> \
      --metrika-access=<true_или_false> \
      --serverless-access=<true_или_false> \
      --websql-access=<true_или_false> \
      --yandexquery-access=<true_или_false> \
      --deletion-protection \
      --maintenance-window type=<тип_технического_обслуживания>,`
                          `day=<день_недели>,`
                          `hour=<час_дня>
   

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

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

• --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 — защита кластера, его баз данных и пользователей от непреднамеренного удаления.

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

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

  • anytime (по умолчанию) — в любое время.
  • weekly — по расписанию. При задании этого значения укажите день недели и час дня:
    • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN.
    • hour — час дня по UTC в формате HH: от 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 в формате DDD. Например, MON.
   • hour — час дня по UTC для типа WEEKLY в формате HH. Например, 21.

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 минут
  }
}

Чтобы изменить дополнительные настройки кластера, воспользуйтесь методом REST API update для ресурса Cluster или вызовом gRPC API ClusterService/Update и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.

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

• Настройки окна резервного копирования в параметре configSpec.backupWindowStart.

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

• Настройки защиты от удаления кластера в параметре deletionProtection.

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

• Список изменяемых полей конфигурации кластера в параметре updateMask.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

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

   yc managed-clickhouse cluster move --help
   

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

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

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

Чтобы переместить кластер, воспользуйтесь методом REST API move для ресурса Cluster или вызовом gRPC API ClusterService/Move и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Идентификатор каталога назначения в параметре destinationFolderId.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --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 минут
  }
}

Чтобы изменить группы безопасности, воспользуйтесь методом REST API update для ресурса Cluster или вызовом gRPC API ClusterService/Update и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Список идентификаторов групп безопасности в параметре securityGroupIds.
• Список настроек, которые необходимо изменить, в параметре updateMask.

Чтобы изменить настройки гибридного хранилища, воспользуйтесь методом REST API update для ресурса Cluster или вызовом gRPC API ClusterService/Update и передайте в запросе:

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.

• Значение true в параметре configSpec.cloudStorage.enabled, если гибридное хранилище еще не включено.

  Примечание

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

• Настройки гибридного хранилища в параметрах configSpec.cloudStorage:

  • configSpec.cloudStorage.dataCacheEnabled — разрешает временное хранение файлов в кластерном хранилище. По умолчанию — true (разрешено).
  • configSpec.cloudStorage.dataCacheMaxSize — определяет максимальный объем памяти (в байтах), выделяемый в кластерном хранилище для временного хранения файлов. По умолчанию — 1073741824 (1 ГБ).
  • configSpec.cloudStorage.moveFactor — устанавливает минимальную долю свободного места в кластерном хранилище. Если доля свободного места меньше этого значения, данные переносятся в Yandex Object Storage. Минимальное значение — 0, максимальное — 1, по умолчанию — 0.01.
  • configSpec.cloudStorage.preferNotToMerge — отключает слияние кусков данных в кластерном и объектном хранилищах. Чтобы отключить слияние, укажите значение true. Чтобы оставить слияние включенным, укажите значение false или не передавайте параметр в запросе API при создании кластера.

• Список настроек, которые необходимо изменить, в параметре updateMask.