Связаться с намиПодключиться

Управление расширениями Elasticsearch

Статья создана
Улучшена
Обновлена 21 апреля 2025 г.

Важно

Сервис Yandex Managed Service for Elasticsearch недоступен с 11 апреля 2024 года.

Вы можете создать кластер OpenSearch в Yandex Cloud в качестве альтернативы Elasticsearch.

Пользовательские расширения — это любые текстовые данные (словари слов, переносов и т. п.), ключи для интеграции с другими кластерами, прочие данные для работы кластера. Подробнее см. в документации Elasticsearch.

Получить список установленных пользовательских расширений

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

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

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

yc managed-elasticsearch extensions list --cluster-id <идентификатор_кластера>

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

Чтобы получить список установленных пользовательских расширений, воспользуйтесь методом REST API list для ресурса Extension или вызовом gRPC API ExtensionService/List и передайте в запросе идентификатор кластера в параметре clusterId.

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

Добавить или обновить пользовательское расширение

Примечание

В качестве расширений поддерживаются только txt-файлы, вложенные в zip-архив.

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

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

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

yc managed-elasticsearch extensions create --cluster-id <идентификатор_кластера> \
   --name <имя_расширения> \
   --uri <URI_zip-архива_с_расширением> \
   --disabled

В команде укажите параметры:

  • --cluster-id — идентификатор кластера. Его можно получить со списком кластеров в каталоге.

  • --name — имя расширения. Если указано ранее добавленное расширение, то оно обновляется:

    • номер версии расширения увеличивается на один;
    • по ссылке в параметре --uri загружается новая версия расширения, и ей присваивается новый идентификатор.

  • --uri — ссылка на zip-архив с файлами расширения в Yandex Object Storage. Доступ к Yandex Object Storage можно настроить с помощью сервисного аккаунта.

  • --disabled — статус пользовательского расширения. Чтобы выключить новую версию пользовательского расширения сразу после добавления или обновления, передайте этот параметр. Чтобы включить — не указывайте его. При включении новой версии расширения предыдущая версия будет автоматически выключена.

Чтобы добавить или обновить пользовательское расширение, воспользуйтесь методом REST API create для ресурса Extension или вызовом gRPC API ExtensionService/Create и передайте в запросе:

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

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

  • Имя расширения в параметре name. Если указано ранее добавленное расширение, то оно обновляется:

    • номер версии расширения увеличивается на один;
    • по ссылке в параметре uri загружается новая версия расширения, и ей присваивается новый идентификатор.

  • Ссылку на zip-архив с файлами расширения в Yandex Object Storage в параметре uri. Доступ к Yandex Object Storage можно настроить с помощью сервисного аккаунта.

  • Статус пользовательского расширения в параметре disabled. После добавления оно будет выключено при значении true и включено при значении false. При включении новой версии расширения предыдущая версия будет автоматически выключена.

Включить или выключить пользовательское расширение

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

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

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

yc managed-elasticsearch extensions update <идентификатор_расширения> \
   --cluster-id <идентификатор_кластера> \
   --active

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

Чтобы включить расширение, передайте параметр --active, чтобы выключить — не указывайте его.

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

Удалить пользовательское расширение

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

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

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

yc managed-elasticsearch extensions delete <идентификатор_расширения> \
   --cluster-id <идентификатор_кластера>

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

Чтобы удалить пользовательское расширение, воспользуйтесь методом REST API delete для ресурса Extension или вызовом gRPC API ExtensionService/Delete и передайте в запросе:

Предыдущая
Управление плагинами
Следующая
Остановка и запуск кластера