跳到主要内容
版本:3.8.x

Ingress 和 Gateway API 支持情况

本文概述 API7 Ingress Controller 支持的 Kubernetes Gateway API 和 Ingress API 资源,可用于了解当前已实现的资源。

请参阅配置示例,了解何时以及如何使用这些资源。

Gateway API​

软件包​

资源支持级别​

下表列出当前实现对 Kubernetes Gateway API 资源的支持级别。每种资源均按核心、扩展和实现特定功能的支持级别以及对应的 API 版本分类。

资源核心扩展实现特定API 版本
GatewayClass支持不适用不支持v1
Gateway部分支持部分支持不支持v1
HTTPRoute支持部分支持不支持v1
GRPCRoute支持支持不支持v1
ReferenceGrant支持不支持不支持v1beta1
TLSRoute支持支持不支持v1alpha2
TCPRoute支持支持不支持v1alpha2
UDPRoute支持支持不支持v1alpha2
BackendTLSPolicy不支持不支持不支持v1alpha3

完整的配置选项列表请参阅 Gateway API 参考文档。请注意,部分字段不受支持或仅得到部分支持。

不支持或部分支持的字段​

以下字段在 Gateway API 规范中定义,但 APISIX Ingress Controller 尚未实现或仅部分实现。

HTTPRoute​

字段状态说明
spec.timeouts不支持该字段不受支持,因为 ADC 提供粒度更细的超时配置(连接、读取、写入),而 spec.timeouts 只允许配置总超时和上游超时,无法直接映射。要配置路由超时,可以使用 BackendTrafficPolicy。
spec.retries不支持该字段不受支持,因为 APISIX 不支持 retries 中的功能。要配置路由重试,可以使用 BackendTrafficPolicy。
spec.sessionPersistence不支持APISIX 不支持配置 Cookie 生命周期。可以改用 chash 负载均衡器。
spec.rules[].backendRefs[].filters[]不支持数据面不支持在 BackendRef 级别进行过滤,因此尚未实现该级别的过滤器;仅支持规则级别的过滤器(spec.rules[].filters[])。

Gateway​

字段状态说明
spec.listeners[].port不支持*该配置为必填项,但会被忽略。这是由于数据面的限制:它无法动态开放新端口。Ingress Controller 不管理数据面的部署,因此无法自动更新配置或重启数据面来应用端口变更。
spec.listeners[].tls.certificateRefs[].group部分支持仅支持 "";其他 group 值会导致校验失败。
spec.listeners[].tls.certificateRefs[].kind部分支持仅支持 Secret。
spec.listeners[].tls.mode部分支持已实现 Terminate;Gateway 监听器实际上不支持 Passthrough。
spec.addresses不支持控制器不会读取 spec.addresses,也不会据此执行操作。

HTTP 路由过滤器​

Ingress Controller 将 HTTPRoute 资源中的标准 Gateway API 过滤器映射到相应插件:

Gateway API 过滤器APISIX 插件
RequestHeaderModifierproxy-rewrite
RequestRedirectredirect
RequestMirrorproxy-mirror
URLRewriteproxy-rewrite
ResponseHeaderModifierresponse-rewrite
CORScors
ExtensionRef通过 PluginConfig 使用用户定义的插件

同时使用标准过滤器和 ExtensionRef(引用 PluginConfig CRD)时:

  • 如果先应用标准过滤器,PluginConfig 会覆盖其中重叠的插件设置。
  • 如果先应用 PluginConfig,标准过滤器会合并到其配置中,并覆盖重叠的字段。

Ingress​

软件包​

  • networking.k8s.io/v1

支持的资源​

控制器支持标准 Kubernetes Ingress API,包括:

支持基于主机和路径的基本路由。高级注解或非标准扩展可能尚未实现。

完整的受支持注解列表请参阅 Ingress 注解。