Estimated reading time:
You are browsing documentation for an outdated version of Kong Enterprise. Go here
to browse the documentation for the latest version.
For information about using Kong for Kubernetes Enterprise, see the documentation breakdown below. Most of this documentation is available on Github at kubernetes-ingress-controller/docs.
The design document explains how Kong Ingress Controller works inside a Kubernetes cluster and configures Kong to proxy traffic as per rules defined in the Ingress resources.
The Ingress resource in Kubernetes is a fairly narrow and ambiguous API, and does not offer resources to describe the specifics of proxying. To overcome this limitation, the KongIngress custom resource is used as an “extension” to the existing Ingress API.
A few custom resources are bundled with Kong Ingress Controller to configure settings that are specific to Kong and provide fine-grained control over the proxying behavior.
See the custom resources concept document for more details.
Kong Ingress Controller can be deployed in a variety of deployment patterns.
- See the deployment documentation, which compares the main deployment options for Kong Enterprise.
- Or, for information on all of the components involved and different ways of deploying them based on the use case, see the deployment documentation in the Kong Ingress Controller repository.
- For a list of which plugins are compatible with the different distributions of Kong Enterprise, see Plugin Compatibility.
- For compatibility between the versions of Kong Enterprise distributions and the Kong Ingress Controller, see Version Compatibility.
High-availability and scaling
The Kong Ingress Controller is designed to scale with your traffic and infrastructure. See High-availability and Scaling to understand failure scenarios, recovery methods, and scaling considerations.
See the Security document to understand the default security settings and how to further secure the Ingress Controller.
Guides and tutorials
Browse through guides to get started or understand how to configure a specific setting with Kong Ingress Controller.
The configurations in the Kong Ingress Controller can be customized using custom resources and annotations. See the following documents detailing this process:
FAQs are available to help find answers to quickly resolve common problems. Feel free to open Pull Requests to contribute to the list.
See the deployment guide for a detailed understanding of how Kong Ingress Controller is designed and deployed along alongside Kong.
Other resources include:
For a place to discuss and share Kong knowledge with the community, visit Kong Nation.