Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
Kong Logo | Kong Docs Logo
  • Docs
    • Explore the API Specs
      View all API Specs View all API Specs View all API Specs arrow image
    • Documentation
      API Specs
      Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong AI Gateway
      Multi-LLM AI Gateway for GenAI infrastructure
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      AI's icon
      AI
      Govern, secure, and control AI traffic with multi-LLM AI Gateway plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Ingress Controller
3.2.x
  • Home icon
  • Kong Ingress Controller
  • Concepts
  • Custom Resources
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Kong AI Gateway
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • unreleased
  • 3.4.x (latest) (LTS)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.12.x (LTS)
  • 2.11.x
  • 2.10.x
  • 2.9.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • 2.5.x (LTS)
  • Introduction
    • Overview
    • Kubernetes Gateway API
    • Version Support Policy
    • Changelog
  • How KIC Works
    • Architecture
    • Gateway API
    • Ingress
    • Custom Resources
    • Using Annotations
    • Admission Webhook
  • Get Started
    • Install KIC
    • Services and Routes
    • Rate Limiting
    • Proxy Caching
    • Key Authentication
  • KIC in Production
    • Deployment Topologies
      • Overview
      • Gateway Discovery
      • Database Backed
      • Traditional (sidecar)
    • Installation Methods
      • Helm
      • Kong Gateway Operator
    • Cloud Deployment
      • Azure
      • Amazon
      • Google
    • Enterprise License
    • Observability
      • Prometheus Metrics
      • Configuring Prometheus and Grafana
      • Kubernetes Events
    • Upgrading
      • Kong Gateway
      • Ingress Controller
  • Guides
    • Service Configuration
      • HTTP Service
      • TCP Service
      • UDP Service
      • gRPC Service
      • TLS
      • External Service
      • HTTPS Redirects
      • Multiple Backend Services
      • Configuring Gateway API resources across namespaces
      • Configuring Custom Kong Entities
    • Request Manipulation
      • Rewriting Hosts and Paths
      • Rewrite Annotation
      • Customizing load-balancing behavior
    • High Availability
      • KIC High Availability
      • Service Health Checks
      • Last Known Good Config
      • Fallback Configuration
    • Security
      • Kong Vaults
      • Using Workspaces
      • Preserving Client IP
      • Kubernetes Secrets in Plugins
    • Migrate
      • KongIngress to KongUpstreamPolicy
      • Migrating from Ingress to Gateway
      • Credential Type Labels
    • Customize Deployments
      • Images
    • Custom Ingress Class
      • Internal / External Traffic
  • Plugins
    • Custom Plugins
    • Cross-namespace Plugins
    • Authentication
    • ACL
    • Rate Limiting
    • mTLS
    • OIDC
  • Reference
    • Troubleshooting
    • Version Compatibility
    • Annotations
    • Configuration Options
    • Feature Gates
    • FAQ
      • Plugin Compatibility
      • Kong Router
      • Custom nginx.conf
    • Custom Resource Definitions
    • Resources Requiring Setting Ingress Class
    • Gateway API migration
    • Required Permissions for Installation
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • KongIngress
  • KongPlugin
  • KongClusterPlugin
  • KongConsumer
  • TCPIngress
  • UDPIngress
  • KongConsumerGroup
You are browsing documentation for an older version. See the latest documentation here.

Custom Resources

Custom Resources in Kubernetes allow controllers to extend Kubernetes-style declarative APIs that are specific to certain applications.

A few custom resources are bundled with the Kong Ingress Controller to configure settings that are specific to Kong and provide fine-grained control over the proxying behavior.

The Kong Ingress Controller uses the configuration.konghq.com API group for storing configuration specific to Kong.

These CRDs allow users to declaratively configure all aspects of Kong:

  • KongIngress
  • KongPlugin
  • KongClusterPlugin
  • KongConsumer
  • KongConsumerGroup
  • TCPIngress
  • UDPIngress

KongIngress

Note: Many fields available on KongIngress are also available as annotations. You can add these annotations directly to Service and Ingress resources without creating a separate KongIngress resource. When an annotation is available, it is the preferred means of configuring that setting, and the annotation value takes precedence over a KongIngress value if both set the same value.

The standard Ingress and Service Kubernetes resources can’t express the full range of Kong’s routing capabilities. You can use KongIngress to extend these resources.

KongIngress is a custom resource that attaches to Ingresses and Services and allows them to control all settings on the Kong routes, services, and upstreams generated for them. KongIngress is not an alternative to Ingress. It can’t be used independently and only functions when attached to another resource.

Once a KongIngress resource is created, you can use the konghq.com/override annotation to associate the KongIngress resource with an Ingress or a Service resource.

  • Annotated Ingress resource: All routes associated with the annotated Ingress are updated to use the values defined in the KongIngress’s route section.
  • Annotated Service resource: The corresponding service and upstream in Kong are updated to use the proxy and upstream blocks as defined in the associated KongIngress resource.

Don’t attach a KongIngress that sets values in the proxy and upstream sections to an Ingress, as it won’t have any effect. These sections are only honored when a KongIngress is attached to a Service. Similarly, the route section has no effect when attached to a Service, only when attached to an Ingress.

