Mesh Timeout

This policy uses new policy matching algorithm. Do not combine with Timeout policy.

TargetRef support matrix

To learn more about the information in this table, see the matching docs.

Configuration

This policy enables Kong Mesh to set timeouts on the inbound and outbound connections depending on the protocol. Using this policy you can configure TCP and HTTP timeouts. Timeout configuration is split into two sections: common configuration and HTTP configuration. Common config is applied to both HTTP and TCP communication. HTTP timeout are only applied when service is marked as http. More on this in protocol support section.

MeshTimeout policy lets you configure multiple timeouts:

• connectionTimeout
• idleTimeout
• http.requestTimeout
• http.streamIdleTimeout
• http.maxStreamDuration
• http.maxConnectionDuration
• http.requestHeadersTimeout

Timeouts explained

Connection timeout

Connection timeout specifies the amount of time DP will wait for a TCP connection to be established.

Idle timeout

For TCP connections idle timeout is the amount of time that the DP will allow a connection to exist with no inbound or outbound activity. On the other hand when connection in HTTP time at which an inbound or outbound connection will be terminated if there are no active streams

HTTP request timeout

Request timeout lets you configure how long the data plane proxy should wait for the full response. In details, it spans between the point at which the entire request has been processed by DP and when the response has been completely processed by DP.

HTTP stream idle timeout

Stream idle timeout is the amount of time that the data plane proxy will allow an HTTP/2 stream to exist with no inbound or outbound activity. This timeout is strongly recommended for all requests (not just streaming requests/responses) as it additionally defends against a peer that does not open the stream window once an entire response has been buffered to be sent to a downstream client.

Stream timeouts apply even when you are only using HTTP/1.1 in you services. This is because every connection between data plane proxies is upgraded to HTTP/2.

HTTP max stream duration

Max stream duration is the maximum time that a stream’s lifetime will span. You can use this functionality when you want to reset HTTP request/response streams periodically.

HTTP max connection duration

Max connection duration is the time after which an inbound or outbound connection will be drained and/or closed, starting from when it was first established. If there are no active streams, the connection will be closed. If there are any active streams, the drain sequence will kick-in, and the connection will be force-closed after 5 seconds.

HTTP request headers timeout

The amount of time that proxy will wait for the request headers to be received. The timer is activated when the first byte of the headers is received, and is disarmed when the last byte of the headers has been received.

Examples

Simple outbound HTTP configuration

This configuration will be applied to all data plane proxies inside of Mesh.

apiVersion: kuma.io/v1alpha1
kind: MeshTimeout
metadata:
  name: timeout-global
  namespace: kuma-demo
  labels:
    kuma.io/mesh: default
spec:
  to:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 20s
      connectionTimeout: 2s
      http:
        requestTimeout: 2s

type: MeshTimeout
name: timeout-global
mesh: default
spec:
  to:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 20s
      connectionTimeout: 2s
      http:
        requestTimeout: 2s

