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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

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

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

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

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

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

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. Дождитесь завершения операции.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

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

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-opensearch/v1/clusters/<идентификатор_кластера>' \
       --data '{
                   "updateMask": "serviceAccountId",
                   "serviceAccountId": "<идентификатор_сервисного_аккаунта>"
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

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

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

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

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "update_mask": {
                   "paths": [
                       "service_account_id"
                   ]
               },
               "service_account_id": "<идентификатор_сервисного_аккаунта>"
           }' \
   mdb.api.yandexcloud.kz:443 \
   yandex.cloud.mdb.opensearch.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • service_account_id — идентификатор сервисного аккаунта, используемого для работы с кластером.

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

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

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

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

  Пароль должен содержать 3 из 4 групп символов:

  • строчные буквы латинского алфавита;
  • заглавные буквы латинского алфавита;
  • цифры;
  • специальные символы.

  Длина пароля — от 10 до 72 символов.

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

  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 из 4 групп символов:

   • строчные буквы латинского алфавита;
   • заглавные буквы латинского алфавита;
   • цифры;
   • специальные символы.

   Длина пароля — от 10 до 72 символов.

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

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

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-opensearch/v1/clusters/<идентификатор_кластера>' \
       --data '{
                   "updateMask": "configSpec.adminPassword",
                   "configSpec": {
                       "adminPassword": "<новый_пароль>"
                   }
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • configSpec.adminPassword — новый пароль пользователя admin.

     Пароль должен содержать 3 из 4 групп символов:

     • строчные буквы латинского алфавита;
     • заглавные буквы латинского алфавита;
     • цифры;
     • специальные символы.

     Длина пароля — от 10 до 72 символов.

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

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

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "update_mask": {
                   "paths": [
                       "config_spec.admin_password"
                   ]
               },
               "config_spec": {
                   "admin_password": "<новый_пароль>"
               }
           }' \
   mdb.api.yandexcloud.kz:443 \
   yandex.cloud.mdb.opensearch.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • config_spec.admin_password — новый пароль пользователя admin.

     Пароль должен содержать 3 из 4 групп символов:

     • строчные буквы латинского алфавита;
     • заглавные буквы латинского алфавита;
     • цифры;
     • специальные символы.

     Длина пароля — от 10 до 72 символов.

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

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

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-opensearch/v1/clusters/<идентификатор_кластера>' \
       --data '{
                   "updateMask": "configSpec.opensearchSpec.opensearchConfig_2.maxClauseCount,configSpec.opensearchSpec.opensearchConfig_2.fielddataCacheSize,configSpec.opensearchSpec.opensearchConfig_2.reindexRemoteWhitelist",
                   "configSpec": {
                       "opensearchSpec": {
                           "opensearchConfig_2": {
                               "maxClauseCount": "<количество_булевых_выражений>",
                               "fielddataCacheSize": "<объем_кучи_JVM>",
                               "reindexRemoteWhitelist": "<адрес_хоста>:9200"
                           }
                       }
                   }
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

   • configSpec.opensearchSpec.opensearchConfig_2 — настройки OpenSearch:

     • maxClauseCount — новое максимально допустимое количество булевых выражений. Подробнее в документации OpenSearch.

     • fielddataCacheSize — новый объем кучи JVM, выделенный для структуры данных fielddata. Можно указать абсолютное значение или проценты, например, 512mb или 50%. Подробнее в документации OpenSearch.

     • reindexRemoteWhitelist — новый список удаленных хостов, из индекса которых нужно скопировать документы для переиндексации. Укажите FQDN хоста и через двоеточие порт 9200. Чтобы указать несколько хостов, перечислите их через запятую, указанную после порта. Подробнее в документации OpenSearch.

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

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

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "update_mask": {
                   "paths": [
                       "config_spec.opensearch_spec.opensearch_config_2.max_clause_count",
                       "config_spec.opensearch_spec.opensearch_config_2.fielddata_cache_size",
                       "config_spec.opensearch_spec.opensearch_config_2.reindex_remote_whitelist"
                   ]
               },
               "config_spec": {
                   "opensearch_spec": {
                       "opensearch_config_2": {
                           "max_clause_count": "<количество_булевых_выражений>",
                           "fielddata_cache_size": "<объем_кучи_JVM>",
                           "reindex_remote_whitelist": "<адрес_хоста>:9200"
                       }
                   }
               }
           }' \
   mdb.api.yandexcloud.kz:443 \
   yandex.cloud.mdb.opensearch.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • config_spec.opensearch_spec.opensearch_config_2 — настройки OpenSearch:

     • max_clause_count — новое максимально допустимое количество булевых выражений. Подробнее в документации OpenSearch.

     • fielddata_cache_size — новый объем кучи JVM, выделенный для структуры данных fielddata. Можно указать абсолютное значение или проценты, например, 512mb или 50%. Подробнее в документации OpenSearch.

     • reindex_remote_whitelist — новый список удаленных хостов, из индекса которых нужно скопировать документы для переиндексации. Укажите FQDN хоста и через двоеточие порт 9200. Чтобы указать несколько хостов, перечислите их через запятую, указанную после порта. Подробнее в документации OpenSearch.

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id. Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.

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

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

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

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

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

  • anytime — в любое время.

  • weekly — по расписанию. Для этого значения дополнительно укажите:

    • weekday — день недели: mon, tue, wed, thu, fry, sat, sun.

    • hour — порядковый номер часового интервала по UTC: от 1 до 24.

      Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

