文档

上传与安装自定义插件

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

当您需要使用自定义插件或系统默认插件中不包含的开源插件时,可通过阿里云Elasticsearch的自定义插件上传与安装功能,在实例中上传并安装对应插件。本文介绍具体的操作方法。

前提条件

  • 准备待上传的插件,并确保插件的可用性和安全性。

    插件文件格式要求:文件名只能包含大写字母、小写字母、数字、连接线(-)或点(.),长度为8~128位。文件后缀名必须是.zip。

    重要

    建议在上传插件前,先在本地自建Elasticsearch集群(与阿里云Elasticsearch相同版本)上进行测试,成功后再进行上传,具体操作步骤请参见Installing Plugins

  • 如果您需要上传自定义的SQL插件,请确保已经将阿里云Elasticsearch实例的YML文件中的xpack.sql.enabled参数设置为false

    具体配置方法请参见配置YML参数

使用限制

阿里云Elasticsearch不支持上传带任意权限类的插件,例如elasticsearch-analysis-hanlp插件。

注意事项

  • 在上传与安装自定义插件时,如果出现控制台报错、变更卡住、无法验证通过或其他异常问题,可参见自定义插件安装错误的排查与解决方法进行排查解决。

  • 阿里云Elasticsearch升级时插件不会自动升级更新,需要重新上传。

  • 默认情况下自定义插件无法访问公网环境。在新网络架构下,可通过PrivateLink实现私网访问,详细信息请参见配置实例私网连接。旧网络架构下,只可访问同一VPC下的网络环境。

  • 插件本身可能影响实例的稳定性,请务必保证自定义插件的可用性和安全性。

操作步骤

警告

安装自定义插件操作会触发实例重启,并且插件本身可能影响实例的稳定性,请务必保证自定义插件的可用性和安全性,建议在业务低峰期进行操作。

  1. 登录阿里云Elasticsearch控制台
  2. 在左侧导航栏,单击Elasticsearch实例
  3. 进入目标实例。
    1. 在顶部菜单栏处,选择资源组和地域。
    2. Elasticsearch实例中单击目标实例ID。
  4. 在左侧导航栏,选择配置与管理 > 插件配置

  5. 插件配置页面,单击自定义插件列表页签,再单击上传

  6. 上传并安装自定义插件。

    云原生架构版实例(以kibana 443访问端口区分,例如7.16、8.5、8.9等版本)对自定义插件上传功能进行了优化,区分上传和安装,并支持安装中进行取消。在上传与安装自定义插件时,云原生和非云原生实例操作步骤以及对插件的校验项不同,具体如下:

    云原生实例

    1. 上传插件面板,单击添加多个文件或将多个文件拖放到此区域,选择待上传的插件,单击打开。

      您也可以将自定义的插件文件直接拖放到指定区域,完成添加。如下图成功添加了文件名为analysis-xxx-v7.16.0.zip的自定义插件。上传插件7.16

      您上传的插件文件需要满足以下条件,否则校验不通过:

      • 文件名称

        只能包含大写字母、小写字母、数字、连接线(-)或点(.),长度为8~128位,后缀名必须是.zip。

        重要

        包含以下特征的插件无法上传安装:与系统默认插件同名插件、单次重复上传的同名同版本插件、与已安装的自定义插件同名同版本的插件以及其他非兼容文件。

      • 单文件大小:不能超过100 MB。

      • 上传的文件总数量:单实例不能超过50个。

    2. 选中页面底部的提示信息,单击确定

    3. 自定义插件列表页面,单击对应插件名称前的展开图标图标,展开自定义插件,查看插件是否上传成功。

      如果您可以在展开的列表中看到已上传的插件,且插件的状态显示为未安装,表示插件上传成功。7.16查看自定义插件

      如果您不再需要已上传但未安装的插件,可单击插件右侧的删除,删除对应插件。

    4. 在插件列表中,单击对应插件右侧操作列下的安装,安装已上传的插件。

      安装时,系统会校验插件依赖的Elasticsearch版本是否正确,如果不正确则安装不成功。

      您也可以选中多个插件,单击底部的批量安装,一次性安装多个插件。

    5. 在弹出的对话框中,单击继续,完成插件安装。

      安装插件会触发集群重启,建议业务低峰期进行。重启成功后,如果在自定义插件列表中看到插件状态显示为已安装,表示插件安装成功。插件安装成功后,您还可以更新或卸载插件:

      • 更新插件

        如果您需要更新已上传至阿里云Elasticsearch中的自定义插件,可先上传最新版本的同名插件,然后手动安装即可。7.16更新自定义插件

      • 卸载插件

        如果您不再使用已安装的插件,可单击插件右侧的卸载,卸载对应插件。详细操作方法及注意事项请参见安装或卸载系统默认插件

      说明

      安装过程中支持单击操作列的取消安装取消插件安装。 如果自定义插件安装过程中无法适配elasticsearch集群,可以通过取消安装功能卸载插件的影响。

    非云原生实例

    1. 上传插件对话框中,单击添加多个文件或将多个文件拖放到此区域,选择待上传的插件,单击打开。

      您也可以将自定义的插件文件直接拖放到指定区域,完成添加。如下图成功添加了文件名为elasticsearch-sql-6.7.0.0.zip的自定义插件。插件上传对话框

      您上传的插件文件需要满足以下条件,否则校验不通过:

      • 文件名称

        只能包含大写字母、小写字母、数字、连接线(-)或点(.),长度为8~128位,后缀名必须是.zip。

        重要

        包含以下特征的插件无法上传安装:与系统默认插件同名、单次重复上传的同名同版本插件、依赖Elasticsearch版本不正确的插件以及其他非兼容文件。

      • 单文件大小:不能超过100 MB。

      • 上传的文件总数量:单实例不能超过50个。

    2. 阅读并选中对话框中的注意事项,单击上传安装

      重启成功后,如果在自定义插件列表中看到您上传的插件,且状态显示为已安装,表示插件上传并安装成功。安装成功的插件

      如果您不再使用此插件,可单击插件右侧的卸载,卸载此插件。详细操作方法及注意事项请参见安装或卸载系统默认插件