Preserve client IP addresses

Deployment Platform
Related Documentation
TL;DR

Configure externalTrafficPolicy: Local in your GatewayConfiguration.

Prerequisites

If you don’t have a Konnect account, you can get started quickly with our onboarding wizard.

  1. The following Konnect items are required to complete this tutorial:
    • Personal access token (PAT): Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.
  2. Set the personal access token as an environment variable:

    export KONNECT_TOKEN='YOUR KONNECT TOKEN'

If you want cert-manager to issue and rotate the admission and conversion webhook certificates, install cert-manager to your cluster and enable cert-manager integration by passing the following argument while installing, in the next step:

   --set global.webhooks.options.certManager.enabled=true

If you do not enable this, the chart will generate and inject self-signed certificates automatically. We recommend enabling cert-manager to manage the lifecycle of these certificates. Kong Operator needs a certificate authority to sign the certificate for mTLS communication between the control plane and the data plane. This is handled automatically by the Helm chart. If you need to provide a custom CA certificate, refer to the certificateAuthority section in the values.yaml of the Helm chart to learn how to create and reference your own CA certificate.

Apply a KongLicense. This assumes that your license is available in ./license.json

echo "
apiVersion: configuration.konghq.com/v1alpha1
kind: KongLicense
metadata:
 name: kong-license
rawLicenseString: '$(cat ./license.json)'
" | kubectl apply -f -
kubectl create namespace kong --dry-run=client -o yaml | kubectl apply -f -
echo '
kind: KonnectAPIAuthConfiguration
apiVersion: konnect.konghq.com/v1alpha1
metadata:
  name: konnect-api-auth
  namespace: kong
spec:
  type: token
  token: "'$KONNECT_TOKEN'"
  serverURL: us.api.konghq.com
' | kubectl apply -f -

By default, when traffic enters a Kubernetes cluster through a Service of type LoadBalancer, the source IP is often replaced with the IP of the node (SNAT). This means your applications and access logs see the node’s IP instead of the client’s IP.

To preserve the client IP, you can configure the underlying Service to use externalTrafficPolicy: Local.

Create the kong namespace

Create the kong namespace in your Kubernetes cluster, which is where the demo will run:

kubectl create namespace kong --dry-run=client -o yaml | kubectl apply -f -

Create a GatewayConfiguration

Create a GatewayConfiguration that sets the externalTrafficPolicy to Local in the dataPlaneOptions:

echo '
apiVersion: gateway-operator.konghq.com/v2beta1
kind: GatewayConfiguration
metadata:
  name: preserve-client-ip
  namespace: kong
spec:
  konnect:
    authRef:
      name: konnect-api-auth
      namespace: kong
  dataPlaneOptions:
    network:
      services:
        ingress:
          externalTrafficPolicy: Local
          type: LoadBalancer' | kubectl apply -f -
echo '
apiVersion: gateway-operator.konghq.com/v2beta1
kind: GatewayConfiguration
metadata:
  name: preserve-client-ip
  namespace: kong
spec:
  dataPlaneOptions:
    network:
      services:
        ingress:
          externalTrafficPolicy: Local
          type: LoadBalancer' | kubectl apply -f -

Configure the Gateway

Create a GatewayClass resource that references the GatewayConfiguration, and a Gateway that references the GatewayClass:

echo '
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
  name: kong-external-traffic
spec:
  controllerName: konghq.com/gateway-operator
  parametersRef:
    group: gateway-operator.konghq.com
    kind: GatewayConfiguration
    name: preserve-client-ip
    namespace: kong
---
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
  name: kong-external-traffic
  namespace: kong
  annotations:
    gateway-operator.konghq.com/static-naming: "true"
spec:
  gatewayClassName: kong-external-traffic
  listeners:
  - name: http
    protocol: HTTP
    port: 80' | kubectl apply -f -
echo '
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
  name: kong-external-traffic
spec:
  controllerName: konghq.com/gateway-operator
  parametersRef:
    group: gateway-operator.konghq.com
    kind: GatewayConfiguration
    name: preserve-client-ip
    namespace: kong
---
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
  name: kong-external-traffic
  namespace: kong
spec:
  gatewayClassName: kong-external-traffic
  listeners:
  - name: http
    protocol: HTTP
    port: 80' | kubectl apply -f -

Validate

  1. Wait for the Gateway to be programmed. The operator creates the generated Service with it:

     kubectl wait --for=condition=Programmed gateway/kong-external-traffic -n kong --timeout=5m
  2. Check the generated Service for the externalTrafficPolicy setting:

    kubectl get service -n kong -l gateway-operator.konghq.com/dataplane-service-type=ingress -o jsonpath='{.items[0].spec.externalTrafficPolicy}'

    The output should be Local.

Cleanup

Deleting the Gateway also deletes the control plane and data plane resources Kong Operator created for it. Deleting the kong-system namespace removes the operator:

kubectl delete -n kong --ignore-not-found \
  gateway/kong-external-traffic \
  gatewayconfiguration/preserve-client-ip
kubectl delete --ignore-not-found gatewayclass/kong-external-traffic
kubectl delete --ignore-not-found namespace kong
helm uninstall kong-operator -n kong-system
kubectl delete --ignore-not-found namespace kong-system

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!