APISIX Ingress 的自定义插件机制初体验

2023-10-10 14:02:19

前言

APISIX Ingress 是一个 Kubernetes Ingress 控制器，可以将请求转发到 APISIX 网关。它允许您使用 Kubernetes Ingress 资源来配置 APISIX 网关，从而简化了网关的管理和配置。

APISIX Ingress 内置了多种插件，用于实现各种网络访问控制和流量管理功能。但有时，我们需要使用自定义插件来实现更复杂的业务需求。本文将带领大家了解 APISIX Ingress 如何支持自定义插件，如何开发和加载自定义插件，以及如何在 Ingress 资源上使用自定义插件。

APISIX Ingress 的插件机制

APISIX Ingress 的插件机制允许您扩展 APISIX 网关的功能，从而实现更丰富的网络访问控制和流量管理功能。插件可以是任何实现了 APISIX 插件接口的代码。

APISIX Ingress 提供了两种加载自定义插件的方式：

通过环境变量 APISIX_PLUGIN_PATH 指定插件路径。
通过 Kubernetes ConfigMap 加载插件。

无论使用哪种方式加载插件，都需要先将插件打包成一个 tar.gz 压缩包，然后将压缩包放置到指定的插件路径或 ConfigMap 中。

如何开发自定义插件

要开发自定义插件，您需要先创建一个新的 Go 项目，然后在项目中创建一个实现了 apisix.Plugin 接口的结构体。apisix.Plugin 接口定义了以下方法：

Init()：插件初始化方法，用于初始化插件。
Name()：插件名称，用于标识插件。
Phases()：插件阶段，用于指定插件在哪些阶段执行。
Handler()：插件处理方法，用于处理请求或响应。

您可以参考 APISIX 官方提供的插件开发指南来开发自定义插件。

如何加载自定义插件

开发好自定义插件后，需要将插件加载到 APISIX Ingress 中。您可以通过以下两种方式之一来加载插件：

通过环境变量 APISIX_PLUGIN_PATH 指定插件路径。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: apisix-ingress-controller
  namespace: apisix-ingress-ns
spec:
  template:
    spec:
      containers:
      - name: apisix-ingress-controller
        image: apisix/apisix-ingress-controller:latest
        env:
        - name: APISIX_PLUGIN_PATH
          value: /path/to/plugins

通过 Kubernetes ConfigMap 加载插件。

apiVersion: v1
kind: ConfigMap
metadata:
  name: apisix-ingress-plugins
  namespace: apisix-ingress-ns
data:
  plugin.tar.gz: |
    # 这里放置插件的 tar.gz 压缩包的内容

apiVersion: apps/v1
kind: Deployment
metadata:
  name: apisix-ingress-controller
  namespace: apisix-ingress-ns
spec:
  template:
    spec:
      containers:
      - name: apisix-ingress-controller
        image: apisix/apisix-ingress-controller:latest
        volumeMounts:
        - name: apisix-ingress-plugins
          mountPath: /path/to/plugins
      volumes:
      - name: apisix-ingress-plugins
        configMap:
          name: apisix-ingress-plugins

如何在 Ingress 资源上使用自定义插件

加载好自定义插件后，您就可以在 Ingress 资源上使用这些插件了。您可以在 Ingress 资源的 annotations 字段中指定要使用的插件，以及插件的配置参数。

例如，要在一个 Ingress 资源上使用 my-plugin 插件，可以这样配置：

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: my-ingress
  annotations:
    kubernetes.io/ingress.class: apisix
    apisix.ingress.kubernetes.io/plugins: my-plugin