Clarify HTTPRouteMatch rules #3741

vehagn · 2025-04-09T11:22:16Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Documentation clarification of the HTTPRouteMatch rules.

The documentation links to the following example HTTPRoute

gateway-api/examples/standard/basic-http.yaml

Lines 25 to 57 in 3222422

    
           apiVersion: gateway.networking.k8s.io/v1 
        
           kind: HTTPRoute 
        
           metadata: 
        
             name: http-app-1 
        
           spec: 
        
             parentRefs: 
        
             - name: my-gateway 
        
             hostnames: 
        
             - "foo.com" 
        
             rules: 
        
             - matches: 
        
               - path: 
        
                   type: PathPrefix 
        
                   value: /bar 
        
               backendRefs: 
        
               - name: my-service1 
        
                 port: 8080 
        
             - matches: 
        
               - headers: 
        
                 - type: Exact 
        
                   name: magic 
        
                   value: foo 
        
                 queryParams: 
        
                 - type: Exact 
        
                   name: great 
        
                   value: example 
        
                 path: 
        
                   type: PathPrefix 
        
                   value: /some/thing 
        
                 method: GET 
        
               backendRefs: 
        
               - name: my-service2 
        
                 port: 8080

with a rules.matches entry with three elements: headers, queryParams and path.

From the current wording it is unclear if you need to match the queryParams criterion or not.
My understand from reading the Matches section and HTTPRouteMatch documentation is that you need to match all criteria (headers, queryParams, and path) in order to be forwarded to the "my-service2" backend on port 8080.

Alternatively the basic-http.yaml example can be modified to remove to queryParams rule.

If my understanding is wrong I'd be happy to update the documentation with the correct logic.

Does this PR introduce a user-facing change?:

NONE

Signed-off-by: Vegard Hagen <[email protected]>

k8s-ci-robot · 2025-04-09T11:22:25Z

Welcome @vehagn!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-04-09T11:22:26Z

Hi @vehagn. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

mikemorris · 2025-04-09T13:39:12Z

site-src/api-types/httproute.md

 The following example forwards HTTP requests for prefix `/bar` to service
 "my-service1" on port `8080` and HTTP requests for prefix `/some/thing` with
-header `magic: foo` to service "my-service2" on port `8080`:
+header `magic: foo` **AND** query param `great: example` to service "my-service2" on port `8080`:


Suggested change

header `magic: foo` **AND** query param `great: example` to service "my-service2" on port `8080`:

method `GET`, header `magic: foo` **AND** query param `great: example` to

service "my-service2" on port `8080`:

Thanks! I completely missed that last one. I'd prefer to explicitly list all four criteria instead of a somewhat convoluted sentence.

mikemorris

Good catch, thanks @vehagn! We should mention the HTTP method too, as these are all ANDed together.

/ok-to-test

also try to use more clear language Signed-off-by: Vegard Hagen <[email protected]>

mikemorris · 2025-04-09T20:01:37Z

/lgtm

vehagn · 2025-04-09T20:05:19Z

/assign danwinship

danwinship · 2025-04-10T12:44:23Z

lol why am I an approver? 😬
I guess if Mike says it's right then
/approve

k8s-ci-robot · 2025-04-10T12:44:34Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danwinship, mikemorris, vehagn

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~site-src/OWNERS~~ [danwinship]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

docs: clarify HTTPRouteMatch rules

f2c2311

Signed-off-by: Vegard Hagen <[email protected]>

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Apr 9, 2025

k8s-ci-robot requested a review from mikemorris April 9, 2025 11:22

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 9, 2025

k8s-ci-robot requested a review from mlavacca April 9, 2025 11:22

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 9, 2025

mikemorris reviewed Apr 9, 2025

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 9, 2025

docs: add missing criterion in HTTPRouteMatch rules

82aafc4

also try to use more clear language Signed-off-by: Vegard Hagen <[email protected]>

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 9, 2025

mikemorris approved these changes Apr 9, 2025

View reviewed changes

k8s-ci-robot assigned mikemorris Apr 9, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 9, 2025

k8s-ci-robot assigned danwinship Apr 9, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 10, 2025

k8s-ci-robot merged commit 36514bb into kubernetes-sigs:main Apr 10, 2025
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Clarify HTTPRouteMatch rules #3741

Clarify HTTPRouteMatch rules #3741

Uh oh!

vehagn commented Apr 9, 2025

Uh oh!

k8s-ci-robot commented Apr 9, 2025

Uh oh!

k8s-ci-robot commented Apr 9, 2025

Uh oh!

mikemorris Apr 9, 2025

Uh oh!

vehagn Apr 9, 2025

Uh oh!

mikemorris left a comment

Uh oh!

mikemorris commented Apr 9, 2025

Uh oh!

vehagn commented Apr 9, 2025

Uh oh!

danwinship commented Apr 10, 2025

Uh oh!

k8s-ci-robot commented Apr 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	apiVersion: gateway.networking.k8s.io/v1
	kind: HTTPRoute
	metadata:
	name: http-app-1
	spec:
	parentRefs:
	- name: my-gateway
	hostnames:
	- "foo.com"
	rules:
	- matches:
	- path:
	type: PathPrefix
	value: /bar
	backendRefs:
	- name: my-service1
	port: 8080
	- matches:
	- headers:
	- type: Exact
	name: magic
	value: foo
	queryParams:
	- type: Exact
	name: great
	value: example
	path:
	type: PathPrefix
	value: /some/thing
	method: GET
	backendRefs:
	- name: my-service2
	port: 8080

	header `magic: foo` AND query param `great: example` to service "my-service2" on port `8080`:
	method `GET`, header `magic: foo` AND query param `great: example` to
	service "my-service2" on port `8080`:

Clarify HTTPRouteMatch rules #3741

Clarify HTTPRouteMatch rules #3741

Uh oh!

Conversation

vehagn commented Apr 9, 2025

Uh oh!

k8s-ci-robot commented Apr 9, 2025

Uh oh!

k8s-ci-robot commented Apr 9, 2025

Uh oh!

mikemorris Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

vehagn Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

mikemorris left a comment

Choose a reason for hiding this comment

Uh oh!

mikemorris commented Apr 9, 2025

Uh oh!

vehagn commented Apr 9, 2025

Uh oh!

danwinship commented Apr 10, 2025

Uh oh!

k8s-ci-robot commented Apr 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants