You need to enable JavaScript to run this app.
导航
上传自定义插件文件
最近更新时间:2024.08.23 15:16:27首次发布时间:2023.07.21 10:36:20

云搜索服务支持使用自定义插件。本文介绍自定义插件文件内容,以及上传插件文件的操作流程。

背景信息

您在准备自定义插件包时,请先了解插件描述文件和插件安全文件的相关要求。

插件描述文件(plugin-descriptor.properties)

plugin-descriptor.properties文件中,需要声明插件名插件版本实例版本,且该文件应位于 ZIP 包解压后的根目录中。
文件中的重要字段解释如下:

  • name:插件名。
  • version:插件所属的版本。
  • description:插件的简要功能描述。上传插件包文件后,插件的描述信息将会展示在云搜索服务 ES 实例页面的自定义插件列表中。
  • elasticsearch.version:Elasticsearch 版本。如果插件声明的 Elasticsearch 版本和目标实例版本不一致,会导致上传失败。

插件安全文件(plugin-security.policy)

自定义插件的安全文件中不允许包含敏感类权限,详情如下:

  • 文件类权限:不允许对文件进行任意的读写和执行操作。
  • 网络类权限:不允许(包括但不限于)监听或发起网络请求。

注意事项

  • 在实例上安装自定义插件,自定义插件本身可能会影响实例的稳定性,请务必先在本地进行安装测试验证,保证插件的可用性和安全性。详情请参见前提条件
  • 文件后缀名必须是.zip。文件名只能包含大小写字母、数字、短横线(-)或点(.),长度为8~128位。
  • 每个插件最多支持上传 5 个不同版本的插件文件。不能上传相同名称的插件文件。
  • 上传自定义 IK 插件时,不能和默认 IK 插件重名,同时代码里 Analyzer 和 Tokenizer 也不能重名。
  • 上传自定义插件时,插件描述文件中 ES 版本与目标实例版本需要保持一致。
  • 实例升级时,自定义插件不会升级更新。

注意

您在上传与安装自定义插件时,如果出现上传失败、安装卡住或者卸载卡住等异常问题,可参见自定义插件安装异常处理方案进行排查解决。

上传插件文件

  1. 登录云搜索服务控制台
  2. 在顶部导航栏,选择目标项目和地域。
  3. 实例列表 v2页面,单击目标实例名称。
  4. 在左侧导航栏选择实例管理 > 插件管理,然后单击自定义插件页签。
  5. 自定义插件页面,单击上传文件
    图片
  6. 上传插件对话框,从本地选择自定义插件文件,然后勾选相关提示信息,再单击确定
    如果上传文件弹出错误提示,请根据提示修改插件文件。
    图片

查看插件文件

每个插件最多支持上传 5 个不同版本的插件文件,只能安装 1 个版本的插件。您可以查看插件文件列表和已安装的插件版本。

  1. 在左侧导航栏选择实例管理 > 插件管理,然后单击自定义插件页签。
  2. 自定义插件页面,选择目标插件,单击插件前方的+按钮。
  3. 查看插件文件列表和已安装的插件版本。
    图片