Изменение настроек кластера OpenSearch

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

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

Чтобы изменить сервисный аккаунт, привязанный к кластеру Managed Service for OpenSearch, выполните команду:

yc managed-opensearch cluster update <имя_или_идентификатор_кластера> \
   --service-account-name <имя_сервисного_аккаунта>

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

Подробнее о настройке сервисного аккаунта см. в разделе Настройка доступа к Object Storage.

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

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

2. Укажите в поле service_account_id идентификатор сервисного аккаунта:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
       ...
       service_account_id = "<идентификатор_сервисного_аккаунта>"
   }
   

   Подробнее о настройке сервисного аккаунта см. в разделе Настройка доступа к Object Storage.

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

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

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

Подробнее о настройке сервисного аккаунта см. в разделе Настройка доступа к Object Storage.

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

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

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

• Ввод пароля открытым текстом (менее безопасный способ).

  yc managed-opensearch cluster update <имя_или_идентификатор_кластера> \
     --admin-password <новый_пароль>
  

• Автоматическая генерация пароля. Сгенерированный пароль будет выведен в консоль.

  yc managed-opensearch cluster update <имя_или_идентификатор_кластера> \
     --generate-admin-password
  

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

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

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

2. Измените в описании кластера значение поля admin_password в блоке config:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
       ...
       config {
           admin_password = "<новый_пароль_пользователя-администратора>"
       }
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

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

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

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

• Идентификатор кластера в параметре clusterId. Чтобы узнать идентификатор, получите список кластеров в каталоге.
• Новое максимально допустимое количество булевых выражений в параметре configSpec.opensearchSpec.opensearchConfig_2.maxClauseCount. Подробнее см. в документации OpenSearch.
• Новый объем кучи JVM, выделенный для структуры данных fielddata, в параметре configSpec.opensearchSpec.opensearchConfig_2.fielddataCacheSize. Можно указать абсолютное значение или проценты, например, 512mb или 50%. Подробнее см. в документации OpenSearch.
• Новый список удаленных хостов, из индекса которых нужно скопировать документы для переиндексации, в параметре configSpec.opensearchSpec.opensearchConfig_2.reindexRemoteWhitelist. Подробнее см. в документации OpenSearch.

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

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

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

yc managed-opensearch cluster update <имя_или_идентификатор_кластера> \
   --maintenance schedule=<тип_технического_обслуживания>,`
                `weekday=<день_недели>,`
                `hour=<час_дня> \
   --delete-protection \
   --data-transfer-access=<true_или_false> \
   --serverless-access=<true_или_false>

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

Настройки в команде:

• --maintenance — настройки времени технического обслуживания (в т. ч. для выключенных кластеров):

  • Чтобы разрешить проведение технического обслуживания в любое время, укажите --maintenance schedule=anytime.

  • Чтобы указать предпочтительное время начала обслуживания, укажите --maintenance schedule=weekly,weekday=<день_недели>,hour=<час_дня_по_UTC>. Тогда техническое обслуживание будет проходить каждую неделю в обозначенный день и время.

    Возможные значения параметра weekday: mon, tue, wed, thu, fry, sat, sun. В параметре hour укажите, во сколько должно завершиться техническое обслуживание. Например, если указать 14, техническое обслуживание будет проходить с 13:00 до 14:00 по UTC.

• --delete-protection — защита кластера от непреднамеренного удаления пользователем.

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

• --serverless-access — доступ из Yandex Serverless Containers: true или false.

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

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

2. Чтобы изменить время технического обслуживания (в т. ч. для выключенных кластеров), укажите настройки в параметре maintenance_window:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
       ...
       maintenance_window {
           type = "<частота_технического_обслуживания>"
           hour = <час_дня>
           day = "<день_недели>"
       }
   }
   

   Укажите в параметрах:

   • type — значение ANYTIME, чтобы разрешить проведение технического обслуживания в любое время, или WEEKLY, чтобы проводить техническое обслуживание каждую неделю.
   • hour — час дня по UTC, когда завершается техническое обслуживание. Например, если указать 14, техническое обслуживание будет проходить с 13:00 до 14:00 по UTC.
   • day — день недели, когда проводится техническое обслуживание. Доступные значения: MON, TUE, WED, THU, FRI, SAT, SUN.

3. Чтобы включить защиту кластера от непреднамеренного удаления пользователем вашего облака, добавьте к описанию кластера поле deletion_protection со значением true:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
       ...
       deletion_protection = <true_или_false>
   }
   

   Где deletion_protection — защита от удаления кластера.

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

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

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

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

• Настройки времени технического обслуживания (в т. ч. для выключенных кластеров) в параметре maintenanceWindow.

• Настройки защиты от удаления кластера в параметре deletionProtection.

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

• Настройки доступа из Yandex Data Transfer в параметре configSpec.access.dataTransfer.

• Настройки доступа из Yandex Serverless Containers в параметре configSpec.access.serverless.

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

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

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

yc managed-opensearch cluster update <имя_или_идентификатор_кластера> \
   --security-group-ids <список_идентификаторов_групп_безопасности>

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

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

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

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

2. В поле security_group_ids перечислите через запятую идентификаторы групп безопасности:

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
       ...
       security_group_ids = [ "<группы_безопасности>" ]
   }
   

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

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

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