Управление группами хостов OpenSearch

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

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

Чтобы получить список групп хостов в кластере, запросите информацию о кластере OpenSearch:

yc managed-opensearch cluster get <имя_или_идентификатор_кластера>

Список групп хостов указан в параметрах config.opensearch.node_groups и config.dashboards.node_groups.

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

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

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

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

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

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

yc managed-opensearch node-group add --cluster-name <имя_кластера> \
   --opensearch-node-group name=<имя_группы_хостов_OpenSearch>,`
                          `resource-preset-id=<класс_хостов>,`
                          `disk-size=<размер_диска_в_байтах>,`
                          `disk-type-id=<тип_диска>,`
                          `hosts-count=<количество_хостов_в_группе>,`
                          `zone-ids=<зоны_доступности>,`
                          `subnet-names=<имена_подсетей>,`
                          `assign-public-ip=<назначить_публичный_адрес:_true_или_false>,`
                          `roles=<роли_хостов> \
   --dashboards-node-group name=<имя_группы_хостов_Dashboards>,`
                          `resource-preset-id=<класс_хостов>,`
                          `disk-size=<размер_диска_в_байтах>,`
                          `disk-type-id=<тип_диска>,`
                          `hosts-count=<количество_хостов_в_группе>,`
                          `zone-ids=<зоны_доступности>,`
                          `subnet-names=<имена_подсетей>,`
                          `assign-public-ip=<назначить_публичный_адрес:_true_или_false>

В команде укажите нужные параметры в зависимости от того, какую группу хостов вы хотите создать:

• --opensearch-node-group — конфигурация группы хостов OpenSearch, где:

  • resource-preset-id — класс хостов. Он определяет технические характеристики виртуальных машин, на которых будут развернуты узлы OpenSearch. Все доступные варианты перечислены в разделе Классы хостов.

  • disk-size — размер диска в байтах. Минимальное и максимальное значения зависят от выбранного класса хостов.

  • disk-type-id — тип диска.

  • roles — роли хостов. Возможные значения:

    • data — предоставляется только роль DATA;
    • manager — предоставляется только роль MANAGER;
    • data+manager или manager+data — предоставляются обе роли.

    Совет

    Не рекомендуется включать публичный доступ для хостов с ролью MANAGER — это небезопасно.

• --dashboards-node-group — конфигурация группы хостов Dashboards. Настраивается так же, как группа хостов OpenSearch, за исключением ролей хостов. Для группы Dashboards роли настраивать не нужно.

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

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

   Полный список доступных для изменения полей конфигурации кластера Managed Service for OpenSearch см. в документации провайдера Terraform.

2. Чтобы создать группу хостов OpenSearch, добавьте блок node_groups в блок opensearch:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
     ...
     config {
       opensearch {
         ...
         node_groups {
           name             = "<имя_группы_виртуальных_хостов>"
           assign_public_ip = <публичный_доступ>
           hosts_count      = <количество_хостов>
           zone_ids         = ["<список_зон_доступности>"]
           subnet_ids       = ["<список_идентификаторов подсетей>"]
           roles            = ["<список_ролей>"]
           resources {
             resource_preset_id = "<класс_хоста>"
             disk_size          = <размер_хранилища_в_байтах>
             disk_type_id       = "<тип_диска>"
           }
         }
       }
       ...
     }
   }
   

   Где:

   • assign_public_ip — публичный доступ к хосту: true или false.
   • roles — роли хостов: DATA и MANAGER.

3. Чтобы создать группу хостов Dashboards, добавьте блок dashboards в блок config:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
     ...
     config {
       ...
       dashboards {
         node_groups {
          name             = "<имя_группы_виртуальных_хостов>"
           assign_public_ip = <публичный_доступ>
           hosts_count      = <количество_хостов>
           zone_ids         = ["<список_зон_доступности>"]
           subnet_ids       = ["<список_идентификаторов подсетей>"]
           resources {
             resource_preset_id = "<класс_хоста>"
             disk_size          = <размер_хранилища_в_байтах>
             disk_type_id       = "<тип_диска>"
           }
         }
       }
     }
   }
   

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

   В кластере может быть только одна группа хостов Dashboards.

4. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

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

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

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

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

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

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

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

Чтобы создать группу хостов OpenSearch, воспользуйтесь методом REST API addOpenSearchNodeGroup для ресурса Cluster или вызовом gRPC API ClusterService/AddOpenSearchNodeGroup.

Чтобы создать группу хостов Dashboards, воспользуйтесь методом REST API addDashboardsNodeGroup для ресурса Cluster или вызовом gRPC API ClusterService/AddDashboardsNodeGroup.

Передайте в запросе конфигурацию группы в блоке nodeGroupSpec:

• Имя группы хостов в параметре name.

• Класс хостов в параметре resources.resourcePresetId.

• Тип диска в параметре resources.diskTypeId.

• Объем хранилища, который будет использоваться для данных, в параметре resources.diskSize.

• Количество хостов в группе в параметре hostsCount.

• Список зон доступности в параметре zoneIds.

• Список подсетей в параметре subnetIds.

• Настройки публичного доступа в параметре assignPublicIp.

