For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.
Examples
Walk through worked examples that convert common Ingress NGINX configurations to kgateway.
This section contains step-by-step examples showing how to migrate common Ingress NGINX configurations to kgateway using the ingress2gateway tool.
Each example walks through the following steps:
- Creating a sample Ingress manifest.
- Running
ingress2gatewayto convert it. - Reviewing the generated Gateway API and kgateway resources.
- Applying them to your cluster.
Pick the example that matches your use case, or work through them all to get familiar with the migration workflow.
Basic Ingress
Convert a simple Ingress resource to a Gateway and HTTPRoute.
Session Affinity
Convert Ingress NGINX session affinity annotations to a kgateway BackendConfigPolicy.
Rate Limiting
Convert Ingress NGINX rate limit annotations to a kgateway TrafficPolicy.
Basic Auth
Convert NGINX basic authentication annotations to a kgateway TrafficPolicy with basicAuth.
JWT Authentication
Convert NGINX Plus JWT authentication to a kgateway GatewayExtension and TrafficPolicy.
API Key Authentication
Convert an NGINX API key check to a kgateway TrafficPolicy with native apiKeyAuth.
OIDC Authentication
Convert an NGINX oauth2-proxy setup to native kgateway OIDC with a GatewayExtension and …
Header Modifiers
Convert NGINX header directives to a Gateway API HTTPRoute RequestHeaderModifier filter.
Timeouts
Convert NGINX proxy timeout annotations to kgateway TrafficPolicy and BackendConfigPolicy timeouts.
URL Rewriting
Convert the NGINX rewrite-target annotation to a Gateway API HTTPRoute URLRewrite filter.
Request Buffering
Convert the NGINX proxy-body-size annotation to a kgateway TrafficPolicy buffer limit.
Traffic Mirroring
Convert the NGINX mirror-target annotation to a Gateway API HTTPRoute RequestMirror filter.
Client TLS (mTLS)
Convert NGINX client certificate verification to Gateway API frontendValidation (mTLS).
CORS
Convert Ingress NGINX CORS annotations to a kgateway TrafficPolicy.
SSL Redirect
Convert Ingress NGINX SSL redirect annotations to an HTTPRoute RequestRedirect filter.
External Auth
Convert Ingress NGINX auth-url annotations to a kgateway external auth GatewayExtension.
Canary Deployments
Convert Ingress NGINX canary annotations to weighted HTTPRoute backends.
Backend TLS
Convert Ingress NGINX backend TLS annotations to a kgateway BackendConfigPolicy.