Merge branch v2.11 into v3.0

traefik · Apr 11, 2024 · 34bd611 · 34bd611
2 parents 83a5c5c + b9b7527
commit 34bd611
Show file tree

Hide file tree

Showing 16 changed files with 142 additions and 391 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## [v2.11.2](https://github.com/traefik/traefik/tree/v2.11.2) (2024-04-11)
+[All Commits](https://github.com/traefik/traefik/compare/v2.11.1...v2.11.2)
+
+**Bug fixes:**
+- **[server]** Revert LingeringTimeout and change default value for ReadTimeout ([#10599](https://github.com/traefik/traefik/pull/10599) by [kevinpollet](https://github.com/kevinpollet))
+- **[server]** Set default ReadTimeout value to 60s ([#10602](https://github.com/traefik/traefik/pull/10602) by [rtribotte](https://github.com/rtribotte))
+
 ## [v3.0.0-rc4](https://github.com/traefik/traefik/tree/v3.0.0-rc4) (2024-04-10)
 [All Commits](https://github.com/traefik/traefik/compare/v3.0.0-rc3...v3.0.0-rc4)
 

diff --git a/docs/content/migration/v2.md b/docs/content/migration/v2.md
@@ -581,7 +581,7 @@ the maximum user-defined router priority value is:
 - `(MaxInt32 - 1000)` for 32-bit platforms,
 - `(MaxInt64 - 1000)` for 64-bit platforms.
 
-### <EntryPoint>.Transport.RespondingTimeouts.<Timeout>
+### EntryPoint.Transport.RespondingTimeouts.<Timeout>
 
 Starting with `v2.11.1` the following timeout options are deprecated:
 
@@ -595,7 +595,7 @@ They have been replaced by:
 - `<entryPoint>.transport.respondingTimeouts.http.writeTimeout`
 - `<entryPoint>.transport.respondingTimeouts.http.idleTimeout`
 
-### <EntryPoint>.Transport.RespondingTimeouts.TCP.LingeringTimeout
+### EntryPoint.Transport.RespondingTimeouts.TCP.LingeringTimeout
 
 Starting with `v2.11.1` a new `lingeringTimeout` entryPoints option has been introduced, with a default value of 2s.
 
@@ -612,3 +612,31 @@ Increasing the `lingeringTimeout` value could be the solution notably if you are
 - TCP: `Error while handling TCP connection: readfrom tcp X.X.X.X:X->X.X.X.X:X: read tcp X.X.X.X:X->X.X.X.X:X: i/o timeout`
 - HTTP: `'499 Client Closed Request' caused by: context canceled`
 - HTTP: `ReverseProxy read error during body copy: read tcp X.X.X.X:X->X.X.X.X:X: use of closed network connection`
+
+## v2.11.2
+
+### LingeringTimeout
+
+Starting with `v2.11.2` the `<entrypoint>.transport.respondingTimeouts.tcp.lingeringTimeout` introduced in `v2.11.1` has been removed.
+
+### RespondingTimeouts.TCP and RespondingTimeouts.HTTP
+
+Starting with `v2.11.2` the `respondingTimeouts.tcp` and `respondingTimeouts.http` sections introduced in `v2.11.1` have been removed.
+To configure responding timeouts
+
+### EntryPoint.Transport.RespondingTimeouts.ReadTimeout
+
+Starting with `v2.11.2` the entryPoints [`readTimeout`](../routing/entrypoints.md#respondingtimeouts) option default value changed to 60 seconds.
+
+For HTTP, this option defines the maximum duration for reading the entire request, including the body.
+For TCP, this option defines the maximum duration for the first bytes to be read on the connection.
+
+The default value was previously set to zero, which means no timeout.
+
+This change has been done to avoid Traefik instances with the default configuration to be hanging forever while waiting for bytes to be read on the connection.
+
+Increasing the `readTimeout` value could be the solution notably if you are dealing with the following errors:
+
+- TCP: `Error while handling TCP connection: readfrom tcp X.X.X.X:X->X.X.X.X:X: read tcp X.X.X.X:X->X.X.X.X:X: i/o timeout`
+- HTTP: `'499 Client Closed Request' caused by: context canceled`
+- HTTP: `ReverseProxy read error during body copy: read tcp X.X.X.X:X->X.X.X.X:X: use of closed network connection`
diff --git a/docs/content/reference/static-configuration/cli-ref.md b/docs/content/reference/static-configuration/cli-ref.md
@@ -198,26 +198,14 @@ Duration to give active requests a chance to finish before Traefik stops. (Defau
 `--entrypoints.<name>.transport.lifecycle.requestacceptgracetimeout`:  
 Duration to keep accepting requests before Traefik initiates the graceful shutdown procedure. (Default: ```0```)
 
-`--entrypoints.<name>.transport.respondingtimeouts.http.idletimeout`:  
-IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set. (Default: ```180```)
-
-`--entrypoints.<name>.transport.respondingtimeouts.http.readtimeout`:  
-ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set. (Default: ```0```)
-
-`--entrypoints.<name>.transport.respondingtimeouts.http.writetimeout`:  
-WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set. (Default: ```0```)
-
 `--entrypoints.<name>.transport.respondingtimeouts.idletimeout`:  
-(Deprecated) IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set. (Default: ```0```)
+IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set. (Default: ```180```)
 
 `--entrypoints.<name>.transport.respondingtimeouts.readtimeout`:  
-(Deprecated) ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set. (Default: ```0```)
-
-`--entrypoints.<name>.transport.respondingtimeouts.tcp.lingeringtimeout`:  
-LingeringTimeout is the maximum duration between each TCP read operation on the connection. If zero, no timeout is set. (Default: ```2```)
+ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set. (Default: ```60```)
 
 `--entrypoints.<name>.transport.respondingtimeouts.writetimeout`:  
-(Deprecated) WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set. (Default: ```0```)
+WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set. (Default: ```0```)
 
 `--entrypoints.<name>.udp.timeout`:  
 Timeout defines how long to wait on an idle session before releasing the related resources. (Default: ```3```)

diff --git a/docs/content/reference/static-configuration/env-ref.md b/docs/content/reference/static-configuration/env-ref.md
@@ -198,26 +198,14 @@ Duration to give active requests a chance to finish before Traefik stops. (Defau
 `TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_LIFECYCLE_REQUESTACCEPTGRACETIMEOUT`:  
 Duration to keep accepting requests before Traefik initiates the graceful shutdown procedure. (Default: ```0```)
 
-`TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_RESPONDINGTIMEOUTS_HTTP_IDLETIMEOUT`:  
-IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set. (Default: ```180```)
-
-`TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_RESPONDINGTIMEOUTS_HTTP_READTIMEOUT`:  
-ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set. (Default: ```0```)
-
-`TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_RESPONDINGTIMEOUTS_HTTP_WRITETIMEOUT`:  
-WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set. (Default: ```0```)
-
 `TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_RESPONDINGTIMEOUTS_IDLETIMEOUT`:  
-(Deprecated) IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set. (Default: ```0```)
+IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set. (Default: ```180```)
 
 `TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_RESPONDINGTIMEOUTS_READTIMEOUT`:  
-(Deprecated) ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set. (Default: ```0```)
-
-`TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_RESPONDINGTIMEOUTS_TCP_LINGERINGTIMEOUT`:  
-LingeringTimeout is the maximum duration between each TCP read operation on the connection. If zero, no timeout is set. (Default: ```2```)
+ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set. (Default: ```60```)
 
 `TRAEFIK_ENTRYPOINTS_<NAME>_TRANSPORT_RESPONDINGTIMEOUTS_WRITETIMEOUT`:  
-(Deprecated) WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set. (Default: ```0```)
+WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set. (Default: ```0```)
 
 `TRAEFIK_ENTRYPOINTS_<NAME>_UDP_TIMEOUT`:  
 Timeout defines how long to wait on an idle session before releasing the related resources. (Default: ```3```)

diff --git a/docs/content/reference/static-configuration/file.toml b/docs/content/reference/static-configuration/file.toml
@@ -42,12 +42,6 @@
         readTimeout = "42s"
         writeTimeout = "42s"
         idleTimeout = "42s"
-        [entryPoints.EntryPoint0.transport.respondingTimeouts.http]
-          readTimeout = "42s"
-          writeTimeout = "42s"
-          idleTimeout = "42s"
-        [entryPoints.EntryPoint0.transport.respondingTimeouts.tcp]
-          lingeringTimeout = "42s"
     [entryPoints.EntryPoint0.proxyProtocol]
       insecure = true
       trustedIPs = ["foobar", "foobar"]

diff --git a/docs/content/reference/static-configuration/file.yaml b/docs/content/reference/static-configuration/file.yaml
@@ -45,12 +45,6 @@ entryPoints:
         readTimeout: 42s
         writeTimeout: 42s
         idleTimeout: 42s
-        http:
-          readTimeout: 42s
-          writeTimeout: 42s
-          idleTimeout: 42s
-        tcp:
-          lingeringTimeout: 42s
       keepAliveMaxTime: 42s
       keepAliveMaxRequests: 42
     proxyProtocol:

diff --git a/docs/content/routing/entrypoints.md b/docs/content/routing/entrypoints.md
@@ -504,19 +504,19 @@ You can configure Traefik to trust the forwarded headers information (`X-Forward
 
 #### `respondingTimeouts`
 
-##### `http`
+`respondingTimeouts` are timeouts for incoming requests to the Traefik instance.
+Setting them has no effect for UDP entryPoints.
 
-`respondingTimeouts.http` are timeouts for incoming requests to the Traefik instance.
+??? info "`transport.respondingTimeouts.readTimeout`"
 
-??? info "`transport.respondingTimeouts.http.readTimeout`"
-
-    _Optional, Default=0s_
+    _Optional, Default=60s_
 
     `readTimeout` is the maximum duration for reading the entire request, including the body.
 
     If zero, no timeout exists.  
     Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw values (digits).
     If no units are provided, the value is parsed assuming seconds.
+    We strongly suggest to adapt this value accordingly to the your needs.
 
     ```yaml tab="File (YAML)"
     ## Static configuration
@@ -525,26 +525,26 @@ You can configure Traefik to trust the forwarded headers information (`X-Forward
         address: ":8888"
         transport:
           respondingTimeouts:
-            http:
-              readTimeout: 42
+            readTimeout: 42
     ```
 
     ```toml tab="File (TOML)"
     ## Static configuration
     [entryPoints]
       [entryPoints.name]
         address = ":8888"
-        [entryPoints.name.transport.respondingTimeouts.http]
-          readTimeout = 42
+        [entryPoints.name.transport]
+          [entryPoints.name.transport.respondingTimeouts]
+            readTimeout = 42
     ```
 
     ```bash tab="CLI"
     ## Static configuration
     --entryPoints.name.address=:8888
-    --entryPoints.name.transport.respondingTimeouts.http.readTimeout=42
+    --entryPoints.name.transport.respondingTimeouts.readTimeout=42
     ```
 
-??? info "`transport.respondingTimeouts.http.writeTimeout`"
+??? info "`transport.respondingTimeouts.writeTimeout`"
 
     _Optional, Default=0s_
 
@@ -562,26 +562,26 @@ You can configure Traefik to trust the forwarded headers information (`X-Forward
         address: ":8888"
         transport:
           respondingTimeouts:
-            http:
-              writeTimeout: 42
+            writeTimeout: 42
     ```
 
     ```toml tab="File (TOML)"
     ## Static configuration
     [entryPoints]
       [entryPoints.name]
         address = ":8888"
-        [entryPoints.name.transport.respondingTimeouts.http]
-          writeTimeout = 42
+        [entryPoints.name.transport]
+          [entryPoints.name.transport.respondingTimeouts]
+            writeTimeout = 42
     ```
 
     ```bash tab="CLI"
     ## Static configuration
     --entryPoints.name.address=:8888
-    --entryPoints.name.transport.respondingTimeouts.http.writeTimeout=42
+    --entryPoints.name.transport.respondingTimeouts.writeTimeout=42
     ```
 
-??? info "`transport.respondingTimeouts.http.idleTimeout`"
+??? info "`transport.respondingTimeouts.idleTimeout`"
 
     _Optional, Default=180s_
 
@@ -598,63 +598,23 @@ You can configure Traefik to trust the forwarded headers information (`X-Forward
         address: ":8888"
         transport:
           respondingTimeouts:
-            http:
-              idleTimeout: 42
-    ```
-
-    ```toml tab="File (TOML)"
-    ## Static configuration
-    [entryPoints]
-      [entryPoints.name]
-        address = ":8888"
-        [entryPoints.name.transport.respondingTimeouts.http]
-          idleTimeout = 42
-    ```
-
-    ```bash tab="CLI"
-    ## Static configuration
-    --entryPoints.name.address=:8888
-    --entryPoints.name.transport.respondingTimeouts.http.idleTimeout=42
-
-##### `tcp`
-
-`respondingTimeouts.tcp` are timeouts for client connections to the Traefik instance.
-
-??? info "`transport.respondingTimeouts.tcp.lingeringTimeout`"
-
-    _Optional, Default=2s_
-
-    `lingeringTimeout` is the maximum duration between each TCP read operation on the connection.
-    As a layer 4 timeout, it also applies during HTTP handling, but respect the configured HTTP server `readTimeout`.
-
-    If zero, the lingering is disabled.  
-    Can be provided in a format supported by [time.ParseDuration](https://golang.org/pkg/time/#ParseDuration) or as raw values (digits).
-    If no units are provided, the value is parsed assuming seconds.
-
-    ```yaml tab="File (YAML)"
-    ## Static configuration
-    entryPoints:
-      name:
-        address: ":8888"
-        transport:
-          respondingTimeouts:
-            tcp:
-              lingeringTimeout: 42
+            idleTimeout: 42
     ```
 
     ```toml tab="File (TOML)"
     ## Static configuration
     [entryPoints]
       [entryPoints.name]
         address = ":8888"
-        [entryPoints.name.transport.respondingTimeouts.tcp]
-          lingeringTimeout = 42
+        [entryPoints.name.transport]
+          [entryPoints.name.transport.respondingTimeouts]
+            idleTimeout = 42
     ```
 
     ```bash tab="CLI"
     ## Static configuration
     --entryPoints.name.address=:8888
-    --entryPoints.name.transport.respondingTimeouts.tcp.lingeringTimeout=42
+    --entryPoints.name.transport.respondingTimeouts.idleTimeout=42
     ```
 
 #### `lifeCycle`

diff --git a/pkg/api/handler_entrypoint_test.go b/pkg/api/handler_entrypoint_test.go
@@ -13,7 +13,6 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	ptypes "github.com/traefik/paerser/types"
 	"github.com/traefik/traefik/v3/pkg/config/runtime"
 	"github.com/traefik/traefik/v3/pkg/config/static"
 )
@@ -56,11 +55,9 @@ func TestHandler_EntryPoints(t *testing.T) {
 								GraceTimeOut:              2,
 							},
 							RespondingTimeouts: &static.RespondingTimeouts{
-								HTTP: &static.HTTPRespondingTimeouts{
-									ReadTimeout:  paerserDurationPtr(3),
-									WriteTimeout: paerserDurationPtr(4),
-									IdleTimeout:  paerserDurationPtr(5),
-								},
+								ReadTimeout:  3,
+								WriteTimeout: 4,
+								IdleTimeout:  5,
 							},
 						},
 						ProxyProtocol: &static.ProxyProtocol{
@@ -80,11 +77,9 @@ func TestHandler_EntryPoints(t *testing.T) {
 								GraceTimeOut:              20,
 							},
 							RespondingTimeouts: &static.RespondingTimeouts{
-								HTTP: &static.HTTPRespondingTimeouts{
-									ReadTimeout:  paerserDurationPtr(3),
-									WriteTimeout: paerserDurationPtr(4),
-									IdleTimeout:  paerserDurationPtr(5),
-								},
+								ReadTimeout:  30,
+								WriteTimeout: 40,
+								IdleTimeout:  50,
 							},
 						},
 						ProxyProtocol: &static.ProxyProtocol{
@@ -268,8 +263,3 @@ func generateEntryPoints(nb int) map[string]*static.EntryPoint {
 
 	return eps
 }
-
-func paerserDurationPtr(duration int) *ptypes.Duration {
-	d := ptypes.Duration(duration)
-	return &d
-}
diff --git a/pkg/api/testdata/entrypoints.json b/pkg/api/testdata/entrypoints.json
@@ -23,11 +23,9 @@
 				"requestAcceptGraceTimeout": "1ns"
 			},
 			"respondingTimeouts": {
-				"http": {
-					"idleTimeout": "5ns",
-					"readTimeout": "3ns",
-					"writeTimeout": "4ns"
-				}
+				"idleTimeout": "5ns",
+				"readTimeout": "3ns",
+				"writeTimeout": "4ns"
 			}
 		}
 	},
@@ -55,11 +53,9 @@
 				"requestAcceptGraceTimeout": "10ns"
 			},
 			"respondingTimeouts": {
-				"http": {
-					"idleTimeout": "5ns",
-					"readTimeout": "3ns",
-					"writeTimeout": "4ns"
-				}
+				"idleTimeout": "50ns",
+				"readTimeout": "30ns",
+				"writeTimeout": "40ns"
 			}
 		}
 	}