search

kubernetes-sigs / gateway-api

Repository for the next iteration of composite service (e.g. Ingress) and load balancing APIs.
https://gateway-api.sigs.k8s.io
Apache License 2.0
1.86k stars 482 forks source link

Align documentation about HTTPRouteTimeouts.BackendRequest timeout scope #3462

Open rtribotte opened 5 days ago

rtribotte commented 5 days ago

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR aligns the HTTPRouteTimeouts.BackendRequest timeout documentation. It is stated in the GEP 1742 sequence diagram illustrating the timeouts boundaries that the HTTPRouteTimeouts.BackendRequest timeout runs until the responses headers are received: https://github.com/kubernetes-sigs/gateway-api/blob/f73504594cf85d36681e064d2932d66608d135e2/geps/gep-1742/index.md?plain=1#L358-L360

The documentation for the CRD was mentioning a timeout running until the end of the response, which is not consistent and this PR aims to align expectations.

On the side, in the GEP 1742, the Traefik mermaid sequence diagram is adjusted to reflect more accurately the actual supported timeouts.

Which issue(s) this PR fixes:

Does this PR introduce a user-facing change?:

Align documentation about HTTPRouteTimeouts.BackendRequest timeout scope.
k8s-ci-robot commented 5 days ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rtribotte Once this PR has been reviewed and has the lgtm label, please assign thockin 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: - **[OWNERS](https://github.com/kubernetes-sigs/gateway-api/blob/main/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 commented 5 days ago

Hi @rtribotte. 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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
youngnick commented 5 days ago

/ok-to-test

This seems reasonable, but I'll need to have a think about it in case it counts as a breaking change.