• --deletion-protection — защита кластера от непреднамеренного удаления: true или false.

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

• --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: от 1 до 24.

     Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

   • day — день недели: MON, TUE, WED, THU, FRI, SAT, SUN.

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

   resource "yandex_mdb_opensearch_cluster" "<имя_кластера>" {
       ...
       deletion_protection = <защитить_кластер_от_удаления>
   }
   

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

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

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

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

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

      terraform validate
      

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

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

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

      terraform plan
      

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

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

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

         terraform apply
         

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

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

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

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

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-opensearch/v1/clusters/<идентификатор_кластера>' \
       --data '{
                   "updateMask": "configSpec.access,deletionProtection,maintenanceWindow",
                   "configSpec": {
                       "access": {
                           "dataTransfer": <разрешить_доступ_из_Data_Transfer>,
                           "serverless": <разрешить_доступ_из_Serverless_Containers>
                       }
                   },
                   "deletionProtection": <защитить_кластер_от_удаления>,
                   "maintenanceWindow": {
                       "weeklyMaintenanceWindow": {
                           "day": "<день_недели>",
                           "hour": "<порядковый_номер_часового_интервала>"
                       }
                   }
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

   • access — настройки доступа кластера к следующим сервисам Yandex Cloud:

     • dataTransfer — Yandex Data Transfer;
     • serverless — Yandex Serverless Containers.

     Возможные значения настроек: true или false.

   • deletionProtection — защита кластера от непреднамеренного удаления: true или false.

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

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

     • anytime — в любое время.

     • weeklyMaintenanceWindow — по расписанию. Для этого значения дополнительно укажите:

       • day — день недели: MON, TUE, WED, THU, FRI, SAT или SUN.

       • hour — порядковый номер часового интервала по UTC: от 1 до 24.

         Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

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

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "update_mask": {
                   "paths": [
                       "config_spec.access",
                       "deletion_protection",
                       "maintenance_window"
                   ]
               },
               "config_spec": {
                   "access": {
                       "data_transfer": <разрешить_доступ_из_Data_Transfer>,
                       "serverless": <разрешить_доступ_из_Serverless_Containers>
                   }
               },
               "deletion_protection": <защитить_кластер_от_удаления>,
               "maintenance_window": {
                   "weekly_maintenance_window": {
                       "day": "<день_недели>",
                       "hour": "<порядковый_номер_часового_интервала>"
                   }
               }
           }' \
   mdb.api.yandexcloud.kz:443 \
   yandex.cloud.mdb.opensearch.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • access — настройки доступа кластера к следующим сервисам Yandex Cloud:

     • data_transfer — Yandex Data Transfer;
     • serverless — Yandex Serverless Containers.

     Возможные значения настроек: true или false.

   • deletion_protection — защита кластера от непреднамеренного удаления: true или false.

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

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

     • anytime — в любое время.

     • weekly_maintenance_window — по расписанию. Для этого значения дополнительно укажите:

       • day — день недели: MON, TUE, WED, THU, FRI, SAT или SUN.

       • hour — порядковый номер часового интервала по UTC: от 1 до 24.

         Например, 1 соответствует интервалу с 00:00 до 01:00, 5 — с 04:00 до 05:00.

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --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. Дождитесь завершения операции.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Воспользуйтесь методом Cluster.Update и выполните запрос, например, с помощью cURL:

   Важно

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

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.yandexcloud.kz/managed-opensearch/v1/clusters/<идентификатор_кластера>' \
       --data '{
                   "updateMask": "securityGroupIds",
                   "securityGroupIds": [
                       "<идентификатор_группы_безопасности_1>",
                       "<идентификатор_группы_безопасности_2>",
                       ...
                       "<идентификатор_группы_безопасности_N>"
                   ]
               }'
   

   Где:

   • updateMask — перечень изменяемых параметров в одну строку через запятую.

     В данном случае передается только один параметр.

   • securityGroupIds — идентификаторы групп безопасности.

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

3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

3. Воспользуйтесь вызовом ClusterService.Update и выполните запрос, например, с помощью gRPCurl:

   Важно

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

   Формат перечисления настроек

   "update_mask": {
       "paths": [
           "<настройка_1>",
           "<настройка_2>",
           ...
           "<настройка_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/opensearch/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
               "cluster_id": "<идентификатор_кластера>",
               "update_mask": {
                   "paths": [
                       "security_group_ids"
                   ]
               },
               "security_group_ids": [
                   "<идентификатор_группы_безопасности_1>",
                   "<идентификатор_группы_безопасности_2>",
                   ...
                   "<идентификатор_группы_безопасности_N>"
               ]
           }' \
   mdb.api.yandexcloud.kz:443 \
   yandex.cloud.mdb.opensearch.v1.ClusterService.Update
   

   Где:

   • update_mask — перечень изменяемых параметров в виде массива строк paths[].

     В данном случае передается только один параметр.

   • security_group_ids — идентификаторы групп безопасности.

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

4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.