WebSocket Validator Configuration Examples

Configuration Examples

Enable on a service

Enable on a route

Enable on a consumer

Enable globally

The following examples provide some typical configurations for enabling the websocket-validator plugin on a service.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=websocket-validator"  \
    --data "config.client.text.type=draft4"  \
    --data "config.client.text.schema={
  \"type\": \"object\",
  \"properties\": {
    \"foo\": { \"type\": \"string\" },
    \"bar\": { \"type\": \"string\" }
  },
  \"required\": [ \"foo\", \"bar\" ]
}
"

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-validator-example
plugin: websocket-validator
config:
  client:
    text:
      type: draft4
      schema: |
        {
          "type": "object",
          "properties": {
            "foo": { "type": "string" },
            "bar": { "type": "string" }
          },
          "required": [ "foo", "bar" ]
        }
" | 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-validator-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-validator
  service: SERVICE_NAME|SERVICE_ID
  config:
    client:
      text:
        type: draft4
        schema: |
          {
            "type": "object",
            "properties": {
              "foo": { "type": "string" },
              "bar": { "type": "string" }
            },
            "required": [ "foo", "bar" ]
          }

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

The following examples provide some typical configurations for enabling the websocket-validator plugin on a route.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
    --data "name=websocket-validator"  \
    --data "config.client.text.type=draft4"  \
    --data "config.client.text.schema={
  \"type\": \"object\",
  \"properties\": {
    \"foo\": { \"type\": \"string\" },
    \"bar\": { \"type\": \"string\" }
  },
  \"required\": [ \"foo\", \"bar\" ]
}
"

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-validator-example
plugin: websocket-validator
config:
  client:
    text:
      type: draft4
      schema: |
        {
          "type": "object",
          "properties": {
            "foo": { "type": "string" },
            "bar": { "type": "string" }
          },
          "required": [ "foo", "bar" ]
        }
" | 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-validator-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-validator
  route: ROUTE_NAME|ROUTE_ID
  config:
    client:
      text:
        type: draft4
        schema: |
          {
            "type": "object",
            "properties": {
              "foo": { "type": "string" },
              "bar": { "type": "string" }
            },
            "required": [ "foo", "bar" ]
          }

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

The following examples provide some typical configurations for enabling the websocket-validator plugin on a consumer.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/consumers/CONSUMER_NAME|CONSUMER_ID/plugins \
    --data "name=websocket-validator"  \
    --data "config.client.text.type=draft4"  \
    --data "config.client.text.schema={
  \"type\": \"object\",
  \"properties\": {
    \"foo\": { \"type\": \"string\" },
    \"bar\": { \"type\": \"string\" }
  },
  \"required\": [ \"foo\", \"bar\" ]
}
"

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-validator-example
plugin: websocket-validator
config:
  client:
    text:
      type: draft4
      schema: |
        {
          "type": "object",
          "properties": {
            "foo": { "type": "string" },
            "bar": { "type": "string" }
          },
          "required": [ "foo", "bar" ]
        }
" | 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-validator-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-validator
  consumer: CONSUMER_NAME|CONSUMER_ID
  config:
    client:
      text:
        type: draft4
        schema: |
          {
            "type": "object",
            "properties": {
              "foo": { "type": "string" },
              "bar": { "type": "string" }
            },
            "required": [ "foo", "bar" ]
          }

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

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the WebSocket Validator plugin globally.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --data "name=websocket-validator"  \
    --data "config.client.text.type=draft4"  \
    --data "config.client.text.schema={
  \"type\": \"object\",
  \"properties\": {
    \"foo\": { \"type\": \"string\" },
    \"bar\": { \"type\": \"string\" }
  },
  \"required\": [ \"foo\", \"bar\" ]
}
"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-websocket-validator>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  client:
    text:
      type: draft4
      schema: |
        {
          "type": "object",
          "properties": {
            "foo": { "type": "string" },
            "bar": { "type": "string" }
          },
          "required": [ "foo", "bar" ]
        }
plugin: websocket-validator

Add a plugins entry in the declarative configuration file:

plugins:
- name: websocket-validator
  config:
    client:
      text:
        type: draft4
        schema: |
          {
            "type": "object",
            "properties": {
              "foo": { "type": "string" },
              "bar": { "type": "string" }
            },
            "required": [ "foo", "bar" ]
          }

Previous WebSocket Validator Configuration