Управление хостами кластера Redis

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

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

Получить список хостов в кластере
Создать хост
Изменить хост
Удалить хост

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

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

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

CLI

API

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

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

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

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

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

Результат:

+---------------------------------+----------------------+------------+---------+--------+-------------------+
|              NAME               |      CLUSTER ID      | SHARD NAME |  ROLE   | HEALTH |      ZONE ID      |
+---------------------------------+----------------------+------------+---------+--------+-------------------+
| rc1a-...caf.mdb.yandexcloud.net | c9qb2q230gg1******** | shard1     | MASTER  | ALIVE  | ru-central1-a     |
| rc1b-...bgc.mdb.yandexcloud.net | c9qb2q230gg1******** | shard1     | REPLICA | ALIVE  | ru-central1-b     |
+---------------------------------+----------------------+------------+---------+--------+-------------------+

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

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

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

Создать хост

Количество хостов в кластерах Managed Service for Redis ограничено квотами на количество CPU и объем памяти, которые доступны кластерам БД в вашем облаке. Чтобы проверить используемые ресурсы, откройте страницу Квоты и найдите блок Managed Databases.

Примечание

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

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

CLI

Terraform

API

Чтобы создать хост:

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

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

Чтобы создать хост:

Запросите список подсетей кластера, чтобы выбрать подсеть для нового хоста:

yc vpc subnet list

Результат:

+----------------------+-----------+-----------------------+---------------+------------------+
|          ID          |   NAME    |       NETWORK ID      |     ZONE      |      RANGE       |
+----------------------+-----------+-----------------------+---------------+------------------+
| b0cl69a2b4c6******** | default-d | enp6rq72rndgr******** | ru-central1-d | [172.16.0.0/20]  |
| e2lkj9qwe762******** | default-b | enp6rq72rndgr******** | ru-central1-b | [10.10.0.0/16]   |
| e9b0ph42bn96******** | a-2       | enp6rq72rndgr******** | ru-central1-a | [172.16.32.0/20] |
| e9b9v22r88io******** | default-a | enp6rq72rndgr******** | ru-central1-a | [172.16.16.0/20] |
+----------------------+-----------+-----------------------+---------------+------------------+

Если нужной подсети в списке нет, создайте ее.

Посмотрите описание команды CLI для добавления хостов:
```
yc managed-redis host add --help
```
Выполните команду добавления хоста:
```
yc managed-redis host add \
  --cluster-name=<имя_кластера> \
  --host zone-id=<зона_доступности>,`
    `subnet-id=<идентификатор_подсети>,`
    `assign-public-ip=<публичный_доступ>,`
    `replica-priority=<приоритет_хоста>,`
    `shard-name=<имя_шарда>
```
Где:
- --cluster-name — имя кластера Managed Service for Redis. Его можно запросить со списком кластеров в каталоге.
- --host — параметры хоста:
  - zone-id — зона доступности.
  - subnet-id — идентификатор подсети. Необходимо указывать, если в выбранной зоне доступности создано две или больше подсетей.
  - assign-public-ip — доступность хоста из интернета по публичному IP-адресу: true или false.
  - replica-priority — приоритет назначения хоста мастером при выходе из строя основного мастера. Доступен только для нешардированного кластера.
  - shard-name — имя шарда, в котором следует создать хост, если кластер шардированный.

Чтобы создать хост:

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

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

Добавьте к описанию кластера Managed Service for Redis блок host.

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 addHosts для ресурса Cluster или вызовом gRPC API ClusterService/AddHosts и передайте в запросе:

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

Важно

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

Изменить хост

Примечание

Доступ к хостам из интернета через публичные IP-адреса возможен только в том случае, если кластер был создан с включенной поддержкой TLS.

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

CLI

Terraform

API

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

Перейдите на страницу каталога и выберите сервис Managed Service for Redis.
Нажмите на имя нужного кластера и выберите вкладку Хосты.
Нажмите на значок в строке нужного хоста и выберите пункт Редактировать.
Задайте новые настройки для хоста:
1. Включите опцию Публичный доступ, если хост должен быть доступен извне Yandex Cloud.
2. Укажите приоритет назначения хоста мастером.
Нажмите кнопку Сохранить.

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

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

yc managed-redis host update <имя_хоста> \
  --cluster-name=<имя_кластера> \
  --assign-public-ip=<публичный_доступ> \
  --replica-priority=<приоритет_хоста>

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

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

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

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

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

Измените в описании кластера Managed Service for Redis атрибуты блока host, соответствующего изменяемому хосту.

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.

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

Идентификатор кластера, в котором нужно изменить хост, в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
Имя хоста, который нужно изменить, в параметре updateHostSpecs.hostName. Чтобы узнать имя, получите список хостов в кластере.
Настройки публичного доступа к хосту в параметре updateHostSpecs.assignPublicIp.
Приоритет хоста в параметре updateHostSpecs.replicaPriority.
Список изменяемых полей конфигурации кластера в параметре updateMask.

Важно

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

Важно

Удалить хост

Вы можете удалить хост из кластера Redis, если он не является единственным хостом. Чтобы заменить единственный хост, сначала создайте новый хост, а затем удалите старый.

Если хост является мастером в момент удаления, Managed Service for Redis автоматически назначит мастером другую реплику.

Если количество хостов в кластере или в шарде кластера равно минимально допустимому, удалить хост нельзя. См. подробнее в разделе Квоты и лимиты.

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

CLI

Terraform

API

Чтобы удалить хост из кластера:

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

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

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

yc managed-redis host 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 deleteHosts для ресурса Cluster или вызовом gRPC API ClusterService/DeleteHosts и передайте в запросе:

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

Управление хостами кластера Redis

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

Создать хостСоздать хост

Изменить хостИзменить хост

Удалить хостУдалить хост

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

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

Создать хост

Изменить хост

Удалить хост