Traefik 已經(jīng)默認(rèn)實(shí)現(xiàn)了很多中間件,可以滿足大部分我們?nèi)粘5男枨螅窃趯?shí)際工作中,用戶仍然還是有自定義中間件的需求,為解決這個(gè)問題,官方推出了一個(gè) Traefik Pilot[1] 的功能了,此外在 Traefik v2.5 版本還推出了支持本地私有插件的功能。
Traefik Pilot
Traefik Pilot 是一個(gè) SaaS 平臺(tái),和 Traefik 進(jìn)行鏈接來擴(kuò)展其功能,它提供了很多功能,通過一個(gè)全局控制面板和 Dashboard 來增強(qiáng)對(duì) Traefik 的觀測和控制:
- Traefik 代理和代理組的網(wǎng)絡(luò)活動(dòng)的指標(biāo)
- 服務(wù)健康問題和安全漏洞警報(bào)
- 擴(kuò)展 Traefik 功能的插件
在 Traefik 可以使用 Traefik Pilot 的功能之前,必須先連接它們,我們只需要對(duì) Traefik 的靜態(tài)配置進(jìn)行少量更改即可。
Traefik 代理必須要能訪問互聯(lián)網(wǎng)才能連接到 Traefik Pilot,通過 HTTPS 在 443 端口上建立連接。
首先我們需要在 Traefik Pilot 主頁上(https://pilot.traefik.io/)創(chuàng)建一個(gè)帳戶,注冊(cè)新的 Traefik 實(shí)例并開始使用 Traefik Pilot。登錄后,可以通過選擇 Register New Traefik Instance來創(chuàng)建新實(shí)例。
另外,當(dāng)我們的 Traefik 尚未連接到 Traefik Pilot 時(shí),Traefik Web UI 中將出現(xiàn)一個(gè)響鈴圖標(biāo),我們可以選擇 Connect with Traefik Pilot 導(dǎo)航到 Traefik Pilot UI 進(jìn)行操作。
登錄完成后,Traefik Pilot 會(huì)生成一個(gè)新實(shí)例的令牌,我們需要將這個(gè) Token 令牌添加到 Traefik 靜態(tài)配置中。
在 Traefik 安裝配置文件中啟用 Pilot 的配置:
- # Activate Pilot integration
- pilot:
- enabled: true
- token: "e079ea6e-536a-48c6-b3e3-f7cfaf94f477"
更新完成后,我們?cè)?Traefik 的 Web UI 中就可以看到 Traefik Pilot UI 相關(guān)的信息了。
接下來我們就可以在 Traefik Pilot 的插件頁面選擇我們想要使用的插件,比如我們這里使用 Demo Plugin[2] 這個(gè)插件。
點(diǎn)擊右上角的 Install Plugin 按鈕安裝插件會(huì)彈出一個(gè)對(duì)話框提示我們?nèi)绾伟惭b。
首先我們需要將當(dāng)前 Traefik 注冊(cè)到 Traefik Pilot(已完成),然后需要以靜態(tài)配置的方式添加這個(gè)插件到 Traefik 中,然后添加插件啟動(dòng)參數(shù):
- # Activate Pilot integration
- pilot:
- enabled: true
- token: "e079ea6e-536a-48c6-b3e3-f7cfaf94f477"
- additionalArguments:
- # 添加 demo plugin 的支持
- - --experimental.plugins.plugindemo.modulename=github.com/traefik/plugindemo
- - --experimental.plugins.plugindemo.version=v0.2.1
- # 其他配置
更新完成后創(chuàng)建一個(gè)如下所示的 Middleware 對(duì)象:
-
? cat <
- apiVersion: traefik.containo.us/v1alpha1
- kind: Middleware
- metadata:
- name: myplugin
- spec:
- plugin:
- plugindemo: # 插件名
- Headers:
- X-Demo: test
- Foo: bar
- EOF
然后添加到上面的 whoami 應(yīng)用的 IngressRoute 對(duì)象中去:
- apiVersion: traefik.containo.us/v1alpha1
- kind: IngressRoute
- metadata:
- name: ingressroute-demo
- namespace: default
- spec:
- entryPoints:
- - web
- routes:
- - match: Host(`who.qikqiak.com`) && PathPrefix(`/notls`)
- kind: Rule
- services:
- - name: whoami # K8s Service
- port: 80
- middlewares:
- - name: myplugin # 使用上面新建的 middleware
更新完成后,當(dāng)我們?nèi)ピL問 http://who.qikqiak.com/notls 的時(shí)候就可以看到新增了兩個(gè)上面插件中定義的兩個(gè) Header。
當(dāng)然除了使用 Traefik Pilot 上開發(fā)者提供的插件之外,我們也可以根據(jù)自己的需求自行開發(fā)自己的插件,可以自行參考插件開發(fā)文檔[3]。
本地私有插件
上面我們介紹了可以使用 Traefik Pilot 來使用插件,但是這是一個(gè) SaaS 服務(wù)平臺(tái),對(duì)于大部分企業(yè)場景下面不是很適用,我們更多的場景下需要在本地環(huán)境加載插件,為解決這個(gè)問題,在 Traefik v2.5 版本后,就提供了一種直接從本地存儲(chǔ)目錄加載插件的新方法,不需要啟用 Traefik Pilot,只需要將插件源碼放入一個(gè)名為 /plugins-local 的新目錄,相對(duì)于當(dāng)前工作目錄去創(chuàng)建這個(gè)目錄,比如我們直接使用的是 traefik 的 docker 鏡像,則入口點(diǎn)則是根目錄 /,Traefik 本身會(huì)去構(gòu)建你的插件,所以我們要做的就是編寫源代碼,并把它放在正確的目錄下,讓 Traefik 來加載它即可。
需要注意的是由于在每次啟動(dòng)的時(shí)候插件只加載一次,所以如果我們希望重新加載你的插件源碼的時(shí)候需要重新啟動(dòng) Traefik。
下面我們使用一個(gè)簡單的自定義插件示例來說明如何使用私有插件。首先我們定義一個(gè)名為 Dockerfile.demo 的 Dockerfile 文件,先從 git 倉庫中克隆插件源碼,然后以 traefik:v2.5 為基礎(chǔ)鏡像,將插件源碼拷貝到 /plugins-local 目錄,如下所示:
- FROM alpine:3
- ARG PLUGIN_MODULE=github.com/traefik/plugindemo
- ARG PLUGIN_GIT_REPO=https://github.com/traefik/plugindemo.git
- ARG PLUGIN_GIT_BRANCH=master
- RUN apk add --update git && \
- git clone ${PLUGIN_GIT_REPO} /plugins-local/src/${PLUGIN_MODULE} \
- --depth 1 --single-branch --branch ${PLUGIN_GIT_BRANCH}
- FROM traefik:v2.5
- COPY --from=0 /plugins-local /plugins-local
我們這里使用的演示插件和上面 Pilot 中演示的是同一個(gè)插件,我們可以通過該插件去自定義請(qǐng)求頭信息。
然后在 Dockerfile.demo 目錄下面,構(gòu)建鏡像:
- ? docker build -f Dockerfile.demo -t cnych/traefik-private-demo-plugin:2.5.4 .
- # 推送到鏡像倉庫
- ? docker push cnych/traefik-private-demo-plugin:2.5.4
鏡像構(gòu)建完成后就可以使用這個(gè)鏡像來測試 demo 插件了,將鏡像修改成上面我們自定義的鏡像地址:
- image:
- name: cnych/traefik-private-demo-plugin
- tag: 2.5.4
- # 其他省略
- # 不需要開啟 pilot 了
- pilot:
- enabled: false
- additionalArguments:
- # 添加 demo plugin 的本地支持
- - --experimental.localPlugins.plugindemo.moduleName=github.com/traefik/plugindemo
- # 其他省略
注意上面我們添加 Traefik 的啟動(dòng)參數(shù)的時(shí)候使用的 --experimental.localPlugins。更新完成后就可以使用我們的私有插件來創(chuàng)建一個(gè) Middleware 對(duì)象了:
-
? cat <
- apiVersion: traefik.containo.us/v1alpha1
- kind: Middleware
- metadata:
- name: my-private-plugin
- spec:
- plugin:
- plugindemo: # 插件名
- Headers:
- X-Demo: private-demo
- Foo: bar
- EOF
然后添加到上面的 whoami 應(yīng)用的 IngressRoute 對(duì)象中去:
- apiVersion: traefik.containo.us/v1alpha1
- kind: IngressRoute
- metadata:
- name: ingressroute-demo
- namespace: default
- spec:
- entryPoints:
- - web
- routes:
- - match: Host(`who.qikqiak.com`) && PathPrefix(`/notls`)
- kind: Rule
- services:
- - name: whoami # K8s Service
- port: 80
- middlewares:
- - name: my-private-plugin # 使用上面新建的 middleware
更新上面的資源對(duì)象后,我們?cè)偃ピL問 http://who.qikqiak.com/notls 就可以看到新增了兩個(gè)上面插件中定義的兩個(gè) Header,證明我們的私有插件配置成功了:
有了本地私有插件的支持,Traefik 才算真正開始起飛吧?
參考資料
[1]Traefik Pilot: https://pilot.traefik.io/
[2]Demo Plugin: https://github.com/traefik/plugindemo
[3]Plugin dev doc: https://doc.traefik.io/traefik-pilot/plugins/plugin-dev/
原文鏈接:https://mp.weixin.qq.com/s/uwMEQgS56OOolgSJes8n2Q