apisix~升级原始插件的方法

apisix · 浏览次数 : 0

小编点评

## 扩展apisix插件 jwt-auth 以下是将jwt-auth插件个性化的步骤: 1. **下载apisix源代码**:从官方网站下载最新的apisix源代码。 2. **找到原来的插件**:在源代码中寻找名为`jwt-auth`的插件文件。 3. **修改`_M.rewirte`方法**:在`jwt-auth.lua`中找到`_M.rewirte`方法。 4. **添加代码**:在`_M.rewirte`方法中添加以下代码: ```lua core.request.add_header(ctx, "sub", jwt_obj.payload.sub) core.request.add_header(ctx, "preferred_username", jwt_obj.payload.preferred_username) ``` 5. **修改`configmap`配置**:在`values.override.yaml`中添加以下内容: ```yaml 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" ``` 6. **更新apisix服务**:运行以下命令更新apisix服务: ```bash helm -n apisix upgrade ``` 7. **重新访问服务**:访问服务,请求头将出现sub和preferred_username扩展字段。 ## 其他提示 * 可以根据需要修改插件的配置,例如添加其他参数或修改验证逻辑。 * 可以将插件部署到不同的目录中,以便您可以管理多个插件。 * 可以使用 Kubernetes 的 `kubectl` 命令来管理插件配置。

正文

扩展apisix原始插件

当apisix提供的插件不能满足我们要求时,我们可能需要将它的plugin进行个性化扩展,例如一个jwt认证插件jwt-auth,它本身具有验证jwt有效性功能,支持rs256,hs256等常用签名算法,但在验证之后,如果希望将jwt中的用户信息取出来,并放请求头向上游传递,目前这个插件是不支持的,我们需要扩展一下它,下面看具体的步骤。

  1. 下载apisix源代码,找个原来的插件,在上面直接开发
  2. 找到_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)
  1. 将插件内容修改后,放到我们自己扩展的目录,文件名还是jwt-auth.lua
  2. 部署configmap,我们可以通过下面语句来实现由lua文件到configMap的导入
kubectl create configmap jwt-auth-app-header-config -n apisix --from-file=./jwt-auth-app-header.lua
  1. 在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"
  1. 升级你的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

与apisix~升级原始插件的方法相似的内容:

apisix~升级原始插件的方法

扩展apisix原始插件 当apisix提供的插件不能满足我们要求时,我们可能需要将它的plugin进行个性化扩展,例如一个jwt认证插件jwt-auth,它本身具有验证jwt有效性功能,支持rs256,hs256等常用签名算法,但在验证之后,如果希望将jwt中的用户信息取出来,并放请求头向上游传递

apisix~集成服务发现注册中心

摘要 当业务量发生变化时,需要对上游服务进行扩缩容,或者因服务器硬件故障需要更换服务器。如果网关是通过配置来维护上游服务信息,在微服务架构模式下,其带来的维护成本可想而知。再者因不能及时更新这些信息,也会对业务带来一定的影响,还有人为误操作带来的影响也不可忽视,所以网关非常必要通过服务注册中心动态获

apisix~自定义插件的部署

参考 https://docs.api7.ai/apisix/how-to-guide/custom-plugins/create-plugin-in-lua https://apisix.apache.org/docs/apisix/next/plugin-develop/ https://api

apisix~14在自定义插件中调用proxy_rewrite

在 Apache APISIX 中,通过 proxy-rewrite 插件来修改上游配置时,需要确保插件的执行顺序和上下文环境正确。你提到在自己的插件中调用 proxy_rewrite.rewrite({host="new_upstream"}, ctx),但新上游没有生效,这可能是由于以下几个原因

Apisix网关-使用Grafana可视化Apisix的Prometheus数据

Apisix安装部署 Apisix官网安装教程 Apisix Dashboard官网安装教程 本次教程使用RPM包安装方式 使用systemctl管理服务 Apisix配置要点 /usr/local/apisix/conf/config.yaml Apisix服务监听 etcd连接配置 admin_

apisix~authz-keycloak插件介绍

参考:https://apisix.apache.org/docs/apisix/plugins/authz-keycloak/ kc插件源码梳理及原理说明 如果只是进行keycloak颁发的token进行校验(签名校验和有效期校验),那么我们可以使用jwt-auth这个插件实现,并且已经对这个插件

apisix~lua插件开发与插件注册

开发插件的步骤 在APISIX中,要自定义插件,一般需要按照以下步骤进行操作: 编写Lua脚本:首先,你需要编写Lua脚本来实现你想要的功能。可以根据APISIX提供的插件开发文档和示例进行编写。 将Lua脚本放置到APISIX插件目录:将编写好的Lua脚本文件放置到APISIX的插件目录下,一般是

apisix~jwt-auth插件

在网关开启jwt-auth插件之后,你的网关就具有了jwt解析和校验的功能,主要是校验jwt token的有效性,包含过期时间和签名等。 https://apisix.apache.org/docs/apisix/plugins/jwt-auth/ 支持的签名算法 "HS256" "HS512" "

【转帖】使用 LuaRocks 安装 Apache APISIX 依赖项时,为什么会导致超时、安装缓慢或安装失败?

使用 LuaRocks 安装 Apache APISIX 依赖项时,为什么会导致超时、安装缓慢或安装失败?# http://apisix.incubator.apache.org/zh/docs/apisix/2.14/FAQ/ 可能是因为使用的 LuaRocks 服务器延迟过高。 为了解决这个问题