WebSocket Size Limit Configuration Examples

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=websocket-size-limit"  \
    --data "config.client_max_payload=1024"  \
    --data "config.upstream_max_payload=16384"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: websocket-size-limit-example
plugin: websocket-size-limit
config:
  client_max_payload: 1024
  upstream_max_payload: 16384
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the service as follows:

kubectl annotate service SERVICE_NAME konghq.com/plugins=websocket-size-limit-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

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: websocket-size-limit
  service: SERVICE_NAME|SERVICE_ID
  config:
    client_max_payload: 1024
    upstream_max_payload: 16384

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
    --data "name=websocket-size-limit"  \
    --data "config.client_max_payload=1024"  \
    --data "config.upstream_max_payload=16384"

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

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: websocket-size-limit-example
plugin: websocket-size-limit
config:
  client_max_payload: 1024
  upstream_max_payload: 16384
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=websocket-size-limit-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

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: websocket-size-limit
  route: ROUTE_NAME|ROUTE_ID
  config:
    client_max_payload: 1024
    upstream_max_payload: 16384

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

Make the following request:

curl -X POST http://localhost:8001/consumers/CONSUMER_NAME|CONSUMER_ID/plugins \
    --data "name=websocket-size-limit"  \
    --data "config.client_max_payload=1024"  \
    --data "config.upstream_max_payload=16384"

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: websocket-size-limit-example
plugin: websocket-size-limit
config:
  client_max_payload: 1024
  upstream_max_payload: 16384
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the KongConsumer object as follows:

kubectl annotate KongConsumer CONSUMER_NAME konghq.com/plugins=websocket-size-limit-example

Replace CONSUMER_NAME with the name of the consumer that this plugin configuration will target. You can see your available consumers by running kubectl get KongConsumer.

To learn more about KongConsumer objects, see Provisioning Consumers and Credentials .

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: websocket-size-limit
  consumer: CONSUMER_NAME|CONSUMER_ID
  config:
    client_max_payload: 1024
    upstream_max_payload: 16384

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --data "name=websocket-size-limit"  \
    --data "config.client_max_payload=1024"  \
    --data "config.upstream_max_payload=16384"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-websocket-size-limit>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  client_max_payload: 1024
  upstream_max_payload: 16384
plugin: websocket-size-limit

Add a plugins entry in the declarative configuration file:

plugins:
- name: websocket-size-limit
  config:
    client_max_payload: 1024
    upstream_max_payload: 16384