You are browsing documentation for an outdated version. See the latest documentation here.

Installing Gateway APIs

This feature is released as a beta and should not be deployed in a production environment.

The Gateway APIs are an upcoming set of Kubernetes APIs developed by Kubernetes SIG-NETWORK. They expand on and refine the concepts introduced by the Ingress APIs. In addition to revised HTTP routing APIs, they provide standardized resources representing gateway configuration and layer 4 (TCP and UDP) routing configuration.

The Gateway APIs are currently a draft standard and are not available by default in Kubernetes installations. To use them, you must install the Gateway APIs resource definitions and admission controller.

Kubernetes Ingress Controller automatically disables support for non-standard resources if they are not available when starting. You must restart Kubernetes Ingress Controller after installing Gateway APIs for it to recognize those resources:

kubectl rollout restart -n NAMESPACE deployment DEPLOYMENT_NAME

Response:

deployment.apps/DEPLOYMENT_NAME restarted

Using alpha APIs

This feature is released as a tech preview (alpha-quality) and should not be deployed in a production environment.

Layer 4 routes (TCPRoute, UDPRoute, TLSRoute) are currently only available in the Gateway APIs experimental channel.

These APIs require version 2.6 or later. To use them on a supported version, install the experimental channel CRDs and enable the corresponding feature gate in Kubernetes Ingress Controller:

kubectl set env -n kong deployment/ingress-kong CONTROLLER_FEATURE_GATES="GatewayAlpha=true" -c ingress-controller

Response:

deployment.apps/ingress-kong env updated

If you also use other feature gates, include them as well. The command above replaces the entire CONTROLLER_FEATURE_GATES value.