Управление шардами Sharded PostgreSQL
Создать шард
Шарды Sharded PostgreSQL создаются на основе существующих кластеров Yandex Managed Service for PostgreSQL, расположенных в том же каталоге и в той же облачной сети, что и кластер Sharded PostgreSQL.
Важно
Чтобы роутер мог подключаться к хостам шарда, кластер Managed Service for Sharded PostgreSQL и шарды должны находиться в одной группе безопасности, разрешающей входящие и исходящие TCP-подключения на порт 6432.
- В консоли управления
выберите каталог, в котором нужно создать шард. - Перейдите
в сервис Yandex Managed Service for Sharded PostgreSQL. - Нажмите на имя нужного кластера и выберите вкладку Шарды.
- Нажмите кнопку Создать шард.
- Укажите имя шарда и выберите кластер PostgreSQL, хосты которого будут использоваться в качестве хостов с данными в кластере Sharded PostgreSQL.
- Нажмите кнопку Создать.
-
Откройте актуальный конфигурационный файл с описанием кластера Managed Service for Sharded PostgreSQL.
Как создать такой файл, описано в разделе Создание кластера Sharded PostgreSQL.
-
Добавьте описание ресурса:
resource "yandex_mdb_sharded_postgresql_shard" "<имя_шарда>" { cluster_id = "<идентификатор_кластера>" name = "<имя_шарда>" shard_spec = { mdb_postgresql = "<идентификатор_кластера_PostgreSQL>" } }Где:
-
cluster_id— идентификатор кластера, который можно получить со списком кластеров в каталоге. shard_spec.mdb_postgresql— идентификатор кластера Managed Service for PostgreSQL в составе шарда.
Подробнее в документации провайдера Terraform.
Ограничения по времени
Провайдер Terraform ограничивает время на выполнение операций с кластером Managed Service for Sharded PostgreSQL:
- создание, в том числе путем восстановления из резервной копии, — 30 минут;
- изменение — 60 минут;
- удаление — 15 минут.
Операции, длящиеся дольше указанного времени, прерываются.
Как изменить эти ограничения?
Добавьте к описанию кластера блок
timeouts, например:resource "yandex_mdb_sharded_postgresql_cluster" "<имя_кластера>" { ... timeouts { create = "1h30m" # Полтора часа update = "2h" # 2 часа delete = "30m" # 30 минут } } -
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>" -
Воспользуйтесь методом Cluster.AddShard и выполните запрос, например с помощью cURL
:curl \ --request POST \ --header "Authorization: Bearer $IAM_TOKEN" \ --header "Content-Type: application/json" \ --url 'https://mdb.api.cloud.yandex.net/managed-spqr/v1/clusters/<идентификатор_кластера>/shards' \ --data '{ "shardSpec": { "shardName": "<имя_шарда>", "mdbPostgresql": { "clusterId": "<идентификатор_кластера_PostgreSQL>" } } }'Где:
-
<идентификатор_кластера>— идентификатор кластера, который можно получить со списком кластеров в каталоге. mdbPostgresql.clusterId— идентификатор кластера Managed Service for PostgreSQL в составе шарда.
-
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>" -
Клонируйте репозиторий cloudapi
:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiДалее предполагается, что содержимое репозитория находится в директории
~/cloudapi/. -
Воспользуйтесь вызовом ClusterService.AddShard и выполните запрос, например с помощью gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/spqr/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": <идентификатор_кластера> "shard_spec": { "shard_name": "<имя_шарда>", "mdb_postgresql": { "cluster_id": "<идентификатор_кластера_PostgreSQL>" } } }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.spqr.v1.ClusterService.AddShardГде:
-
cluster_id— идентификатор кластера, который можно получить со списком кластеров в каталоге. mdb_postgresql.cluster_id— идентификатор кластера Managed Service for PostgreSQL в составе шарда.
-
Удалить шард
При удалении шарда Sharded PostgreSQL кластер Managed Service for PostgreSQL не удаляется.
- В консоли управления
выберите каталог, в котором нужно удалить шард. - Перейдите
в сервис Yandex Managed Service for Sharded PostgreSQL. - Нажмите на имя нужного кластера и выберите вкладку Шарды.
- Нажмите на значок
в строке нужного шарда и выберите пункт Удалить. - В открывшемся окне нажмите кнопку Удалить.
-
Откройте актуальный конфигурационный файл Terraform с планом инфраструктуры.
Как создать такой файл, описано в разделе Создание кластера Sharded PostgreSQL.
-
Удалите ресурс
yandex_mdb_sharded_postgresql_shardс именем удаляемого шарда. -
Проверьте корректность настроек.
-
В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.
-
Выполните команду:
terraform validateЕсли в файлах конфигурации есть ошибки, Terraform на них укажет.
-
-
Подтвердите изменение ресурсов.
-
Выполните команду для просмотра планируемых изменений:
terraform planЕсли конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.
-
Если вас устраивают планируемые изменения, внесите их:
-
Выполните команду:
terraform apply -
Подтвердите изменение ресурсов.
-
Дождитесь завершения операции.
-
-
Подробнее в документации провайдера Terraform.
Ограничения по времени
Провайдер Terraform ограничивает время на выполнение операций с кластером Managed Service for Sharded PostgreSQL:
- создание, в том числе путем восстановления из резервной копии, — 30 минут;
- изменение — 60 минут;
- удаление — 15 минут.
Операции, длящиеся дольше указанного времени, прерываются.
Как изменить эти ограничения?
Добавьте к описанию кластера блок timeouts, например:
resource "yandex_mdb_sharded_postgresql_cluster" "<имя_кластера>" {
...
timeouts {
create = "1h30m" # Полтора часа
update = "2h" # 2 часа
delete = "30m" # 30 минут
}
}
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>" -
Воспользуйтесь методом Cluster.DeleteShard и выполните запрос, например с помощью cURL
:curl \ --request DELETE \ --header "Authorization: Bearer $IAM_TOKEN" \ --header "Content-Type: application/json" \ --url 'https://mdb.api.cloud.yandex.net/managed-spqr/v1/clusters/<идентификатор_кластера>/shards/<имя_шарда>'Идентификатор кластера можно получить со списком кластеров в каталоге.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
-
Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
export IAM_TOKEN="<IAM-токен>" -
Клонируйте репозиторий cloudapi
:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiДалее предполагается, что содержимое репозитория находится в директории
~/cloudapi/. -
Воспользуйтесь вызовом ClusterService.DeleteShard и выполните запрос, например с помощью gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/spqr/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": <идентификатор_кластера>, "shard_name": "<имя_шарда>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.spqr.v1.ClusterService.DeleteShardИдентификатор кластера можно получить со списком кластеров в каталоге.
-
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.