雲原生API Gateway提供外掛程式服務,內建認證鑒權、流量管控、安全防護等多種功能擴充外掛程式,支援上傳自訂外掛程式,可對網關進行靈活、個人化的能力擴充。本文介紹外掛程式的安裝、啟用與卸載流程,以及外掛程式的版本管理、無損熱更新與升降級功能。
外掛程式介紹
雲原生API Gateway的外掛程式,依據來源分為以下三類:
官方外掛程式:Higress官方開放的外掛程式。
社區外掛程式:Higress社區貢獻的外掛程式。
自訂外掛程式:使用者上傳的外掛程式,僅供使用者自身使用。
安裝並啟用外掛程式
安裝外掛程式是指在雲原生API Gateway中選擇外掛程式並安裝至具體網關執行個體的過程,任何外掛程式在網關執行個體上生效必須完成外掛程式安裝、配置規則以及啟用外掛程式。雲原生API Gateway提供了如下兩種方式安裝外掛程式:
MCP/路由級外掛程式規則:作用在路由上,當請求匹配到指定路由時,規則生效。
網域名稱級外掛程式規則:作用在網域名稱上,特定網域名稱的匹配優先順序高於泛網域名稱。
執行個體級外掛程式規則:作業在網關全域,當路由和網域名稱級規則都沒有匹配到的時候則匹配該規則。
方式一:在網關執行個體外安裝
前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。
在外掛程式頁面的快捷導航欄處,選擇外掛程式類型或者搜尋外掛程式名稱,單擊外掛程式卡片上的安裝,在彈出的安裝外掛程式框中選擇需要使用此外掛程式的網關執行個體,單擊確定。
在配置欄中,單擊目標網關執行個體操作列下的規則配置,在規則配置頁面選擇生效範圍。
當選擇MCP/路由級外掛程式規則和網域名稱級外掛程式規則時,單擊添加規則,在添加路由層級規則和添加網域名稱層級規則頁面,開啟啟用狀態(預設開啟),選擇生效目標並配置外掛程式規則,單擊確定。
當選擇執行個體級外掛程式規則時,開啟啟用狀態(預設開啟)並配置外掛程式規則,單擊儲存。
方式二:在網關執行個體內安裝
前往雲原生API Gateway控制台的執行個體頁面,在頂部功能表列選擇地區。
進入目標執行個體頁面,在左側導覽列選擇外掛程式。
單擊安裝外掛程式,在安裝外掛程式頁面的快捷導航處,選擇要安裝的外掛程式類型或者搜尋外掛程式名稱,單擊外掛程式卡片,在彈出的安裝外掛程式框中,單擊安裝並配置。
在彈框規則配置頁面,為所選外掛程式配置規則並選擇生效範圍。單擊確定。
(可選)您可通過網關執行個體頁面,在左側導覽列選擇外掛程式,單擊外掛程式列表操作列中的規則配置,為所選外掛程式配置規則並選擇生效範圍。
當選擇MCP/路由級外掛程式規則和網域名稱級外掛程式規則時,單擊添加規則,在添加路由層級規則和添加網域名稱層級規則頁面,開啟啟用狀態(預設開啟),選擇生效目標並配置外掛程式規則,單擊確定。
當選擇執行個體級外掛程式規則時,開啟啟用狀態(預設開啟)並配置外掛程式規則,單擊儲存。
卸載外掛程式
使用背景
當您想要將外掛程式徹底從網關上刪除時,您可以選擇卸載外掛程式。雲原生API Gateway提供了如下兩種方式卸載外掛程式:
卸載外掛程式時,如果存在啟用的外掛程式規則,請先停用外掛程式再卸載;如果外掛程式未啟用,卸載外掛程式會將配置的外掛程式規則一併刪除。
方式一:在網關執行個體外卸載
前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。
在外掛程式頁面的快捷導航欄處,選擇外掛程式類型或者搜尋外掛程式名稱,單擊要卸載的外掛程式卡片。
單擊配置欄,在要卸載此外掛程式的網關執行個體操作欄中,單擊卸載。
在彈出框中,點擊確定按鈕,頁面提示卸載外掛程式成功。
方式二:在網關執行個體內卸載
前往雲原生API Gateway控制台的執行個體頁面,在頂部功能表列選擇地區。
進入目標執行個體頁面,在左側導覽列選擇外掛程式。
在外掛程式列表中,單擊所要卸載外掛程式操作列中的卸載。
在彈出框中單擊確定按鈕,頁面提示卸載外掛程式成功。
為自訂外掛程式添加版本
lua自訂外掛程式比較特殊,不支援添加版本。
添加版本是指為自訂外掛程式的每一次修改建立一個新版本記錄,便於管理變更、回溯歷史和控制發布。詳細操作步驟如下:
前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。
在外掛程式頁面的快捷導航欄處,外掛程式類型選擇自訂或者搜尋外掛程式名稱,單擊外掛程式卡片上的添加版本,在彈出的添加版本面板中配置版本資訊:
版本號碼:輸入外掛程式的目前的版本標識,輸入的版本號碼需要符合semver版本規範,如
1.0.1。版本描述:簡要說明該版本的功能或變更內容,如
新增限流功能。WASM檔案:上傳已編譯好的
.wasm檔案,用於在網關中執行外掛程式邏輯 。執行階段:選擇外掛程式在請求處理流程中的執行時機,如
預設階段。執行優先順序:輸入一個數字表示外掛程式執行順序,數值越大優先順序越高。
適配網關版本:輸入該外掛程式相容的網關引擎版本號碼,確保外掛程式正常運行。
說明允許安裝該外掛程式的最小網關版本。
外掛程式版本變更
如需平滑升級需要確保變更版本與原版本規則配置相容。
前往雲原生API Gateway控制台的執行個體頁面,在頂部功能表列選擇地區。
進入目標執行個體頁面,在左側導覽列選擇外掛程式。
在外掛程式列表中,單擊目標外掛程式操作列的版本變更。
在版本變更對話方塊,選擇您想要變更的版本,然後單擊確定。
刪除版本
前往雲原生API Gateway控制台的外掛程式頁面,在頂部功能表列選擇地區。
在外掛程式頁面的快捷導航欄處,外掛程式類型選擇自訂或者搜尋外掛程式名稱,滑鼠移動至外掛程式卡片上的
表徵圖。然後單擊刪除外掛程式,選擇您需要刪除的版本,單擊確定。