Skip to content

NGF: Update proxy settings policy for timeouts#1877

Merged
ciarams87 merged 3 commits intongf-release-2.6from
docs/ngf-proxy-timeouts
Apr 28, 2026
Merged

NGF: Update proxy settings policy for timeouts#1877
ciarams87 merged 3 commits intongf-release-2.6from
docs/ngf-proxy-timeouts

Conversation

@ciarams87
Copy link
Copy Markdown
Contributor

@ciarams87 ciarams87 commented Apr 22, 2026

Proposed changes

Update the documentation for ProxySettingsPolicy to add timeout configuration

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@ciarams87 ciarams87 requested a review from a team as a code owner April 22, 2026 14:42
@ciarams87 ciarams87 requested a review from a team April 22, 2026 14:42
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Apr 22, 2026
@github-actions
Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1877/

Comment thread content/ngf/traffic-management/proxy-settings.md Outdated
- `read`: time allowed between two successive **read operations** from the upstream server — not the total time to receive the full response. If the upstream does not transmit anything within this period, the connection is closed.
- `send`: time allowed between two successive **write operations** to the upstream server — not the total time to transmit the full request.

Because `read` and `send` are per-operation rather than end-to-end timeouts, a large response or request body can take longer than the configured value as long as data keeps flowing within the timeout window. NGINX does not currently support full request or response timeouts.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if we include the part about NGINX not supporting full timeouts. While useful information, when we do support them, we'll probably forget to remove this.

@ciarams87 ciarams87 requested a review from sjberman April 27, 2026 10:29
@ciarams87 ciarams87 merged commit a96f2bd into ngf-release-2.6 Apr 28, 2026
6 checks passed
@ciarams87 ciarams87 deleted the docs/ngf-proxy-timeouts branch April 28, 2026 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants