gep: GEP-3440 - Gateway API Support for gRPC Retries #3441

shadialtarsha · 2024-11-08T13:26:28Z

What type of PR is this?

/kind gep

What this PR does / why we need it:
Proposes configurations for gRPC retries within GRPCRotue.

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?:

Adds a new field `retry` to `GRPCRouteRule` to allow configuring retries for unsuccessful gRPC requests.

linux-foundation-easycla · 2024-11-08T13:26:32Z

The committers listed above are authorized under a signed CLA.

✅ login: shadialtarsha / name: Shadi Altarsha (5b821c1, 54e5c50, 7cecf09, 0357b13, e435f1a, 072e76e)

k8s-ci-robot · 2024-11-08T13:26:34Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: shadialtarsha
Once this PR has been reviewed and has the lgtm label, please assign youngnick for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

geps/OWNERS

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

k8s-ci-robot · 2024-11-08T13:26:37Z

Welcome @shadialtarsha!

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 · 2024-11-08T13:26:38Z

Hi @shadialtarsha. 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.

shadialtarsha · 2024-11-08T13:32:18Z

@mikemorris already set me up for success here with his HTTP retries GEP. So this GEP is heavily inspired by his work.

I assume this GEP might depend on the output of #3219 or at least the conformance tests need the timeout to test the backoff not exceeding the timeout.

By the way this is my first PR so I hope I followed the process correctly 😅

geps/gep-3440/index.md

Co-authored-by: Sotiris Nanopoulos <[email protected]>

Co-authored-by: Seth Epps <[email protected]>

howardjohn · 2024-11-08T16:36:43Z

geps/gep-3440/index.md

+- No standard APIs for advanced retry logic, such as integrating with rate-limiting headers.
+- No default retry policies for all routes within a namespace or for routes tied to a specific Gateway.
+- No support for detailed backoff adjustments, like fine-tuning intervals, adding jitter, or setting max duration caps.
+- No retry support for streaming or bidirectional APIs (maybe considered in future proposals).


How is this enforced in the API specification?

Thanks for calling that out. The API doesn't have a way to enforce this non-goal.

I am thinking of three ways to do that:

Adding a restriction in the API documentation clarifying that retries apply only to unary calls, with a potential future option to expand to streaming. Something among the line as:

// Note: **Retries are supported only for unary gRPC calls.** // Implementations MUST NOT apply retries to streaming or bidirectional // gRPC calls, as these types of calls are stateful and retrying them // could result in data loss or duplication.

Explicit Field: Add a UnaryOnly field (e.g., UnaryOnly bool) that makes it clear retries are restricted to unary calls.

Remove this restriction and let users choose whether to apply retries on any gRPC call type.

Would like to hear your thoughts on this.

robscott · 2024-11-08T17:12:29Z

@shadialtarsha Thanks for this PR! We're currently in our release scoping phase for v1.3. To have this considered for scope in v1.3, please propose it in #3403.

first draft

5b821c1

k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/gep PRs related to Gateway Enhancement Proposal(GEP) labels Nov 8, 2024

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Nov 8, 2024

k8s-ci-robot requested review from gcs278 and mlavacca November 8, 2024 13:26

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 8, 2024

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 8, 2024