Commit fbf303c
authored
docs: clarify predictive_preconnect_ratio upper limit (#42261)
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 :) )
```
xds update failed for node=foo, message=Proto constraint validation failed (ClusterValidationError.PreconnectPolicy: embedded message failed validation | caused by PreconnectPolicyValidationError.PredictivePreconnectRatio: value must be inside range [1, 3])
```
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
Signed-off-by: Spencer Lewis <[email protected]>1 parent 8211b8f commit fbf303c
1 file changed
+3
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
748 | 748 | | |
749 | 749 | | |
750 | 750 | | |
| 751 | + | |
| 752 | + | |
| 753 | + | |
751 | 754 | | |
752 | 755 | | |
753 | 756 | | |
| |||
0 commit comments