This diagram shows how the resources are linked with one another.

KongPlugin

Kong is designed around an extensible plugin architecture and comes with a wide variety of plugins already bundled inside it. These plugins can be used to modify the request or impose restrictions on the traffic.

Once this resource is created, the resource needs to be associated with an Ingress, Service, HTTPRoute, KongConsumer or KongConsumerGroup resource in Kubernetes.

This diagram shows how you can link a KongPlugin resource to an Ingress, Service, or KongConsumer.

 
flowchart TD
    subgraph Link to consumer
        direction TB
        E(apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
   name: custom-api-limit
plugin: rate-limiting
config:
   minute: 10):::left F(apiVersion: configuration.konghq.com
kind: KongConsumer
metadata:
   name: demo-api
   annotations:
      konghq.com/plugins: custom-api-limit
username: special-client):::left end subgraph Link to Ingress and service direction TB A(apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
   name: reports-api-limit
plugin: rate-limiting
config:
   minute: 5):::left B(apiVersion: extensions/v1beta1
kind: Ingress
metadata:
   name: demo-api
   annotations:
      konghq.com/plugins: reports-api-limit):::left C(apiVersion: v1
kind: Service
metadata:
   name: billing-api
   annotations:
      konghq.com/plugins: billing-auth):::left D(apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
   name: billing-auth
plugin: basic auth):::left end A --> |execute the plugin for any request that matches a rule in the following ingress resource|B B --> C D --> |execute the plugin for any request that is forwarded to the billing-api service in k8s|C E --> |Associated using konghq.com/plugins annotation|F classDef left text-align:left; classDef lightBlue fill:#cce7ff; classDef lightGreen fill:#c4e1c4; classDef lightPurple fill:#e6d8eb; class B lightGreen; class C lightBlue; class F lightPurple;

KongClusterPlugin

This resource requires the kubernetes.io/ingress.class annotation.

KongClusterPlugin resource is exactly same as KongPlugin, except that it is a Kubernetes cluster-level resources rather than a namespaced resource. This can help when the configuration of the plugin needs to be centralized and the permissions to add or update plugin configuration rests with a different persona other than the application owners.

This resource can be associated with an Ingress, Service, or KongConsumer, and can be used in the exact same way as KongPlugin.

A namespaced KongPlugin resource takes priority over a KongClusterPlugin with the same name.

KongConsumer

This resource requires the kubernetes.io/ingress.class annotation. Its value must match the value of the controller’s --ingress-class argument, which is kong by default.

This custom resource configures consumers in Kong. Every KongConsumer resource in Kubernetes directly translates to a Consumer object in Kong.

TCPIngress

This resource requires the kubernetes.io/ingress.class annotation. Its value must match the value of the controller’s --ingress-class argument, which is kong by default.

This Custom Resource is used for exposing non-HTTP and non-GRPC services running inside Kubernetes to the outside world through Kong. This proves to be useful when you want to use a single cloud LoadBalancer for all kinds of traffic into your Kubernetes cluster.

It is very similar to the Ingress resource that ships with Kubernetes.

UDPIngress

This resource requires the kubernetes.io/ingress.class annotation. Its value must match the value of the controller’s --ingress-class argument, which is kong by default.

This Custom Resource is used for exposing UDP services running inside Kubernetes to the outside world through Kong.

This is useful for services such as DNS servers, Game Servers, VPN software and a variety of other applications.

KongConsumerGroup
Available with Kong Gateway Enterprise subscription - Contact Sales

This feature requires Kong Gateway Enterprise 3.4 or higher. It is not compatible with the older consumer groups implementation introduced in Kong Gateway Enterprise 2.7.

This resource requires the kubernetes.io/ingress.class annotation. Its value must match the value of the controller’s --ingress-class argument, which is kong by default.

KongConsumerGroup creates a consumer group, which associates KongPlugin resources with a collection of KongConsumers.

KongConsumers have a consumerGroups array. Adding a KongConsumerGroup’s name to that array adds that consumer to that consumer group.

Applying a konghq.com/plugins: <KongPlugin name> annotation to a KongConsumerGroup then executes that plugin on every consumer in the consumer group.

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    Powering the API world

    Increase developer productivity, security, and performance at scale with the unified platform for API management, service mesh, and ingress controller.

    • Products
      • Kong Konnect
      • Kong Gateway Enterprise
      • Kong Gateway
      • Kong Mesh
      • Kong Ingress Controller
      • Kong Insomnia
      • Product Updates
      • Get Started
    • Documentation
      • Kong Konnect Docs
      • Kong Gateway Docs
      • Kong Mesh Docs
      • Kong Insomnia Docs
      • Kong Konnect Plugin Hub
    • Open Source
      • Kong Gateway
      • Kuma
      • Insomnia
      • Kong Community
    • Company
      • About Kong
      • Customers
      • Careers
      • Press
      • Events
      • Contact
  • Terms• Privacy• Trust and Compliance
© Kong Inc. 2025