From 2f483d2d8596b57687345b7ed0c7378479e13906 Mon Sep 17 00:00:00 2001 From: Shashank Ram <21697719+shashankram@users.noreply.github.com> Date: Wed, 23 Mar 2022 09:17:03 -0700 Subject: [PATCH] apis: correct comments for UpstreamTrafficSetting (#4605) Corrects the comments for the UpstreamTrafficSetting API fields. Part of #4500 Signed-off-by: Shashank Ram --- .../policy/v1alpha1/upstreamtrafficsetting.go | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/pkg/apis/policy/v1alpha1/upstreamtrafficsetting.go b/pkg/apis/policy/v1alpha1/upstreamtrafficsetting.go index aa1c475345..1d7ea3c5c0 100644 --- a/pkg/apis/policy/v1alpha1/upstreamtrafficsetting.go +++ b/pkg/apis/policy/v1alpha1/upstreamtrafficsetting.go @@ -59,7 +59,7 @@ type ConnectionSettingsSpec struct { type TCPConnectionSettings struct { // MaxConnections specifies the maximum number of TCP connections // allowed to the upstream host. - // Defaults to 2147483647 (2^32 - 1) if not specified. + // Defaults to 4294967295 (2^32 - 1) if not specified. // +optional MaxConnections *uint32 `json:"maxConnections,omitempty"` @@ -74,7 +74,7 @@ type TCPConnectionSettings struct { type HTTPConnectionSettings struct { // MaxRequests specifies the maximum number of parallel requests // allowed to the upstream host. - // Defaults to 2147483647 (2^32 - 1) if not specified. + // Defaults to 4294967295 (2^32 - 1) if not specified. // +optional MaxRequests *uint32 `json:"maxRequests,omitempty"` @@ -84,15 +84,18 @@ type HTTPConnectionSettings struct { // +optional MaxRequestsPerConnection *uint32 `json:"maxRequestsPerConnection,omitempty"` - // MaxPendingRequests specifies the maximum number of pending HTTP/1.1 - // requests allowed to the upstream host. - // Defaults to 2147483647 (2^32 - 1) if not specified. + // MaxPendingRequests specifies the maximum number of pending HTTP + // requests allowed to the upstream host. For HTTP/2 connections, + // if `maxRequestsPerConnection` is not configured, all requests will + // be multiplexed over the same connection so this circuit breaker + // will only be hit when no connection is already established. + // Defaults to 4294967295 (2^32 - 1) if not specified. // +optional MaxPendingRequests *uint32 `json:"maxPendingRequests,omitempty"` // MaxRetries specifies the maximum number of parallel retries // allowed to the upstream host. - // Defaults to 2147483647 (2^32 - 1) if not specified. + // Defaults to 4294967295 (2^32 - 1) if not specified. // +optional MaxRetries *uint32 `json:"maxRetries,omitempty"` }