Managing Elasticsearch plugins
Warning
Yandex Managed Service for Elasticsearch is unavailable as of April 11, 2024.
You can create an OpenSearch cluster in Yandex Cloud as an alternative to Elasticsearch.
When creating or updating a cluster in Managed Service for Elasticsearch, you can specify a list of necessary plugins and they will be installed in the cluster automatically. A full list of available plugins is given below.
Retrieving a list of installed plugins
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To get a list of cluster plugins, run the following command:
yc managed-elasticsearch cluster get <cluster_name_or_ID>
Enabled plugins will be shown in the plugins
list.
You can get the cluster ID and name with a list of clusters in the folder.
To get a list of installed plugins, use the get REST API method for the Cluster resource or the ClusterService/Get gRPC API call and provide the cluster ID in the clusterId
request parameter.
Enabled plugins will be shown in the plugins
list.
You can get the cluster ID with a list of clusters in the folder.
Editing a list of installed plugins
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To edit cluster plugins, pass the plugin list in the CLI --plugins
parameter. Plugins that are not included in the list will be disabled.
yc managed-elasticsearch cluster update <cluster_name_or_ID> \
--plugins=<plugin_1_name>,...,<plugin_N_name>
You can get the cluster ID and name with a list of clusters in the folder.
-
Open the current Terraform configuration file with an infrastructure plan.
For more information about how to create this file, see Creating clusters.
-
In the Managed Service for Elasticsearch cluster description, add the
plugins
field with a list of plugins to theconfig
block:resource "yandex_mdb_elasticsearch_cluster" "<cluster_name>" { ... config { ... plugins = [ "<list_of_plugin_names>" ] ... } ... }
-
Make sure the settings are correct.
-
Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.
-
Run the command:
terraform validate
If there are errors in the configuration files, Terraform will point to them.
-
-
Confirm updating the resources.
-
Run the command to view planned changes:
terraform plan
If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.
-
If you are happy with the planned changes, apply them:
-
Run the command:
terraform apply
-
Confirm the update of resources.
-
Wait for the operation to complete.
-
-
For more information, see the Terraform provider documentation
To update the list of installed plugins, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:
-
Cluster ID in the
clusterId
parameter.You can get the cluster ID with a list of clusters in the folder.
-
List of plugins in the
configSpec.elasticsearchSpec.plugins
parameter. Plugins that are not included in the list will be disabled. -
List of cluster configuration fields to update in the
UpdateMask
parameter.
Warning
This API method overrides all parameters of the object being modified that were not explicitly passed in the request to the default values. To avoid this, list the settings you want to change in the updateMask
parameter (one line separated by commas).
Supported Elasticsearch plugins
All supported plugins are listed here:
-
Adds the Lucene ICU module with extended Unicode support using the ICU libraries. It enables better analysis of Asian languages, Unicode normalization, Unicode-aware case folding, collation support, and transliteration.
-
Adds the Lucene kuromoji analysis module for Japanese.
-
Adds the Lucene nori analysis module for Korean.
-
Provides lexeme filters that convert expressions to their phonetic representation using Soundex, Metaphone, and other algorithms.
-
Adds the Lucene's Smart Chinese analysis module for Chinese or mixed Chinese-English text.
-
Adds the Lucene's Stempel analysis module for Polish.
-
Adds the Lucene's UkrainianMorfologikAnalyzer analysis module providing stemming for Ukrainian.
-
Extracts file attachments in common formats (such as PPT, XLS, and PDF) using the Apache text extraction library Tika™.
-
Indexes text that is a combination of free-text and special markup. Such combinations are typically used to identify items of interest such as people or organizations.
-
Computes hashes of field values at index-time and stores them in the index.
-
Provides the
_size
metadata field, which indexes the size in bytes of the original_source
field. -
Adds support for Azure Blob storage as a repository for snapshots.
-
Adds support for Google Cloud Storage as a repository for snapshots.
-
Adds support for the HDFS file system as a repository for snapshots.
-
Adds support for AWS S3 as a repository for snapshots.
-
Fixes bugs in Windows SMB and Java on Windows.
-
transport-nio
Server/client non-blocking networking library built with Netty.
For more information, see the Elasticsearch documentation