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

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

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

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

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-elasticsearch cluster update --help
   

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

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

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

Managed Service for Elasticsearch запустит операцию изменения сервисного аккаунта для кластера.

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

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

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

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

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

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

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

      terraform validate
      

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

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

   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 минут
     }
   }
   

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

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

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

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

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

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

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

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-elasticsearch cluster update --help
   

2. Укажите нужный класс для хостов с ролью Data node и Master node в команде изменения кластера:

   yc managed-elasticsearch cluster update <имя_или_идентификатор_кластера> \
     --datanode-resource-preset <класс_хостов_с_ролью_Data_node> \
     --masternode-resource-preset <класс_хостов_с_ролью_Master_node>
   

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

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

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

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

2. Измените в описании кластера Managed Service for Elasticsearch значение атрибута resource_preset_id в блоке config.data_node.resources или config.master_node.resources:

   resource "yandex_mdb_elasticsearch_cluster" "<имя_кластера>" {
     ...
     config {
       data_node {
         resources {
           resource_preset_id = "<класс_хоста>"
           ...
         }
       }
   
       master_node {
         resources {
           resource_preset_id = "<класс_хоста>"
           ...
         }
       }
     }
   }
   

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

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

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

      terraform validate
      

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

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

   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 минут
     }
   }
   

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

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

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

• Класс хостов в параметрах:

  • configSpec.elasticsearchSpec.dataNode.resources.resourcePresetId — для хостов с ролью Data node.
  • configSpec.elasticsearchSpec.masterNode.resources.resourcePresetId — для хостов с ролью Master node.

  Список поддерживаемых значений запрашивайте методом list для ресурсов ResourcePreset.

• Список настроек, которые необходимо изменить, в параметре updateMask.

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

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

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

1. Посмотрите описание команды CLI для изменения конфигурации:

   yc managed-elasticsearch cluster update --help
   

2. Укажите новые параметры хранилища для хостов с ролью Data node и Master node в команде изменения кластера:

   yc managed-elasticsearch cluster update <имя_или_идентификатор_кластера> \
     --datanode-disk-size <размер_хранилища_ГБ_Data_node> \
     --masternode-disk-size <размер_хранилища_ГБ_Master_node>
   

   Где:

   • --datanode-disk-size — размер хранилища в гигабайтах для хостов с ролью Data node.
   • --masternode-disk-size — размер хранилища в гигабайтах для хостов с ролью Master node.

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

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

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

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

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

2. Измените в описании кластера Managed Service for Elasticsearch значение атрибута disk_size в блоке config.data_node.resources или config.master_node.resources:

   resource "yandex_mdb_elasticsearch_cluster" "<имя_кластера>" {
     ...
     config {
       data_node {
         resources {
           disk_size = <размер_хранилища_ГБ>
           ...
         }
       }
   
       master_node {
         resources {
           disk_size = <размер_хранилища_ГБ>
           ...
         }
       }
     }
   }
   

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

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

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

      terraform validate
      

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

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

   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 минут
     }
   }
   

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

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

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

• Необходимый размер хранилища (в байтах) в параметрах:

  • configSpec.elasticsearchSpec.dataNode.resources.diskSize — для хостов с ролью Data node.
  • configSpec.elasticsearchSpec.masterNode.resources.diskSize — для хостов с ролью Master node.

• Список настроек, которые необходимо изменить, в параметре updateMask.

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

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

Чтобы изменить настройки сервера Elasticsearch:

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

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

2. Посмотрите описание команды CLI для изменения конфигурации кластера:

   yc managed-elasticsearch cluster update-config --help
   

3. Установите нужные значения параметров:

   yc managed-elasticsearch cluster update-config <имя_или_идентификатор_кластера> \
      --set <имя_параметра_1>=<значение_1>,<имя_параметра_2>=<значение_2>,...
   

   Все поддерживаемые параметры приведены в разделе Настройки Elasticsearch.

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

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

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

• Нужные значения настроек СУБД в параметре configSpec.elasticsearchSpec.dataNode.elastcsearchConfig_7.

• Список настроек, которые необходимо изменить, в параметре updateMask. Если не задать этот параметр, метод API сбросит на значения по умолчанию все настройки кластера, которые не были явно указаны в запросе.

Все поддерживаемые настройки описаны в разделе Настройки Elasticsearch и в справочнике API.

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

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

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

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-elasticsearch cluster update --help
   

2. Укажите новый пароль в команде изменения кластера одним из возможных способов:

   • Ввод пароля в интерактивном режиме.

     yc managed-elasticsearch cluster update <имя_кластера> \
       --read-admin-password
     

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

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

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

     yc managed-elasticsearch cluster update <имя_кластера> \
       --generate-admin-password
     

Managed Service for Elasticsearch запустит операцию изменения пароля admin для кластера.

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

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

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

2. Измените в описании кластера Managed Service for Elasticsearch значение атрибута admin_password в блоке config:

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

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

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

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

      terraform validate
      

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

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

   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 минут
     }
   }
   

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

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

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

• Новый пароль в параметре configSpec.adminPassword. Длина пароля — до 128 символов.

• Список настроек, которые необходимо изменить (в данном случае — configSpec.adminPassword), в параметре updateMask.

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

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

1. Посмотрите описание команды CLI для изменения кластера:

   yc managed-elasticsearch cluster update --help
   

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

   yc managed-elasticsearch cluster update <имя_или_идентификатор_кластера> \
      --plugins <имя_плагина_1>,...,<имя_плагина_N> \
      --maintenance-window type=<тип_технического_обслуживания>,`
                          `day=<день_недели>,`
                          `hour=<час_дня> \
      --deletion-protection=<защита_от_удаления>
   

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

• --plugins — список плагинов Elasticsearch, доступных в кластере. При этом плагины, не упомянутые в списке, будут выключены.

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

  • anytime (по умолчанию) — в любое время.
  • weekly — по расписанию. При задании этого значения укажите день недели и час дня:
    • day — день недели в формате DDD: MON, TUE, WED, THU, FRI, SAT или SUN.
    • hour — час дня по UTC в формате HH: от 1 до 24.

• --deletion-protection — защита кластера, его баз данных и пользователей от непреднамеренного удаления.

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

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

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

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

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

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

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

   Где:

   • type — тип технического обслуживания. Принимает значения:
     • ANYTIME — в любое время.
     • WEEKLY — по расписанию.
   • day — день недели для типа WEEKLY в формате DDD. Например, MON.
   • hour — час дня по UTC для типа WEEKLY в формате HH. Например, 21.

3. Чтобы изменить список плагинов Elasticsearch, измените значение параметра plugins в блоке config описания кластера:

   resource "yandex_mdb_elasticsearch_cluster" "<имя_кластера>" {
     ...
     config {
       plugins = [ "<список_имен_плагинов>" ]
     }
   }
   

   Плагины, не упомянутые в списке, будут выключены.

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

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

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

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

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

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

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

      terraform validate
      

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

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

   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 минут
     }
   }
   

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

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

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

• Список плагинов Elasticsearch в параметре plugins.

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

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

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

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