Skip to content

Update USP docs to match change to default keepalive#2160

Merged
Morgan-P-04 merged 1 commit into
ngf-release-2.7from
ngf/usp-keepalive-default
Jul 22, 2026
Merged

Update USP docs to match change to default keepalive#2160
Morgan-P-04 merged 1 commit into
ngf-release-2.7from
ngf/usp-keepalive-default

Conversation

@Morgan-P-04

Copy link
Copy Markdown

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

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

@Morgan-P-04
Morgan-P-04 requested a review from a team as a code owner July 21, 2026 09:28
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Jul 21, 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/2160/

@sjberman sjberman left a comment

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.

Be sure to target the ngf-release-2.7 branch instead of main for this

@Morgan-P-04
Morgan-P-04 changed the base branch from main to ngf-release-2.7 July 21, 2026 15:05
@Morgan-P-04
Morgan-P-04 requested review from a team as code owners July 21, 2026 15:05
@Morgan-P-04
Morgan-P-04 changed the base branch from ngf-release-2.7 to main July 21, 2026 15:05
@Morgan-P-04
Morgan-P-04 changed the base branch from main to ngf-release-2.7 July 21, 2026 15:06
@Morgan-P-04
Morgan-P-04 removed request for a team July 22, 2026 08:32
@Morgan-P-04
Morgan-P-04 force-pushed the ngf/usp-keepalive-default branch from c8f2abf to 7e492ab Compare July 22, 2026 08:49
@Morgan-P-04
Morgan-P-04 requested a review from sjberman July 22, 2026 08:52
@Morgan-P-04
Morgan-P-04 merged commit e9b19c7 into ngf-release-2.7 Jul 22, 2026
6 checks passed
@Morgan-P-04
Morgan-P-04 deleted the ngf/usp-keepalive-default branch July 22, 2026 08:54
Comment on lines -442 to 438
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:

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.

@Morgan-P-04

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?

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.

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.connections is omitted, the NGINX default value for the keepalive directive is used. To disable keepalive, set keepAlive.connections to 0.

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.

5 participants