全部產品
Search
文件中心

Elasticsearch:上傳與安裝自訂外掛程式

更新時間:Jul 20, 2024

當您需要使用自訂外掛程式或系統預設外掛程式中不包含的開源外掛程式時,可通過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. 上傳並安裝自訂外掛程式。

    1. 上傳外掛程式對話方塊中,單擊添加多個檔案或將多個檔案拖放到此地區,選擇待上傳的外掛程式,單擊開啟。

      您也可以將自訂的外掛程式檔案直接拖放到指定地區,完成添加。如下圖成功添加了檔案名稱為elasticsearch-sql-6.7.0.0.zip的自訂外掛程式。外掛程式上傳對話方塊

      您上傳的外掛程式檔案需要滿足以下條件,否則校正不通過:

      • 檔案名稱

        只能包含大寫字母、小寫字母、數字、連接線(-)或點(.),長度為8~128位,尾碼名必須是.zip。

        重要

        包含以下特徵的外掛程式無法上傳安裝:與系統預設外掛程式同名、單次重複上傳的同名同版本外掛程式、依賴Elasticsearch版本不正確的外掛程式以及其他非相容檔案。

      • 單檔案大小:不能超過100 MB。

      • 上傳的檔案總數量:單一實例不能超過50個。

    2. 閱讀並選中對話方塊中的注意事項,單擊上傳安裝

      重啟成功後,如果在自訂外掛程式列表中看到您上傳的外掛程式,且狀態顯示為已安裝,表示外掛程式上傳並安裝成功。安裝成功的外掛程式

      如果您不再使用此外掛程式,可單擊外掛程式右側的卸載,卸載此外掛程式。詳細操作方法及注意事項請參見安裝或卸載系統預設外掛程式