Upstream Timeout

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
  --data "name=upstream-timeout"  \
    --data "config.connect_timeout=4000" \
    --data "config.send_timeout=5000" \
    --data "config.read_timeout=5000"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: upstream-timeout-example
config: 
  connect_timeout: 4000
  send_timeout: 5000
  read_timeout: 5000
plugin: upstream-timeout

Then, apply it to an ingress (route or routes) by annotating the ingress as follows:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ROUTE_NAME|ROUTE_ID
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: upstream-timeout-example
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          service:
            name: echo
            port:
              number: 80

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: upstream-timeout
  route: ROUTE_NAME
  config: 
    connect_timeout: 4000
    send_timeout: 5000
    read_timeout: 5000

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

You can configure this plugin through the Konnect UI.

From the Service Hub, select a service version, then set up the plugin:

1. Select a route.
2. In the Plugins section, click Add Plugin.
3. Find and select the Upstream Timeout plugin.
4. Click Create.

You can configure this plugin through the Kong Manager UI.

1. In Kong Manager, select the workspace.
2. Open Routes from the menu, then click View for the route row.
3. From the plugin section, click Add Plugin.
4. Find and select the Upstream Timeout plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.

5. If the option is available, select Scoped.
6. Add the route ID if it is not already prefilled.
7. Click Create.

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
  --data "name=upstream-timeout"  \
    --data "config.connect_timeout=4000" \
    --data "config.send_timeout=5000" \
    --data "config.read_timeout=5000"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-upstream-timeout>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  connect_timeout: 4000
  send_timeout: 5000
  read_timeout: 5000
plugin: upstream-timeout

Add a plugins entry in the declarative configuration file:

plugins:
- name: upstream-timeout
  config: 
    connect_timeout: 4000
    send_timeout: 5000
    read_timeout: 5000

You can configure this plugin through the Kong Manager UI.

1. In Kong Manager, select the workspace.
2. Open Plugins from the menu, then click New Plugin.
3. Find and select the Upstream Timeout plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.

4. If the option is available, set the plugin scope to Global.
5. Click Create.