Estimated reading time:
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
doesn’t 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.
Please refer to custom resources concept document for more details.
Kong Ingress Controller can be deployed in a variety of deployment patterns.
Please refer to the deployment documentation,
which explains all the components
involved and different ways of deploying them based on the use-case.
High-availability and Scaling
The Kong Ingress Controller is designed to scale with your traffic
Please refer to this document to understand
failures scenarios, recovery methods, as well as scaling considerations.
Ingress classes filter which resources the
controller loads. They ensure that Kong Ingress Controller instances do not
load configuration intended for other instances or other ingress controllers.
Please refer to this document to understand the
default security settings and how to further secure the Ingress Controller.
Guides and Tutorials
Please 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 tweaked using
Custom Resources and annotations.
Please refer to the following documents detailing this process:
FAQs will help find answers to common problems quickly.
Please feel free to open Pull Requests to contribute to the list.
Please read through our deployment guide for a detailed
understanding of how Ingress Controller is designed and deployed
along alongside Kong.
- FAQs might help as well.
- Troubleshooting guide can help
resolve some issues.
Please contribute back if you feel your experience can help
the larger community.