You are browsing unreleased documentation. See the latest documentation here.

Preserve Client IP

Kong is deployed using a Kubernetes Service of type LoadBalancer. This can result in the loss of the actual Client IP address, and lead to Kong observing the IP address of the Load Balancer as the client IP address. This guide lays out different methods of solving this problem.

Preserving the Client IP address in the cloud behind Load Balancers requires configuration that is specific to your use-case, cloud provider and other architecture details. Using Source IP provides details on how networking works inside Kubernetes and explains in detail the various methods work. It is recommended that you give this a read.

To preserve Client IP address you can use one of these methods:

ExternalTrafficPolicy
Proxy Protocol
HTTP headers

ExternalTrafficPolicy: Local

As explained in the Kubernetes docs, setting service.spec.externalTrafficPolicy to Local preserves the Client IP address. You don’t need to change any configuration in Kong if you are using this method to preserve Client IP address.

This method is not supported by all Cloud providers.

Proxy Protocol

If you have an L4 Load Balancer that supports Proxy Protocol, and you’re terminating TCP connections at the Load Balancer before passing traffic onward to Kong, then you can configure Kong to set the Client IP address through this protocol.

Once you have configured the Load Balancer to use Proxy Protocol, you need to set the following environment variables in Kong to receive the Client IP from the Proxy Protocol header.

For example:

KONG_TRUSTED_IPS=0.0.0.0/0,::/0  # This trusts all IPs
KONG_PROXY_LISTEN="0.0.0.0:8000 proxy_protocol, 0.0.0.0:8443 ssl proxy_protocol"
KONG_REAL_IP_HEADER=proxy_protocol

HTTP headers

If you are using an L7 Load Balancer where HTTP requests are being terminated at the Load Balancer, you need to use the x-forwarded-for or x-real-ip header to preserve details of the connection between the Client and Load Balancer.

You should configure the Load Balancer to inject these headers, and then you need to set the following environment variables in Kong to pick up the Client IP address from HTTP headers:

Cloud-provider specific details

For the major public clouds, follow are some additional details that can help you preserve the client IP address:

GKE

You can use ExternalTrafficPolicy: Local to preserve the Client IP address.

AKS

You can use ExternalTrafficPolicy: Local to preserve the Client IP address.

EKS

You have three options:

L4 Network Load Balancer, with AWS Load Balancer Controller: In this case, you can use the Proxy Protocol method to preserve the client IP address together with ExternalTrafficPolicy: Cluster.
L4 in-tree network Load Balancer with the service.beta.kubernetes.io/aws-load-balancer-type: nlb annotation: In this case you need to use ExternalTrafficPolicy: Local to preserve the client IP address.
L7 Load Balancer: In this case, you need to use the HTTP headers method to preserve the client IP address.

The recommended Load Balancer type for AWS is the Network Load Balancer deployed with the AWS Load Balancer Controller. You can choose this type of Load Balancer using the following annotations:

service.beta.kubernetes.io/aws-load-balancer-scheme: internet-facing
service.beta.kubernetes.io/aws-load-balancer-type: "external"
service.beta.kubernetes.io/aws-load-balancer-nlb-target-type: "instance"

To enable proxy protocol with the AWS Load Balancer Controller, you need to set these annotations:

service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: "*"

A list of annotations for the AWS Load Balancer Controller can be found here.