The module lifecycle stage: Preview
The module has requirements for installation

Does the module support receiving TCP traffic?

Yes. The module accepts and routes TCP traffic through the Gateway API using the TCPRoute object.

To publish a TCP service, do the following:

  1. Add an additional TCP port to the additionalPorts parameter of the ALBInstance or ClusterALBInstance inlet, specifying protocol: TCP.
  2. The gateway controller updates the list of listeners on the managed Gateway object.
  3. Create a TCPRoute object that references the backend Service object and points directly to the new TCP listener on that Gateway.

For configuration examples, see Opening an additional TCP/UDP port in the Administrator guide and GRPCRoute, TLSRoute, TCPRoute, and UDPRoute objects in the User guide.

Does the module support receiving UDP traffic?

Yes. The module accepts and routes UDP traffic through the Gateway API using the UDPRoute object.

To publish a UDP service, do the following:

  1. Add an additional UDP port to the additionalPorts parameter of the ALBInstance or ClusterALBInstance inlet, specifying protocol: UDP.
  2. The gateway controller updates the list of listeners on the managed Gateway object.
  3. Create a UDPRoute object that references the backend Service object and points directly to the new UDP listener on that Gateway.

A UDPRoute rule may reference only one backend Service object.

For configuration examples, see Opening an additional TCP/UDP port in the Administrator guide and GRPCRoute, TLSRoute, TCPRoute, and UDPRoute objects in the User guide.

How do I configure an external load balancer to check if the ClusterALBInstance/ALBInstance is available?

In case ClusterALBInstance/ALBInstance is deployed behind a load balancer, it is recommended that you configure your load balancer so that it would check the availability of the Instance’s endpoints via a health check mechanism, periodically sending either HTTP requests or TCP packets. While it is possible to test the endpoints simply by checking if a relevant TCP port is open, we recommend implementing HTTP checks with the following parameters:

  • Protocol: HTTP (if Proxy Protocol is enabled, configure the load balancer to use Proxy Protocol for health-check connections as well);
  • Path: /healthz;
  • Port: 80 (or relevant httpPort value in case of using HostPort inlet).