NGF: document NginxProxy useClusterIP setting#2116
Open
SidharathBansal wants to merge 1 commit into
Open
Conversation
github-actions
Bot
added
documentation
3 tasks
Contributor
|
can we target this to release branch for ngf-release-2.7 |
Document the new NginxProxy useClusterIP field, which routes upstream traffic to a Service's ClusterIP instead of individual Pod IPs to reduce NGINX reloads on backend Pod churn. Notes the fallback cases (headless, ExternalName, L4/stream) and the default value.
SidharathBansal
force-pushed
the
feat/ngf-use-cluster-ip-docs
branch
from
d65a783 to
1658297
Compare
Author
|
Thanks @salonichf5! I've switched the base to |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Problem: NGINX Gateway Fabric is adding a
useClusterIPfield to theNginxProxyresource (nginx/nginx-gateway-fabric#5557, resolving nginx/nginx-gateway-fabric#5554). The data plane configuration guide does not yet document it.Solution: Add a "Route upstream traffic to the Service ClusterIP" section to
content/ngf/how-to/data-plane-configuration.md. It explains what the setting does and why (fewer NGINX reloads on backend Pod churn, service-mesh compatibility), gives anNginxProxyYAML example, and documents the fallback cases (headless Services, ExternalName Services, L4/stream upstreams) and the default value.Testing: Rendered/reviewed the Markdown locally; no functional changes.
Related: nginx/nginx-gateway-fabric#5557, nginx/nginx-gateway-fabric#5554