上传与安装自定义插件

前提条件

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

  插件文件格式要求：文件名只能包含大写字母、小写字母、数字、连接线（-）或点（.），长度为8~128位，后缀名必须是.zip。插件的 plugin-descriptor.properties 文件必须位于ZIP包的根目录。

• 如需上传自定义SQL插件，须将阿里云Elasticsearch实例YML文件中的xpack.sql.enabled参数设置为false。

  配置方法请参见配置YML参数。

使用限制

• ES集群存在两种管控架构，分别为基础管控架构（v2）和云原生新管控架构（v3）登录ES控制台，在实例基本信息页面查看管控部署模式：云原生新管控（v3）或者基础管控（v2）。

• 不支持上传带任意权限类的插件，例如elasticsearch-analysis-hanlp插件。

注意事项

• 上传与安装过程中如出现控制台报错、变更卡住或校验失败等异常，请参见自定义插件安装错误的排查与解决方法。

• 实例升级时插件不会自动升级，需要重新上传并安装。

• 默认情况下自定义插件无法访问公网。如需访问公网，可通过配置NAT网关实现；如需跨VPC访问私网服务，新网络架构下可通过PrivateLink实现，详情请参见配置实例私网连接。旧网络架构下仅可访问同一VPC内的网络环境。

• 插件可能影响实例稳定性，请确保自定义插件的可用性和安全性。

操作步骤

1. 登录阿里云Elasticsearch控制台。

2. 在左侧导航栏，单击Elasticsearch实例 。

3. 进入目标实例。

   1. 在顶部菜单栏处，选择资源组和地域。

   2. 单击目标实例ID。

4. 在左侧导航栏，选择 配置与管理 > 插件配置 。

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

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

   云原生实例将上传和安装拆分为独立步骤，并支持安装中取消。云原生和非云原生实例的操作步骤及插件校验项不同，具体如下：

   云原生新管控（v3）

   1. 在上传插件对话框中，选择插件来源（ 从本地上传 或 从OSS上传 ）。选择从本地上传时，单击添加多个文件或将多个文件拖放到此区域 ，选择待上传的插件。也可以将插件文件直接拖放到指定区域完成添加。

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

      • 文件命名规范：仅支持大写字母、小写字母、数字、连接线（-）或点（.），长度为 8~128 位，后缀名必须为 .zip。

      • 文件大小与数量限制：单文件不超过 100 MB，单实例累计上传文件总数不超过 50 个。

      • 插件兼容性要求：插件名称需与系统默认插件不同，且与当前批次及已安装的自定义插件名称和版本号不重复，文件格式须与当前实例兼容。

   2. 选中页面底部的上传文件不会直接生效，请返回插件列表进行安装提示信息，单击确定 。

   3. 在自定义插件列表中，单击对应插件名称前的图标展开插件详情，确认插件上传成功。

      展开后如果看到已上传的插件且状态显示为未安装 ，表示上传成功。如不再需要已上传但未安装的插件，可单击插件右侧的删除删除对应插件。

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

      系统会校验插件依赖的Elasticsearch版本是否正确，版本不匹配则安装失败。

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

   5. 在弹出的安装插件对话框中确认提示信息（当前操作会触发集群重启），单击继续 。

      安装会触发集群重启，建议在业务低峰期操作。重启完成后，在自定义插件列表中看到插件状态显示为已安装 ，表示安装成功。安装成功后还可以更新或卸载插件：

      • 更新插件

        上传最新版本的同名插件，然后手动安装即可完成更新。

      • 卸载插件

        单击插件右侧的 卸载 即可卸载插件。详细操作及注意事项请参见安装或卸载系统默认插件。

      说明

      安装过程中支持单击操作列的取消安装取消插件安装。如果插件安装过程中无法适配Elasticsearch集群，可通过取消安装来回退。

   基础管控（v2）

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

      也可以将插件文件直接拖放到指定区域完成添加。

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

      • 文件命名规范：仅支持大写字母、小写字母、数字、连接线（-）或点（.），长度为 8~128 位，后缀名必须为 .zip。

      • 文件大小与数量限制：单文件不超过 100 MB，单实例累计上传文件总数不超过 50 个。

      • 插件兼容性要求：插件名称需与系统默认插件不同，且与当前批次及已安装的自定义插件名称和版本号不重复，文件格式须与当前实例兼容。

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

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

      如不再使用此插件，可单击插件右侧的卸载卸载插件。详细操作及注意事项请参见安装或卸载系统默认插件。卸载前请确认插件未被索引引用，否则可能导致集群重启卡顿。