docs: clarify predictive_preconnect_ratio upper limit #42261
Conversation
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
|
Docs for this Pull Request will be rendered here: https://storage.googleapis.com/envoy-cncf-pr/42261/docs/index.html The docs are (re-)rendered each time the CI |
|
CC @envoyproxy/api-shepherds: Your approval is needed for changes made to |
Add documentation explaining that predictive_preconnect_ratio is limited to 3. Per_upstream_preconnect_ratio and predictive_preconnect_ratio are both limited to 3, but previously only the former had this upper bound documented. Signed-off-by: Spencer Lewis <[email protected]>
spenceral
force-pushed
the
predictive_preconnect_doc
branch
from
addeeb0 to
06b68e5
Compare
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.
Add documentation explaining that predictive_preconnect_ratio is limited to 3. Per_upstream_preconnect_ratio and predictive_preconnect_ratio are both limited to 3, but previously only the former had this upper bound documented.
Commit Message: docs: clarify predictive_preconnect_ratio upper limit
Add documentation explaining that predictive_preconnect_ratio is limited to 3. Per_upstream_preconnect_ratio and predictive_preconnect_ratio are both limited to 3, but previously only the former had this upper bound documented.
Additional Description:
Users unaware of the upper bound that set too high of a value will see CDS updates rejected (ask me how I know :) )
Fixing the documentation gap here https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/cluster/v3/cluster.proto#config-cluster-v3-cluster-preconnectpolicy lessens the chance of that happening. I copied the comment word for word from the proto comment for per_upstream_preconnect_ratio.
Risk Level: low
Testing: n/a
Docs Changes: API protos doc update