Update USP docs to match change to default keepalive#2160
Conversation
✅ Deploy Preview will be available once build job completes!
|
sjberman
left a comment
There was a problem hiding this comment.
Be sure to target the ngf-release-2.7 branch instead of main for this
c8f2abf to
7e492ab
Compare
| By default, the `keepAlive` directive is enabled with a value of 16. You can override this value or disable `keepAlive` entirely by configuring an `UpstreamSettingsPolicy`. To disable keepalive, set the connections field to 0. | ||
|
|
||
| The following example creates an `UpstreamSettingsPolicy` that configures keepalive connections for the `coffee` Service with a value of 32: |
There was a problem hiding this comment.
Could we adjust this to look something like
By default, the keepAlive directive is enabled with a value of 32. You can override this value or disable keepAlive entirely by configuring an UpstreamSettingsPolicy. To disable keepalive, set the connections field to 0.
The following example creates an UpstreamSettingsPolicy that configures keepalive connections for the coffee Service with a value of 24:
To still tell the user what the default keepAlive is and to show how to set the value to something different?
There was a problem hiding this comment.
Or the first line could be
By default, the keepAlive directive is omitted, causing NGINX to default to the keepalive value 32. You can override this value or disable keepAlive entirely by configuring an UpstreamSettingsPolicy. To disable keepalive, set the connections field to 0.
and we can remove the line further down
If
keepAlive.connectionsis omitted, the NGINX default value for thekeepalivedirective is used. To disable keepalive, setkeepAlive.connectionsto 0.
Proposed changes
This PR updates the default keepalive connections value for the Upstream Settings Policy API, to match recent changes. The change removes the outdated default previously used and updates the configuration examples to reflect the new changes.
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