gateway-api-compatibility.md

Gateway API Compatibility(v0.5.1)

This document describes which Gateway API resources BIG-IP Kubernetes Gateway supports and the extent of that support.

Summary

Resource	Support Status
GatewayClass	Partially supported
Gateway	Partially supported
HTTPRoute	Partially supported
ReferenceGrant	Support
TLSRoute	Not supported, experimental in v0.6.2
TCPRoute	Not supported, experimental in v0.6.2
UDPRoute	Not supported, experimental in v0.6.2

Terminology

We use the following words to describe support status:

• Supported. The resource or field is fully supported and conformant to the Gateway API specification.
• Partially supported. The resource or field is supported partially or with limitations. It will become fully supported in future releases.
• Not supported. The resource or field is not yet supported. It will become partially or fully supported in future releases.

Note: it might be possible that BIG-IP Kubernetes Gateway will never support some resources and/or fields of the Gateway API. We will document these decisions on a case by case basis.

Resources

Below we list the resources and the support status of their corresponding fields.

For a description of each field, visit the Gateway API documentation.

GatewayClass

Status: Partially supported.

BIG-IP Kubernetes Gateway supports the coexistence of multiple gatewayClasses, and their controllerName field determines which controller handles this gatewayclass resource. Each GatewayClass is represented as an independent partition on BIG-IP.

Fields:

• spec
  • controllerName - supported.
  • parametersRef - will not support.
  • description - not supported.
• status - not supported.

Gateway

Status: Partially supported.

BIG-IP Kubernetes Gateway supports most Gateway Spec definitions. The Gateway resource will be parsed as a virtual resource on the BIG-IP device as an application entry for external connections.

Fields:

• spec
  • gatewayClassName - supported.
  • listeners
    • name - supported.
    • hostname - not supported.
    • port - supported.
    • protocol - partially supported. Allowed values: HTTP, HTTPS.
    • tls - supported.
      • mode - supported.
      • certificateRefs - supported.
      • options - not supported.
    • allowedRoutes - supported.
  • addresses - partially upported.
    • type IPAddress: supported.
    • type Hostname: will not support.
    • type NamedAddress: will not support.
• status
  • addresses - not supported.
  • conditions - not supported.
  • listeners
    • name - not supported.
    • supportedKinds - not supported.
    • attachedRoutes - not supported.
    • conditions - not supported.

HTTPRoute

Status: Partially supported.

Fields:

• spec
  • parentRefs - partially supported.
    • group kind: partially supported, only for Gateway.
    • namespace name: supported.
    • sectionName supported.
    • port: will not support.
  • hostnames - supported.
  • rules
    • matches
      • path - supported.
      • headers - supported.
      • queryParams - supported.
      • method - supported.
    • filters
      • requestRedirect - supported.
      • requestHeaderModifier - supported.
      • responseHeaderModifier - supported.
      • requestMirror - not supported.
      • urlRewrite - supported, experimental.
      • extensionRef - partially supported, only v1.Service.
    • backendRefs - partially supported.
      • group kind partially supported. only v1.Service.
      • Backend ref filters will not support.
• status - not supported.
  • parents - not supported.
    • parentRef - not supported.
    • controllerName - not supported.
    • conditions - not supported.

ReferenceGrant

Status: Supported(since v0.2.0).

Support the reference grants:

• from Gateway to Secret
• from HTTPRoute to Service

TLSRoute

Status: Not supported.

TCPRoute

Status: Not supported.

UDPRoute

Status: Not supported.