Install or uninstall a built-in plug-in

更新时间:
复制 MD 格式

Alibaba Cloud Elasticsearch instances include preinstalled plug-ins that vary by version. You can install or uninstall these plug-ins as needed. This topic explains plug-in version compatibility and how to manage them.

Background

Important

The instance resources used by Alibaba Cloud Elasticsearch plug-ins belong to you. Do not use these resources for illegal activities.

For information about the plug-ins, applicable versions, and supported operations for Alibaba Cloud Elasticsearch, see Plug-in Configuration. The analysis-ik and elasticsearch-repository-oss plug-ins are extended plug-ins for Alibaba Cloud Elasticsearch and cannot be uninstalled by default. The details are as follows:

  • analysis-ik: An IK analysis plug-in. It extends the open-source version to support dynamic loading of dictionary files from Object Storage Service (OSS). It also supports both cold and hot updates for IK dictionaries. For more information, see Use the IK analysis plug-in (analysis-ik).

  • elasticsearch-repository-oss: An extension of the open-source plug-in that enables you to create and restore index snapshots using the OSS file system.

Considerations

Installing or uninstalling a plug-in triggers a cluster restart. We recommend performing these operations during off-peak hours. Before uninstalling a plug-in, ensure it is not referenced by any index. If an index is still referencing the plug-in, the cluster restart might stall.

Procedure

  1. Log on to the Alibaba Cloud Elasticsearch console.

  2. In the left navigation menu, choose Elasticsearch Clusters.

  3. Navigate to the target cluster.

    1. In the top navigation bar, select the resource group to which the cluster belongs and the region where the cluster resides.

    2. On the Elasticsearch Clusters page, find the cluster and click its ID.

  4. In the left-side navigation pane, click Configuration and Management > Plug-in Configuration.

  5. On the Built-in Plug-ins tab, find the plug-in that you want to manage. Then, in the Actions column, click Install or Remove.

  6. In the dialog box, review the considerations and click OK.

    After you click OK, the cluster restarts. You can track the progress in the Tasks list. The plug-in is installed or uninstalled when the restart is complete.

API reference