• Список ролей хостов в параметре roles (только для группы хостов с типом OpenSearch).

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

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

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

yc managed-opensearch node-group update --cluster-name <имя_кластера> \
   --node-group-name <имя_группы_хостов> \
   --resource-preset-id <класс_хостов> \
   --disk-size <размер_диска_в_байтах> \
   --hosts-count <количество_хостов_в_группе> \
   --roles <роли_хостов>

В команде укажите нужные параметры в зависимости от того, какая конфигурация группы хостов нужна:

• --node-group-name — имя группы хостов, которую нужно изменить.

• --resource-preset-id — новый класс хостов. Он определяет технические характеристики виртуальных машин, на которых будут развернуты узлы OpenSearch. Все доступные варианты перечислены в разделе Классы хостов.

• --disk-size — новый размер диска в байтах. Минимальное и максимальное значения зависят от выбранного класса хостов.

• --hosts-count — новое количество хостов в группе.

• --roles — новые роли хостов. Возможные значения:

  • data — предоставляется только роль DATA;
  • manager — предоставляется только роль MANAGER;
  • data+manager или manager+data — предоставляются обе роли.

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

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

   Полный список доступных для изменения полей конфигурации кластера Managed Service for OpenSearch см. в документации провайдера Terraform.

2. Чтобы изменить конфигурацию группы хостов OpenSearch, измените параметры нужного блока node_groups в блоке opensearch:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
     ...
     opensearch {
       ...
       node_groups {
         name             = "<имя_группы_виртуальных_хостов>"
         assign_public_ip = <публичный_доступ>
         hosts_count      = <количество_хостов>
         roles            = ["<список_ролей>"]
         resources {
           resource_preset_id = "<класс_хоста>"
           disk_size          = <размер_хранилища_в_байтах>
           disk_type_id       = "<тип_диска>"
         }
       }
       ...
     }
   }
   

   Где:

   • assign_public_ip — публичный доступ к хосту: true или false.
   • roles — роли хостов: DATA и MANAGER.

3. Чтобы изменить конфигурацию группы хостов Dashboards, измените параметры блока dashboards:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
     ...
     dashboards {
       node_groups {
         name             = "<имя_группы_виртуальных_хостов>"
         assign_public_ip = <публичный_доступ>
         hosts_count      = <количество_хостов>
         resources {
           resource_preset_id = "<класс_хоста>"
           disk_size          = <размер_хранилища_в_байтах>
           disk_type_id       = "<тип_диска>"
         }
       }
     }
   }
   

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

4. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Подтвердите изменение ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

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

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

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

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

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

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

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

Чтобы изменить конфигурацию группы хостов OpenSearch, воспользуйтесь методом REST API updateOpenSearchNodeGroup для ресурса Cluster или вызовом gRPC API ClusterService/UpdateOpenSearchNodeGroup.

Чтобы изменить конфигурацию группы хостов Dashboards, воспользуйтесь методом REST API updateDashboardsNodeGroup для ресурса Cluster или вызовом gRPC API ClusterService/UpdateDashboardsNodeGroup.

Передайте в запросе новую конфигурацию в блоке nodeGroupSpec:

• Класс хостов в параметре resources.resourcePresetId.
• Тип диска в параметре resources.diskTypeId.
• Объем хранилища, который используется для данных, в параметре resources.diskSize.
• Количество хостов в группе в параметре hostsCount.
• Список ролей хостов в параметре roles (только для группы хостов с типом OpenSearch).

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

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

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

yc managed-opensearch node-group delete --cluster-name <имя_кластера> \
   --node-group-name <имя_группы_хостов>

В команде укажите группу хостов, которую нужно удалить.

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

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

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

   Полный список доступных для изменения полей конфигурации кластера Managed Service for OpenSearch см. в документации провайдера Terraform.

2. Чтобы удалить группу хостов OpenSearch, удалите блок node_groups, который соответствует удаляемой группе хостов, из блока opensearch.

3. Чтобы удалить группу хостов Dashboards, удалите блок dashboards.

4. Проверьте корректность настроек.

   1. В командной строке перейдите в каталог, в котором расположены актуальные конфигурационные файлы Terraform с планом инфраструктуры.

   2. Выполните команду:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

5. Подтвердите удаление ресурсов.

   1. Выполните команду для просмотра планируемых изменений:

      terraform plan
      

      Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

   2. Если вас устраивают планируемые изменения, внесите их:

      1. Выполните команду:

         terraform apply
         

      2. Подтвердите изменение ресурсов.

      3. Дождитесь завершения операции.

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

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

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

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

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

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

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

Чтобы удалить группу хостов OpenSearch, воспользуйтесь методом REST API deleteOpenSearchNodeGroup для ресурса Cluster или вызовом gRPC API ClusterService/DeleteOpenSearchNodeGroup.

Чтобы удалить группу хостов Dashboards, воспользуйтесь методом REST API deleteDashboardsNodeGroup для ресурса Cluster или вызовом gRPC API ClusterService/DeleteDashboardsNodeGroup.

Передайте в запросе:

• Идентификатор кластера в параметре clusterID.

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

• Имя группы хостов, которую вы хотите удалить из кластера, в параметре name.

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

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