configuration: Add support for Envoys MaxStreamDuration configuration

Fixes #6873

Signed-off-by: Nicholas Burgin <nick@burgin.au>

Author: nickburgin

apis/projectcontour/v1/httpproxy.go

@@ -1142,6 +1142,12 @@ type TimeoutPolicy struct {
 	// +optional
 	// +kubebuilder:validation:Pattern=`^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$`
 	IdleConnection string `json:"idleConnection,omitempty"`
+
+	// Maximum allowed duration a streaming request can run for.
+	// If not supplied, the global setting is used.
+	// +optional
+	// +kubebuilder:validation:Pattern=`^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$`
+	MaxStreamDuration string `json:"maxStreamDuration,omitempty"`
 }
 
 // RetryOn is a string type alias with validation to ensure that the value is valid.

apis/projectcontour/v1alpha1/contourconfig.go

@@ -585,6 +585,15 @@ type TimeoutParameters struct {
 	// +optional
 	MaxConnectionDuration *string `json:"maxConnectionDuration,omitempty"`
 
+	// MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+	// The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+	// no max duration.
+	//
+	// See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+	// for more information.
+	// +optional
+	MaxStreamDuration *string `json:"maxStreamDuration,omitempty"`
+
 	// DelayedCloseTimeout defines how long envoy will wait, once connection
 	// close processing has been initiated, for the downstream peer to close
 	// the connection before Envoy closes the socket associated with the connection.

apis/projectcontour/v1alpha1/zz_generated.deepcopy.go

@@ -0,0 +1 @@
+Add support for Envoys MaxStreamDuration setting Globally and on Routes

changelogs/unreleased/6895-nickburgin-small.md

@@ -358,6 +358,9 @@ func (ctx *serveContext) convertToContourConfigurationSpec() contour_v1alpha1.Co
 	if len(ctx.Config.Timeouts.MaxConnectionDuration) > 0 {
 		timeoutParams.MaxConnectionDuration = ptr.To(ctx.Config.Timeouts.MaxConnectionDuration)
 	}
+	if len(ctx.Config.Timeouts.MaxStreamDuration) > 0 {
+		timeoutParams.MaxStreamDuration = ptr.To(ctx.Config.Timeouts.MaxStreamDuration)
+	}
 	if len(ctx.Config.Timeouts.DelayedCloseTimeout) > 0 {
 		timeoutParams.DelayedCloseTimeout = ptr.To(ctx.Config.Timeouts.DelayedCloseTimeout)
 	}

cmd/contour/servecontext.go

@@ -583,6 +583,14 @@ spec:
                           See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                           for more information.
                         type: string
+                      maxStreamDuration:
+                        description: |-
+                          MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                          The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                          no max duration.
+                          See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                          for more information.
+                        type: string
                       requestTimeout:
                         description: |-
                           RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -4399,6 +4407,14 @@ spec:
                               See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                               for more information.
                             type: string
+                          maxStreamDuration:
+                            description: |-
+                              MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                              The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                              no max duration.
+                              See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                              for more information.
+                            type: string
                           requestTimeout:
                             description: |-
                               RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -5274,6 +5290,12 @@ spec:
                       If not supplied, Envoy's default value of 1h applies.
                     pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                     type: string
+                  maxStreamDuration:
+                    description: |-
+                      Maximum allowed duration a streaming request can run for.
+                      If not supplied, the global setting is used.
+                    pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                    type: string
                   response:
                     description: |-
                       Timeout for receiving a response from the server after processing a request from client.
@@ -7021,6 +7043,12 @@ spec:
                             If not supplied, Envoy's default value of 1h applies.
                           pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                           type: string
+                        maxStreamDuration:
+                          description: |-
+                            Maximum allowed duration a streaming request can run for.
+                            If not supplied, the global setting is used.
+                          pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                          type: string
                         response:
                           description: |-
                             Timeout for receiving a response from the server after processing a request from client.

examples/contour/01-crds.yaml

@@ -798,6 +798,14 @@ spec:
                           See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                           for more information.
                         type: string
+                      maxStreamDuration:
+                        description: |-
+                          MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                          The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                          no max duration.
+                          See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                          for more information.
+                        type: string
                       requestTimeout:
                         description: |-
                           RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -4614,6 +4622,14 @@ spec:
                               See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                               for more information.
                             type: string
+                          maxStreamDuration:
+                            description: |-
+                              MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                              The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                              no max duration.
+                              See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                              for more information.
+                            type: string
                           requestTimeout:
                             description: |-
                               RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -5489,6 +5505,12 @@ spec:
                       If not supplied, Envoy's default value of 1h applies.
                     pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                     type: string
+                  maxStreamDuration:
+                    description: |-
+                      Maximum allowed duration a streaming request can run for.
+                      If not supplied, the global setting is used.
+                    pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                    type: string
                   response:
                     description: |-
                       Timeout for receiving a response from the server after processing a request from client.
@@ -7236,6 +7258,12 @@ spec:
                             If not supplied, Envoy's default value of 1h applies.
                           pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                           type: string
+                        maxStreamDuration:
+                          description: |-
+                            Maximum allowed duration a streaming request can run for.
+                            If not supplied, the global setting is used.
+                          pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                          type: string
                         response:
                           description: |-
                             Timeout for receiving a response from the server after processing a request from client.

examples/render/contour-deployment.yaml

@@ -594,6 +594,14 @@ spec:
                           See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                           for more information.
                         type: string
+                      maxStreamDuration:
+                        description: |-
+                          MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                          The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                          no max duration.
+                          See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                          for more information.
+                        type: string
                       requestTimeout:
                         description: |-
                           RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -4410,6 +4418,14 @@ spec:
                               See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                               for more information.
                             type: string
+                          maxStreamDuration:
+                            description: |-
+                              MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                              The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                              no max duration.
+                              See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                              for more information.
+                            type: string
                           requestTimeout:
                             description: |-
                               RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -5285,6 +5301,12 @@ spec:
                       If not supplied, Envoy's default value of 1h applies.
                     pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                     type: string
+                  maxStreamDuration:
+                    description: |-
+                      Maximum allowed duration a streaming request can run for.
+                      If not supplied, the global setting is used.
+                    pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                    type: string
                   response:
                     description: |-
                       Timeout for receiving a response from the server after processing a request from client.
@@ -7032,6 +7054,12 @@ spec:
                             If not supplied, Envoy's default value of 1h applies.
                           pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                           type: string
+                        maxStreamDuration:
+                          description: |-
+                            Maximum allowed duration a streaming request can run for.
+                            If not supplied, the global setting is used.
+                          pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                          type: string
                         response:
                           description: |-
                             Timeout for receiving a response from the server after processing a request from client.

examples/render/contour-gateway-provisioner.yaml

@@ -619,6 +619,14 @@ spec:
                           See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                           for more information.
                         type: string
+                      maxStreamDuration:
+                        description: |-
+                          MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                          The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                          no max duration.
+                          See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                          for more information.
+                        type: string
                       requestTimeout:
                         description: |-
                           RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -4435,6 +4443,14 @@ spec:
                               See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-connection-duration
                               for more information.
                             type: string
+                          maxStreamDuration:
+                            description: |-
+                              MaxStreamDuration defines the maximum duration a HTTP stream is kept alive.
+                              The stream will be reset if the time limit is reached. Omit or set to "infinity" for
+                              no max duration.
+                              See https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/protocol.proto#envoy-v3-api-field-config-core-v3-httpprotocoloptions-max-stream-duration
+                              for more information.
+                            type: string
                           requestTimeout:
                             description: |-
                               RequestTimeout sets the client request timeout globally for Contour. Note that
@@ -5310,6 +5326,12 @@ spec:
                       If not supplied, Envoy's default value of 1h applies.
                     pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                     type: string
+                  maxStreamDuration:
+                    description: |-
+                      Maximum allowed duration a streaming request can run for.
+                      If not supplied, the global setting is used.
+                    pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                    type: string
                   response:
                     description: |-
                       Timeout for receiving a response from the server after processing a request from client.
@@ -7057,6 +7079,12 @@ spec:
                             If not supplied, Envoy's default value of 1h applies.
                           pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
                           type: string
+                        maxStreamDuration:
+                          description: |-
+                            Maximum allowed duration a streaming request can run for.
+                            If not supplied, the global setting is used.
+                          pattern: ^(((\d*(\.\d*)?h)|(\d*(\.\d*)?m)|(\d*(\.\d*)?s)|(\d*(\.\d*)?ms)|(\d*(\.\d*)?us)|(\d*(\.\d*)?µs)|(\d*(\.\d*)?ns))+|infinity|infinite)$
+                          type: string
                         response:
                           description: |-
                             Timeout for receiving a response from the server after processing a request from client.