resource "konnect_mesh_timeout" "timeout_global" {
  provider = konnect-beta
  type = "MeshTimeout"
  name = "timeout-global"
  spec = {
    to = [
      {
        target_ref = {
          kind = "Mesh"
        }
        default = {
          idle_timeout = "20s"
          connection_timeout = "2s"
          http = {
            request_timeout = "2s"
          }
        }
      }
    ]
  }
  labels   = {
    "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Simple TCP configuration

apiVersion: kuma.io/v1alpha1
kind: MeshTimeout
metadata:
  name: tcp-timeout
  namespace: kuma-demo
  labels:
    kuma.io/mesh: default
spec:
  to:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 20s
      connectionTimeout: 2s

type: MeshTimeout
name: tcp-timeout
mesh: default
spec:
  to:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 20s
      connectionTimeout: 2s

resource "konnect_mesh_timeout" "tcp_timeout" {
  provider = konnect-beta
  type = "MeshTimeout"
  name = "tcp-timeout"
  spec = {
    to = [
      {
        target_ref = {
          kind = "Mesh"
        }
        default = {
          idle_timeout = "20s"
          connection_timeout = "2s"
        }
      }
    ]
  }
  labels   = {
    "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Simple configuration for inbound applied to specific service

This configuration will be applied to backend service inbound.

apiVersion: kuma.io/v1alpha1
kind: MeshTimeout
metadata:
  name: inbound-timeout
  namespace: kuma-demo
  labels:
    kuma.io/mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: backend
  rules:
  - default:
      idleTimeout: 60s
      connectionTimeout: 2s
      http:
        requestTimeout: 10s
        streamIdleTimeout: 1h
        maxStreamDuration: 30m
        maxConnectionDuration: 30m

type: MeshTimeout
name: inbound-timeout
mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: backend
  rules:
  - default:
      idleTimeout: 60s
      connectionTimeout: 2s
      http:
        requestTimeout: 10s
        streamIdleTimeout: 1h
        maxStreamDuration: 30m
        maxConnectionDuration: 30m

resource "konnect_mesh_timeout" "inbound_timeout" {
  provider = konnect-beta
  type = "MeshTimeout"
  name = "inbound-timeout"
  spec = {
    target_ref = {
      kind = "Dataplane"
      labels = {
        app = "backend"
      }
    }
    rules = [
      {
        default = {
          idle_timeout = "60s"
          connection_timeout = "2s"
          http = {
            request_timeout = "10s"
            stream_idle_timeout = "1h"
            max_stream_duration = "30m"
            max_connection_duration = "30m"
          }
        }
      }
    ]
  }
  labels   = {
    "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Configuration for a single inbound port named tcp-port

apiVersion: kuma.io/v1alpha1
kind: MeshTimeout
metadata:
  name: inbound-timeout
  namespace: kuma-demo
  labels:
    kuma.io/mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: backend
    sectionName: tcp-port
  rules:
  - default:
      idleTimeout: 1h
      connectionTimeout: 10s

type: MeshTimeout
name: inbound-timeout
mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: backend
    sectionName: tcp-port
  rules:
  - default:
      idleTimeout: 1h
      connectionTimeout: 10s

resource "konnect_mesh_timeout" "inbound_timeout" {
  provider = konnect-beta
  type = "MeshTimeout"
  name = "inbound-timeout"
  spec = {
    target_ref = {
      kind = "Dataplane"
      labels = {
        app = "backend"
      }
      section_name = "tcp-port"
    }
    rules = [
      {
        default = {
          idle_timeout = "1h"
          connection_timeout = "10s"
        }
      }
    ]
  }
  labels   = {
    "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Target MeshHTTPRoute

Timeouts like http.requestTimeout and http.streamIdleTimeout are configurable per route. If a MeshHTTPRoute creates routes on the outbound listener of the service then MeshTimeout policy can configure timeouts on these routes.

In the following example the MeshHTTPRoute policy route-to-backend-v2 redirects all requests to /v2* to backend instances with version: v2 tag. MeshTimeout backend-v2 configures timeouts only for requests that are going through route-to-backend-v2 route.

apiVersion: kuma.io/v1alpha1
kind: MeshHTTPRoute
metadata:
  name: route-to-backend-v2
  namespace: kuma-demo
  labels:
    kuma.io/mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: frontend
  to:
  - targetRef:
      kind: MeshService
      name: backend_kuma-demo_svc_3001
    rules:
    - matches:
      - path:
          type: PathPrefix
          value: "/v2"
      default:
        backendRefs:
        - kind: MeshService
          name: backend-v2_kuma-demo_svc_3001

apiVersion: kuma.io/v1alpha1
kind: MeshHTTPRoute
metadata:
  name: route-to-backend-v2
  namespace: kuma-demo
  labels:
    kuma.io/mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: frontend
  to:
  - targetRef:
      kind: MeshService
      name: backend
      namespace: kuma-demo
      sectionName: http
    rules:
    - matches:
      - path:
          type: PathPrefix
          value: "/v2"
      default:
        backendRefs:
        - kind: MeshService
          name: backend-v2
          namespace: kuma-demo
          port: 3001

type: MeshHTTPRoute
name: route-to-backend-v2
mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: frontend
  to:
  - targetRef:
      kind: MeshService
      name: backend
    rules:
    - matches:
      - path:
          type: PathPrefix
          value: "/v2"
      default:
        backendRefs:
        - kind: MeshService
          name: backend-v2

type: MeshHTTPRoute
name: route-to-backend-v2
mesh: default
spec:
  targetRef:
    kind: Dataplane
    labels:
      app: frontend
  to:
  - targetRef:
      kind: MeshService
      name: backend
      sectionName: http
    rules:
    - matches:
      - path:
          type: PathPrefix
          value: "/v2"
      default:
        backendRefs:
        - kind: MeshService
          name: backend-v2
          port: 3001

resource "konnect_mesh_http_route" "route_to_backend_v2" {
  provider = konnect-beta
  type = "MeshHTTPRoute"
  name = "route-to-backend-v2"
  spec = {
    target_ref = {
      kind = "Dataplane"
      labels = {
        app = "frontend"
      }
    }
    to = [
      {
        target_ref = {
          kind = "MeshService"
          name = "backend"
          section_name = "http"
        }
        rules = [
          {
            matches = [
              {
                path = {
                  type = "PathPrefix"
                  value = "/v2"
                }
              }
            ]
            default = {
              backend_refs = [
                {
                  kind = "MeshService"
                  name = "backend-v2"
                  port = "3001"
                }
              ]
            }
          }
        ]
      }
    ]
  }
  labels   = {
    "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

You can see in the following route that the top level targetRef matches the previously defined MeshHTTPRoute.

apiVersion: kuma.io/v1alpha1
kind: MeshTimeout
metadata:
  name: backend-v2
  namespace: kuma-demo
  labels:
    kuma.io/mesh: default
spec:
  targetRef:
    kind: MeshHTTPRoute
    name: route-to-backend-v2
  to:
  - targetRef:
      kind: Mesh
    default:
      http:
        requestTimeout: 5s
        streamIdleTimeout: 1h

type: MeshTimeout
name: backend-v2
mesh: default
spec:
  targetRef:
    kind: MeshHTTPRoute
    name: route-to-backend-v2
  to:
  - targetRef:
      kind: Mesh
    default:
      http:
        requestTimeout: 5s
        streamIdleTimeout: 1h

resource "konnect_mesh_timeout" "backend_v2" {
  provider = konnect-beta
  type = "MeshTimeout"
  name = "backend-v2"
  spec = {
    target_ref = {
      kind = "MeshHTTPRoute"
      name = "route-to-backend-v2"
    }
    to = [
      {
        target_ref = {
          kind = "Mesh"
        }
        default = {
          http = {
            request_timeout = "5s"
            stream_idle_timeout = "1h"
          }
        }
      }
    ]
  }
  labels   = {
    "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Default configuration for all gateways in the Mesh

This configuration will be applied on inbounds and outbounds of all gateways.

apiVersion: kuma.io/v1alpha1
kind: MeshTimeout
metadata:
  name: mesh-gateways-timeout-all-default
  namespace: kong-mesh-system
  labels:
    kuma.io/mesh: default
spec:
  targetRef:
    kind: Mesh
    proxyTypes:
    - Gateway
  from:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 5m
      http:
        streamIdleTimeout: 5s
        requestHeadersTimeout: 500ms
  to:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 1h
      http:
        streamIdleTimeout: 5s

type: MeshTimeout
name: mesh-gateways-timeout-all-default
mesh: default
spec:
  targetRef:
    kind: Mesh
    proxyTypes:
    - Gateway
  from:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 5m
      http:
        streamIdleTimeout: 5s
        requestHeadersTimeout: 500ms
  to:
  - targetRef:
      kind: Mesh
    default:
      idleTimeout: 1h
      http:
        streamIdleTimeout: 5s

resource "konnect_mesh_timeout" "mesh_gateways_timeout_all_default" {
  provider = konnect-beta
  type = "MeshTimeout"
  name = "mesh-gateways-timeout-all-default"
  spec = {
    target_ref = {
      kind = "Mesh"
      proxy_types = [
         = "Gateway"
      ]
    }
    from = [
      {
        target_ref = {
          kind = "Mesh"
        }
        default = {
          idle_timeout = "5m"
          http = {
            stream_idle_timeout = "5s"
            request_headers_timeout = "500ms"
          }
        }
      }
    ]
    to = [
      {
        target_ref = {
          kind = "Mesh"
        }
        default = {
          idle_timeout = "1h"
          http = {
            stream_idle_timeout = "5s"
          }
        }
      }
    ]
  }
  labels   = {
    "kuma.io/mesh" = konnect_mesh.my_mesh.name
  }
  cp_id    = konnect_mesh_control_plane.my_meshcontrolplane.id
  mesh     = konnect_mesh.my_mesh.name
}

Defaults

All policy options