GRPCRoute Support

[ciarams87]

Proposed changes

Problem: As a user of NGF with applications that require GRPC traffic
I want NGF to support GRPCRoute Exact Method Matching, Header Matching, and Listener Hostname Matching
So that I have a method to ingress GRPC traffic to my applications.

Solution: Add GRPCRoute support, reusing logic from HTTPRoute where possible and where it makes sense. The initial ticket was for only Hostname and Backend Ref matching, but it made sense to add the other support as so much of the validation and logic can be reused from HTTPRoute, instead of adding logic to reject those routes now.

Note: The only solution I have for turning on http2 is to hardcode it into the base NGINX conf files. I don't think there is a way to make this configurable. Do we foresee any potential issues with this? UPDATE: This will be addressed in a future PR by offering an option to disable http2

Testing: Ran conformance tests with GRPCRoutes locally (GRPCRoute conformance tests are in main branch only) , unit testing, manual testing

--- PASS: TestConformance/GRPCExactMethodMatching (1.02s)
    --- PASS: TestConformance/GRPCExactMethodMatching/2_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/EchoThree'_should_receive_a_Unimplemented_(12) (0.00s)
    --- PASS: TestConformance/GRPCExactMethodMatching/0_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_go_to_grpc-infra-backend-v1 (0.02s)
    --- PASS: TestConformance/GRPCExactMethodMatching/1_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/EchoTwo'_should_go_to_grpc-infra-backend-v2 (0.02s)
--- PASS: TestConformance/GRPCRouteHeaderMatching (0.01s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/6_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:blue}'_should_go_to_grpc-infra-backend-v1 (0.02s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/7_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:green}'_should_go_to_grpc-infra-backend-v1 (0.02s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/2_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:orange,Version:two}'_should_go_to_grpc-infra-backend-v1 (0.01s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/0_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Version:one}'_should_go_to_grpc-infra-backend-v1 (0.06s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/5_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Some-Other-Header:one}'_should_receive_a_Unimplemented_(12) (1.05s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/10_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:purple}'_should_receive_a_Unimplemented_(12) (1.05s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/9_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:yellow}'_should_go_to_grpc-infra-backend-v2 (1.06s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/4_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:orange}'_should_receive_a_Unimplemented_(12) (1.08s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/8_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:red}'_should_go_to_grpc-infra-backend-v2 (1.09s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/1_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Version:two}'_should_go_to_grpc-infra-backend-v2 (1.09s)
    --- PASS: TestConformance/GRPCRouteHeaderMatching/3_request_to_'/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_with_headers_'{Color:blue,Version:two}'_should_go_to_grpc-infra-backend-v2 (1.10s)
--- PASS: TestConformance/GRPCRouteListenerHostnameMatching (2.12s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/6_request_to_'foo.com/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_receive_a_Unimplemented_(12) (0.01s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/7_request_to_'no.matching.host/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_receive_a_Unimplemented_(12) (0.01s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/0_request_to_'bar.com/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_go_to_grpc-infra-backend-v1 (0.01s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/1_request_to_'foo.bar.com/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_go_to_grpc-infra-backend-v2 (0.01s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/3_request_to_'boo.bar.com/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_go_to_grpc-infra-backend-v3 (0.03s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/5_request_to_'multiple.prefixes.foo.com/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_go_to_grpc-infra-backend-v3 (0.03s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/2_request_to_'baz.bar.com/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_go_to_grpc-infra-backend-v3 (0.04s)
    --- PASS: TestConformance/GRPCRouteListenerHostnameMatching/4_request_to_'multiple.prefixes.bar.com/gateway_api_conformance.echo_basic.grpcecho.GrpcEcho/Echo'_should_go_to_grpc-infra-backend-v3 (0.04s)

Closes #1783 #1790 #1765 #1768 #1838 #1837

Checklist

Before creating a PR, run through this checklist and mark each as complete.

• I have read the CONTRIBUTING doc
• I have added tests that prove my fix is effective or that my feature works
• I have checked that all unit tests pass after adding my changes
• I have updated necessary documentation
• I have rebased my branch onto main
• I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

Initial support for GRPCRoute, including Exact Method Matching, Header Matching, and Listener Hostname Matching

[codecov]

Codecov Report

Attention: Patch coverage is 95.01661% with 30 lines in your changes are missing coverage. Please review.

Project coverage is 86.71%. Comparing base (7c3da8d) to head (de21059).

Files	Patch %	Lines
internal/mode/static/state/graph/route_common.go	94.58%	8 Missing and 5 partials ⚠️
internal/mode/static/manager.go	46.15%	7 Missing ⚠️
internal/mode/static/state/graph/grpcroute.go	97.01%	3 Missing and 1 partial ⚠️
internal/mode/static/state/graph/httproute.go	90.90%	3 Missing and 1 partial ⚠️
internal/mode/static/status/prepare_requests.go	96.49%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1835      +/-   ##
==========================================
+ Coverage   86.41%   86.71%   +0.29%     
==========================================
  Files          86       88       +2     
  Lines        5712     5967     +255     
  Branches       50       50              
==========================================
+ Hits         4936     5174     +238     
- Misses        727      741      +14     
- Partials       49       52       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[pleshakov]

overall, the approach looks good to me

please note: this is high level review that was originally done for the DRAFT PR

[kate-osborn]

Great work @ciarams87!

Just a few small comments

[kate-osborn]

one small nit I missed in the first review, otherwise LGTM

[sjberman]

Sort of going back on my original comment, it's probably worth having an example grpcroute and app in the examples folder, just no need for the README guide because we can write a doc instead.

[ADubhlaoich]

LGTM though docs changes are minimal, so I will not approve.

[ciarams87]

Sort of going back on my original comment, it's probably worth having an example grpcroute and app in the examples folder, just no need for the README guide because we can write a doc instead.

@sjberman The issue is the app though - for the other examples, we're using a sample NGINX so it's pretty straightforward, but for a gRPC app, we'll need to provide an image. There is a basic hello world test image here that we could use, but I'm not sure we should. The image I've been using for testing isn't ours, it's the test image from the conformance suite, and we should not use that in user facing examples. Without a working sample app, we're not offering anything over what's already available.

[sjberman]

@ciarams87 I just want devs to be able to easily test things out. Maybe we include the grpcroute example configs, and then the README in there can link to the test app, without us directly providing it?

[ciarams87]

@ciarams87 I just want devs to be able to easily test things out. Maybe we include the grpcroute example configs, and then the README in there can link to the test app, without us directly providing it?

That makes sense. I've created a new PR for the example though, just to allow feedback there with requiring a full re-review of this one from Kate and Michael.