Управление шардами кластера

Статья создана

Улучшена

Обновлена 17 октября 2024 г.

Получить список шардов в кластере
Получить детальную информацию о шарде
Создать шард
Удалить шард
Ребалансировать кластер

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

Важно

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

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

Получить список шардов в кластере

Консоль управления

CLI

API

В консоли управления перейдите в каталог с нужным кластером.
Выберите сервис Managed Service for Redis.
Нажмите на имя нужного кластера, затем выберите вкладку Шарды.

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

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

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

yc managed-redis shards list --cluster-name <имя_кластера>

Результат:

+--------------+
|     NAME     |
+--------------+
| test-shard-1 |
| test-shard-2 |
| test-shard-3 |
+--------------+

Чтобы получить список шардов в кластере, воспользуйтесь методом REST API listShards для ресурса Cluster или вызовом gRPC API ClusterService/ListShards и передайте в запросе идентификатор кластера в параметре clusterId.

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

Получить детальную информацию о шарде

CLI

API

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

Чтобы получить информацию о шарде, выполните команду:

yc managed-redis shards get <имя_шарда> --cluster-name <имя_кластера>

Чтобы получить детальную информацию о шарде, воспользуйтесь методом REST API getShard для ресурса Cluster или вызовом gRPC API ClusterService/GetShard и передайте в запросе:

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

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

Создать шард

Для кластеров с типом диска local-ssd минимально допустимое количество хостов на шард — два.

Консоль управления

CLI

Terraform

API

Чтобы добавить шард:

Перейдите на страницу каталога и выберите сервис Managed Service for Redis.
Нажмите на имя нужного кластера и перейдите на вкладку Шарды.
Нажмите кнопку Создать шард.
Укажите Имя шарда.
В блоке Хосты:
- (Опционально) Отредактируйте настройки хоста.
- Нажмите Добавить хост.
- В поле Зона доступности выберите зону доступности, выберите Подсеть и включите опцию Публичный доступ.
Нажмите кнопку Создать шард.

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

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

yc managed-redis shards add --help

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

yc managed-redis shards add --name=<имя_нового_шарда> \
  --cluster-name=<имя_кластера> \
  --host zone-id=<зона_доступности>,`
    `subnet-name=<имя_подсети>,`
    `assign-public-ip=true \
  --host zone-id=<зона_доступности>,`
    `subnet-name=<имя_подсети>,`
    `replica-priority=50

Чтобы добавить шард:

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

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

Добавьте к описанию кластера Managed Service for Redis нужное количество блоков host с указанием имени шарда в параметре shard_name:

resource "yandex_mdb_redis_cluster" "<имя_кластера>" {
  ...
  host {
    zone             = "<зона_доступности>"
    subnet_id        = <идентификатор_подсети>
    assign_public_ip = <публичный_доступ>
    replica_priority = <приоритет_хоста>
    shard_name       = "<имя_шарда>"
  }
}

Где assign_public_ip — публичный доступ к хосту: true или false.

Проверьте корректность настроек.
1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.
2. Выполните команду:
```
terraform validate
```
  Если в файлах конфигурации есть ошибки, Terraform на них укажет.
Подтвердите изменение ресурсов.
1. Выполните команду для просмотра планируемых изменений:
```
terraform plan
```
  Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.
2. Если вас устраивают планируемые изменения, внесите их:
  1. Выполните команду:
```
terraform apply
```
  2. Подтвердите изменение ресурсов.
  3. Дождитесь завершения операции.

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

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

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

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

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

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

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

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

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

Идентификатор кластера в параметре clusterId.
Имя шарда в параметре shardName.
Конфигурацию хоста для шарда в массиве параметров hostSpecs.

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

Чтобы получить возможность размещать данные в новом шарде, запустите ребалансировку кластера Managed Service for Redis.

Удалить шард

Внимание

Вместе с шардом удаляются все находящиеся в нем хосты.
Если в кластере два или три шарда, то для удаления шарда воспользуйтесь CLI, Terraform или API.

Консоль управления

CLI

Terraform

API

В консоли управления перейдите в каталог с кластером, из которого нужно удалить шард.
Выберите сервис Managed Service for Redis.
Нажмите на имя нужного кластера и выберите вкладку Шарды.
В строке нужного шарда нажмите значок и выберите Удалить.
В открывшемся окне нажмите кнопку Удалить.

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

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

yc managed-redis shards delete <имя_шарда> \
  --cluster-name=<имя_кластера>

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

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

О том, как создать такой файл, см. в разделе Создание кластера.
Удалите из описания кластера Managed Service for Redis все блоки host, которые относятся к шарду.
Проверьте корректность настроек.
1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.
2. Выполните команду:
```
terraform validate
```
  Если в файлах конфигурации есть ошибки, Terraform на них укажет.
Введите слово yes и нажмите Enter.
1. Выполните команду для просмотра планируемых изменений:
```
terraform plan
```
  Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.
2. Если вас устраивают планируемые изменения, внесите их:
  1. Выполните команду:
```
terraform apply
```
  2. Подтвердите изменение ресурсов.
  3. Дождитесь завершения операции.

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

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

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

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

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

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

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

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

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

Идентификатор кластера в параметре clusterId.
Имя удаляемого шарда в параметре shardName.

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

Ребалансировать кластер

Новый шард создается без хеш-слотов и не может принимать данные. Чтобы данные начали размещаться на новом шарде, выполните ребалансировку кластера — эта процедура выделит часть хеш-слотов кластера новому шарду. Данные в переназначенных хеш-слотах будут перемещены в соответствующий шард. Ребалансировка может выполняться на работающем кластере и не влияет на доступность и целостность данных.

Подробнее см. в разделе Масштабирование.

Консоль управления

CLI

API

Чтобы ребалансировать кластер:

В консоли управления перейдите в каталог с нужным кластер.
Выберите сервис Managed Service for Redis.
Нажмите на имя нужного кластера.
На вкладке Обзор нажмите кнопку Ребалансировать.

Совет

Также можно ребалансировать кластер с помощью кнопки Ребалансировать кластер на вкладке Шарды.

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

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

yc managed-redis cluster rebalance \
  --name=<имя_кластера>

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

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

Управление шардами кластера

Получить список шардов в кластереПолучить список шардов в кластере

Получить детальную информацию о шардеПолучить детальную информацию о шарде

Создать шардСоздать шард

Удалить шардУдалить шард

Ребалансировать кластерРебалансировать кластер

Была ли статья полезна?

Получить список шардов в кластере

Получить детальную информацию о шарде

Создать шард

Удалить шард

Ребалансировать кластер