擴展apisix原始插件
當apisix提供的插件不能滿足我們要求時,我們可能需要將它的plugin進行個性化擴展,例如一個jwt認證插件jwt-auth
,它本身具有驗證jwt有效性功能,支持rs256,hs256等常用簽名算法,但在驗證之後,如果希望將jwt中的用戶信息取出來,並放請求頭向上遊傳遞,目前這個插件是不支持的,我們需要擴展一下它,下面看具體的步驟。
- 下載apisix源代碼,找個原來的插件,在上面直接開發
- 找到_M.rewirte方法,在解析jwt之後,添加向下一請求頭寫入的代碼
core.request.add_header(ctx,"sub", jwt_obj.payload.sub)
core.request.add_header(ctx,"preferred_username", jwt_obj.payload.preferred_username)
- 將插件內容修改後,放到我們自己擴展的目錄,文件名還是jwt-auth.lua
- 部署configmap,我們可以通過下面語句來實現由lua文件到configMap的導入
kubectl create configmap jwt-auth-app-header-config -n apisix --from-file=./jwt-auth-app-header.lua
- 在values.override.yaml文件中,添加jwt-auth的部署如下
apisix:
customPlugins:
enabled: true
luaPath: "/opt/?.lua"
plugins:
- name: "jwt-auth"
configMap:
name: "jwt-auth-config"
mounts:
- key: "jwt-auth.lua"
path: "/opt/apisix/plugins/jwt-auth.lua"
- 升級你的apisix服務即可
helm -n apisix upgrade apisix -f ./apisix/values.override.yaml ./apisix
,之後重新訪問服務,請求頭就出現了sub
這些擴展字段
一鍵更新擴展插件包的方法
- 遍歷插件目錄下所有lua文件
- 生成configmap的名稱,以lua文件主名-config爲標準
- 使用
kubectl create | kubectl apply -f -
,存在就從文件更新,不存在就從文件建立configmap
具體sh腳本代碼
#!/bin/sh
# 不存大就建立,存在就更新
for file in "$(pwd)"/*.lua
do
if [ -f "$file" ]; then
echo "通過lua腳本更新configmap配置:$file"
configName=$(basename "$file" .lua)
kubectl create configmap "$configName"-config -n apisix --from-file="$file" --dry-run=true -o yaml | kubectl apply -f -
fi
done