-
Kong Gateway Operator
Kong Gateway Operator is the Kubernetes-native way to interact with Kong. Deploy Data Planes, configure Konnect, and more.
-
Install Kong Gateway Operator
Install Kong Gateway Operator using Helm
-
Support Policy
Check if your version of Kong Gateway Operator is supported
-
Kong Gateway Operator Changelog
New features, bug fixes and breaking changes for Kong Gateway Operator
All Operator Documentation
-
Custom resource definitions
Explore schemas of the available Custom Resources for Kong Gateway Operator
-
Version compatibility
Understand which versions of Kong Ingress Controller, Kubernetes and the Gateway API Kong Gateway Operator works with
Get Started
-
Deploy Hybrid DataPlanes
Deploy Kong Gateway data planes using Kong Gateway Operator
-
Deploy Kong Ingress Controller
Use Kubernetes resources like `Gateway` to configure Kong Ingress Controller and Kong Gateway
Key Concepts
-
Gateway API
Understand how Kong Gateway Operator interacts with Gateway API resources
-
Gateway configuration
Customize your Kong Ingress Controller and Kong Gateway deployments when using the Gateway resource
-
Managed Gateways
Learn how Kong Gateway Operator reconciles `Gateway` resources, automatically configuring listeners as needed
-
Enterprise license
Provide your Kong Gateway license using the KongLicense CRD or as an environment variable
How-To
-
Set DataPlane Image
Customize the image used for Kong Gateway
-
Deploy sidecars
Deploy sidecar containers alongside Kong Gateway using PodTemplateSpec
-
Use a Custom CA Certificate
Use a custom CA certificate when generating Data Plane certificates for Konnect
-
Deploy custom plugins with Kong Gateway Operator
Package and deploy custom Kong plugins as OCI images using the Kong Gateway Operator and reference them in Kong Gateway resources.
Observability
-
Kong Gateway Operator metrics
See which metrics Kong Gateway Operator exposes and learn how to authenticate using a ServiceAccount to scrape the values
Advanced Usage
-
PodDisruptionBudget
Control the number of available pods during a rollout
-
PodTemplateSpec
Customize your ControlPlane and DataPlane deployments. Supports images, volume mounts, node affinity and more
-
Autoscaling Kong Gateway
Horizontally scale Kong Gateway based on CPU usage
-
Autoscaling workloads
Scale your Kubernetes workloads using latency information from Kong Gateway
Upgrading
-
Upgrade Kong Gateway Operator
Deploy a new version of Kong Gateway Operator using Helm
-
Rolling upgrades for Kong Gateway
Automatically terminate existing pods as new ones become ready
-
Blue/green upgrades for Kong Gateway
Create a new Kong Gateway Service any time your deployment changes, then promote it to be live after testing
Troubleshooting
-
Status
Inspect resource statuses to see detailed information about Kong Gateway Operator resources
Reference
-
KonnectExtension
Automatically register DataPlanes with Konnect by providing authentication credentials in KonnectExtension
-
Custom resource definitions
Explore schemas of the available Custom Resources for Kong Gateway Operator
Get Started
-
Apply Rate Limiting
Add rate limiting policies to a service or route using the `KongPlugin` CRD.
-
Create a Control Plane
Define a Konnect Gateway Control Plane and bind it to your cluster using a `KonnectExtension`.
-
Create a Service and Route
Provision a service and route in Konnect using Kubernetes CRDs.
-
Create API Authentication
Set up authentication between your Kubernetes cluster and Konnect using the `KonnectAPIAuthConfiguration` and `KonnectExtension` resources.
-
Enable Proxy Caching
Use the `KongPlugin` CRD to configure proxy caching for a route or service.
-
Install Kong Gateway Operator
Install the Kong Gateway Operatorwith Helm and enable Konnect CRD support.
-
Key Authentication
Secure an API using the `key-auth` plugin and credentials from a `KongConsumer`.
Key Concepts
-
Reconciliation loop
How does the Kong Gateway Operator reconciliation loop work?
-
Labelling and Tagging resources
How do I add additional metadata to entities managed by Kong Gateway Operator?
-
Understanding KongPluginBinding
What is KongPluginBinding, and how does it interact with the konghq.com/plugins annotation?
Konnect CRDs: Control Planes
-
Create a Control Plane
Create a Hybrid mode Control Plane in Konnect
-
Create a Control Plane Group
Create a Control Plane, and a Control Plane Group that contains the Control Plane
-
Create a Kong Ingress Controller Control Plane
Create a new Kong Ingress Controller Control Plane in Konnect
Konnect CRDs: Gateway
-
Create a Certificate and CA Certificate
Provision TLS and CA certificates in Konnect using Kubernetes CRDs, and assign SNIs to TLS certificates.
-
Create a Consumer and Consumer Group
Provision Consumers and manage Consumer Groups in Konnect using Kubernetes CRDs.
-
Create a Data Plane client certificate
Provision a Data Plane client certificate in Konnect using the `KongDataPlaneClientCertificate` CRD.
-
Create a Key and Key Set
Provision Keys and Key Sets in Konnect Gateway Manager using CRDs, and associate Keys with Key Sets.
-
Create a Service and Route
Provision and manage Gateway Services and Routes in Konnect using KGO custom resources.
-
Create a serviceless Route
Create a Kong Route that does not have an attached Service. Useful when used with the Lambda plugin.
-
Create a Vault
Provision a Vault in Konnect using the KongVault CRD and configure it for use with your Control Plane.
-
Create an Upstream and Target
Provision an Upstream and attach Targets to it in Konnect using Kubernetes CRDs.
Konnect CRDs: Cloud Gateways
-
Create a Cloud Gateway Data Plane group configuration
Provision a Dedicated Cloud Gateway Data Plane group configuration in Konnect using the `KonnectCloudGatewayDataPlaneGroupConfiguration` CRD.
-
Create a Cloud Gateway Network
Provision a Dedicated Cloud Gateway Network in Konnect using the `KonnectCloudGatewayNetwork` CRD.
Troubleshooting
-
Status Fields
How do I find out why my resources aren't being reconciled against Konnect?
Reference
-
Custom resource definitions
Explore schemas of the available Custom Resources for Kong Gateway Operator
-
FAQ
Answers to common questions about managing Konnect entities using the Operator.
-
Migrate Konnect DataPlanes from Kong Gateway Operator 1.4 to 1.5
How do I migrate from Kong Gateway Operator 1.4 to 1.5, taking in to account breaking changes?