Add guide for UpstreamSettingsPolicy #2987
Open
Conversation
This file contains 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
github-actions
bot
added
the
documentation
kate-osborn
force-pushed
the
docs/usp-guide
branch
from
6206c93 to
e3a865e
Compare
Nothing is coming to mind for me.
I like what you have right now, I think going beyond checking the status and actually showing the nginx configuration change is helpful especially since it'd be difficult (i'm not so sure how to maybe its easy lol) to actually show the working changes through curls to the services (like what we do with other guides). |
bjee19
approved these changes
Jan 7, 2025
kate-osborn
force-pushed
the
docs/usp-guide
branch
from
cf6c497 to
53dc2f7
Compare
salonichf5
reviewed
Jan 8, 2025
salonichf5
approved these changes
Jan 8, 2025
Remove unnecessary comma Co-authored-by: bjee19 <[email protected]>
kate-osborn
force-pushed
the
docs/usp-guide
branch
from
571ad71 to
0b1e851
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: As a user, I want an example of how to configure upstream settings for my application.
Solution: Add a how-to guide describing how to configure upstream zone size and keepalives for services. Also adds UpstreamSettingsPolicy to the table in the custom policies document and moves the custom policies document closer to the top of the overview page to increase visibility.
Testing: Ran through the steps in the guide and verified they work.
Please focus on: The "verification" portion of the guide where we exec into the NGINX container and check the upstream blocks for the appropriate directives. Is there a better way to verify the settings? Do we need to verify them beyond checking the status?
Closes #2369
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.