Обновление версии ClickHouse®
Вы можете изменить версию ClickHouse®, которую использует кластер, на любую из поддерживаемых Managed Service for ClickHouse® версий, но при этом переход с версии ниже 23.8 на версию 23.8 и выше производится поэтапно. Например, обновление версии Managed Service for ClickHouse® c 22.8 до 24.3 выполняется в такой последовательности: 22.8 → 23.3 → 23.8 → 24.3.
Об обновлениях в рамках одной версии и обслуживании хостов см. в разделе Техническое обслуживание.
Список доступных версий
В консоли управления
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
Чтобы получить список доступных версий, выполните команду:
yc managed-clickhouse version list
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Воспользуйтесь методом Versions.list и выполните запрос, например, с помощью cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/versions'
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Клонируйте репозиторий cloudapi
:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Далее предполагается, что содержимое репозитория находится в директории
~/cloudapi/
. -
Воспользуйтесь вызовом VersionsService/List и выполните запрос, например, с помощью gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/versions_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.clickhouse.v1.VersionsService.List
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
Перед обновлением версии
Убедитесь, что это не нарушит работу ваших приложений:
- Посмотрите в истории изменений
ClickHouse®, как обновления могут повлиять на работу ваших приложений. - Попробуйте обновить версию на тестовом кластере. Его можно развернуть из резервной копии основного кластера. В этом случае восстановятся только таблицы на движке MergeTree.
- Создайте резервную копию основного кластера непосредственно перед обновлением версии.
Обновить версию
- В консоли управления
откройте страницу сервиса Managed Service for ClickHouse в каталоге, где нужно обновить версию ClickHouse®. - В списке кластеров выберите тот, который нужно изменить.
- Нажмите кнопку Редактировать.
- В блоке Базовые параметры в поле Версия выберите нужную версию.
- Нажмите кнопку Сохранить изменения.
После того как изменение версии запущено, кластер переходит в статус UPDATING. Дождитесь окончания операции и проверьте версию кластера.
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name
или --folder-id
.
-
Получите список ваших кластеров ClickHouse® и посмотрите их версии:
yc managed-clickhouse cluster list +----------------------+------+-------------+---------+---------------------+--------+---------+ | ID | NAME | ENVIRONMENT | VERSION | CREATED AT | HEALTH | STATUS | +----------------------+------+-------------+---------+---------------------+--------+---------+ | c9qf1kmm0ebi******** | mych | PRODUCTION | 23.8 | 2024-06-06 10:23:22 | ALIVE | RUNNING | +----------------------+------+-------------+---------+---------------------+--------+---------+
-
Обновите версию ClickHouse® для нужного кластера:
yc managed-clickhouse cluster update --id <идентификатор_кластера> --version <версия_ClickHouse®>
Укажите версию ClickHouse®: 23.8, 24.3, 24.4 или 24.5.
После того как обновление запущено, кластер переходит в статус UPDATING. Дождитесь окончания операции и затем проверьте версию кластера.
-
Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.
О том, как создать такой файл, см. в разделе Создание кластера.
-
Добавьте к описанию кластера Managed Service for ClickHouse® поле
version
или измените его значение, если оно уже существует:resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" { ... version = "<версия_ClickHouse®>" }
Укажите версию ClickHouse®: 23.8, 24.3, 24.4 или 24.5.
-
Проверьте корректность настроек.
-
В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.
-
Выполните команду:
terraform validate
Если в файлах конфигурации есть ошибки, Terraform на них укажет.
-
-
Подтвердите изменение ресурсов.
-
Выполните команду для просмотра планируемых изменений:
terraform plan
Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.
-
Если вас устраивают планируемые изменения, внесите их:
-
Выполните команду:
terraform apply
-
Подтвердите изменение ресурсов.
-
Дождитесь завершения операции.
-
-
Подробнее см. в документации провайдера Terraform
Ограничения по времени
Провайдер Terraform ограничивает время на выполнение операций с кластером Managed Service for ClickHouse®:
- создание, в т. ч. путем восстановления из резервной копии, — 60 минут;
- изменение — 90 минут;
- удаление — 30 минут.
Операции, длящиеся дольше указанного времени, прерываются.
Как изменить эти ограничения?
Добавьте к описанию кластера блок timeouts
, например:
resource "yandex_mdb_clickhouse_cluster" "<имя_кластера>" {
...
timeouts {
create = "1h30m" # Полтора часа
update = "2h" # 2 часа
delete = "30m" # 30 минут
}
}
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Воспользуйтесь методом 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.version", "configSpec": { "version": "<версия_ClickHouse®>" } }'
Где:
-
updateMask
— перечень изменяемых параметров в одну строку через запятую.В данном случае указан только один параметр:
configSpec.version
. -
configSpec.version
— версия ClickHouse®, до которой нужно обновиться: 23.8, 24.3, 24.4 или 24.5.
Идентификатор кластера можно запросить со списком кластеров в каталоге.
-
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>"
-
Клонируйте репозиторий cloudapi
:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Далее предполагается, что содержимое репозитория находится в директории
~/cloudapi/
. -
Воспользуйтесь вызовом 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.version" ] }, "config_spec": { "version": "<версия_ClickHouse®>" } }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
Где:
-
update_mask
— перечень изменяемых параметров в виде массива строкpaths[]
.В данном случае указан только один параметр:
config_spec.version
. -
config_spec.version
— версия ClickHouse®, до которой нужно обновиться: 23.8, 24.3, 24.4 или 24.5.
Идентификатор кластера можно запросить со списком кластеров в каталоге.
-
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
ClickHouse® является зарегистрированным товарным знаком ClickHouse, Inc