当您需要使用自定义插件或系统默认插件中不包含的开源插件时,可通过云搜索服务的自定义插件上传与安装功能,在实例中上传并安装对应插件。
前提条件
- 准备待上传的插件,并确保插件的可用性和安全性。
- 建议在上传插件前,先在本地自建OpenSearch集群(与实例相同版本)上进行测试,成功后再进行上传。
- 开通与云搜索实例同地域的对象存储服务,并上传好需要安装的插件至对象存储的桶中。
使用限制
- 不支持安装与默认插件一样的插件,包括默认插件的其他版本。
- 不支持同时安装/卸载两个以上的插件。
- 云搜索服务不保留用户插件的安装文件,请您自行备份。
- 插件文件后缀需要为.zip。
- 不支持上传安装带权限属性的插件。
注意安装自定义插件操作会触发实例重启插件本身可能影响实例的稳定性,请务必保证自定义插件的可用性和安全性,建议在业务低峰期进行操作。
操作步骤
-
登录云搜索服务控制台,进入实例管理列表页,选择需要设置的实例点击名称进入详情页。
-
在实例详情页选择“插件管理”>“自定义插件”,单击上传插件按钮。
-
在弹出的页面上填写:
- 插件名称:仅支持字母、数字和字符,请和插件包名称保持一致。插件名称查询路径:插件包内properties文件中找到pluginName。
- 插件地址:填写天翼云对象存储同地域资源池下的地址,获取路径为:对象存储控制台——点击对应桶名称进入详情——点击文件管理,找到对应的插件,点击右侧更多——复制URL。
- 插件版本:插件目前的版本,格式为数字和点组合,如:7.10或2.9.0,非必填。
- 插件描述:用于帮助用户识别插件功能,非必填。
注意需要开启对应文件的可读权限。
- 填写完毕后点击安装并重启,插件会先在实例安装,安装完毕后实例将自动进行重启。期间请勿对实例进行其他操作。
- 当实例重启完成,插件状态变成“已安装”则表示插件已经安装完毕。若插件处于“未安装”状态,则说明安装失败,您可根据提示调填写内容再次重试,或通过工单联系我们协助处理。您也可以删除该插件信息。
- 已经安装完毕的插件,如果您不再使用,可单击插件右侧的卸载,卸载此插件。卸载插件如需再次安装,请参照前述步骤执行。