You are browsing documentation for an older version. See the latest documentation here.

Annotations

Kong Ingress Controller uses annotations to add functionality to various Kubernetes resources. Annotations are used when there is not a standardized way to configure the required functionality.

Annotations can be added to a route Ingress or Gateway API resource such as HTTPRoute, Service or KongConsumer.

The most commonly used annotations are:

• konghq.com/plugins - Add plugins to Ingress, Service, HTTPRoute, KongConsumer or KongConsumerGroup
• konghq.com/strip-path - Strip the path defined in the route and then forward the request to the upstream service
• konghq.com/methods - Match specific HTTP methods in the route
• konghq.com/headers.* - Require specific headers in the incoming request to match the defined route

See the annotations reference page for a complete list of available annotations and related documentation.