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

前提條件

• 準備待上傳的外掛程式，並確保外掛程式的可用性和安全性。

  外掛程式檔案格式要求：檔案名稱只能包含大寫字母、小寫字母、數字、連接線（-）或點（.），長度為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 Gateway實現；如需跨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. 閱讀並選中對話方塊中的注意事項，單擊上傳安裝。

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

      如不再使用此外掛程式，可單擊外掛程式右側的卸載卸載外掛程式。詳細操作及注意事項請參見安裝或卸載系統預設外掛程式。卸載前請確認外掛程式未被索引引用，否則可能導致叢集重啟卡頓。