當您需要使用自定義插件或系統默認插件中不包含的開源插件時,可通過云搜索服務的自定義插件上傳與安裝功能,在實例中上傳并安裝對應插件。
前提條件
準備待上傳的插件,并確保插件的可用性和安全性。
建議在上傳插件前,先在本地自建OpenSearch集群(與實例相同版本)上進行測試,成功后再進行上傳。
開通與云搜索實例同地域的對象存儲服務,并上傳好需要安裝的插件至對象存儲的桶中。
使用限制
不支持安裝與默認插件一樣的插件,包括默認插件的其他版本。
不支持同時安裝/卸載兩個以上的插件。
云搜索服務不保留用戶插件的安裝文件,請您自行備份。
插件文件后綴需要為.zip。
不支持上傳安裝帶權限屬性的插件。
目前云搜索已關閉該功能,僅版本號<1.5.0的實例可以使用。
注意
安裝自定義插件操作會觸發實例重啟插件本身可能影響實例的穩定性,請務必保證自定義插件的可用性和安全性,建議在業務低峰期進行操作。
操作步驟
登錄云搜索服務控制臺,進入實例管理列表頁,選擇需要設置的實例點擊名稱進入詳情頁。
在實例詳情頁選擇“插件管理”>“自定義插件”,單擊上傳插件按鈕。
在彈出的頁面上填寫:
插件名稱:僅支持字母、數字和字符,請和插件包名稱保持一致。插件名稱查詢路徑:插件包內properties文件中找到pluginName。
插件地址:填寫天翼云對象存儲同地域資源池下的地址,獲取路徑為:對象存儲控制臺——點擊對應桶名稱進入詳情——點擊文件管理,找到對應的插件,點擊右側更多——復制URL。
插件版本:插件目前的版本,格式為數字和點組合,如:7.10或2.19.1.0,非必填。
插件描述:用于幫助用戶識別插件功能,非必填。
注意
需要開啟對應文件的可讀權限。
填寫完畢后點擊安裝并重啟,插件會先在實例安裝,安裝完畢后實例將自動進行重啟。期間請勿對實例進行其他操作。
當實例重啟完成,插件狀態變成“已安裝”則表示插件已經安裝完畢。若插件處于“未安裝”狀態,則說明安裝失敗,您可根據提示調填寫內容再次重試或通過工單聯系我們協助處理。您也可以刪除該插件信息。
已經安裝完畢的插件,如果您不再使用,可單擊插件右側的卸載,卸載此插件。卸載插件如需再次安裝,請參照前述步驟執行。