-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Description
Describe the feature you are requesting
Add documentation for Gateway API that explains how to achieve route ordering/priority behavior equivalent to the alb.ingress.kubernetes.io/group.order annotation available for Ingress resources.
Motivation
Users migrating from Ingress to Gateway API lose the ability to explicitly control rule evaluation order using group.order. The current Gateway API documentation doesn't address:
- How the controller determines rule priority when multiple HTTPRoutes attach to the same Gateway listener
- Whether the
ListenerRuleConfigurationCRD can be used to set explicit rule priorities - Best practices for achieving deterministic rule ordering across multiple HTTPRoutes
- Migration guidance for users who relied heavily on
group.orderfor complex routing scenarios
This is a common pattern in multi-team environments where different teams own different HTTPRoutes but need predictable rule precedence (e.g., ensuring a catch-all route from one team doesn't shadow more specific routes from another team).
Describe the proposed solution you'd like
Add a section to the Gateway API documentation (potentially under docs/guide/gateway/) that covers:
- Rule precedence behavior: How the LBC determines ALB listener rule priority when reconciling multiple HTTPRoutes
- Explicit priority control: Whether a
priorityfield exists or is planned forListenerRuleConfiguration(similar to how Ingress usesgroup.order) - Workarounds: Patterns for achieving predictable ordering using path specificity, match conditions, or route consolidation
- Migration guide: A mapping table showing Ingress annotation patterns and their Gateway API equivalents, specifically addressing
group.order
Describe alternatives you've considered
- Opening a feature request for adding a
priorityfield toListenerRuleConfigurationor as an annotation on HTTPRoute (if explicit ordering isn't currently supported) - Relying solely on Gateway API spec's implicit precedence rules (path specificity, hostname matching), though this may not cover all use cases
Contribution Intention (Optional)
- Yes, I am willing to contribute a PR to implement this feature
- No, I cannot work on a PR at this time