Schema registry

Uses: Event Gateway kongctl Konnect API Terraform

What is a schema registry?

Schema registries are resources that you can use in Schema Validation policies to validate messages against the Confluent schema registry.

Event Gateway supports the following registry types:

Avro
JSON Schema

Set up a schema registry

curl -X POST https://{region}.api.konghq.com/v1/event-gateways/{eventGatewayId}/schema-registries \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "my-schema-registry",
      "type": "confluent",
      "config": {
        "schema_type": "avro",
        "endpoint": "endpoint",
        "timeout_seconds": 10,
        "authentication": {
          "type": "basic",
          "username": "username",
          "password": "'$MY_PASSWORD'"
        }
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
virtualClusterId: The id of the Virtual Cluster.
eventGatewayId: The id of the Event Gateway.
eventGatewayListenerId: The id of the Event Gateway Listener.

See the Konnect Event Gateway API reference to learn about region-specific URLs and personal access tokens.

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect-beta = {
      source  = "kong/konnect-beta"
    }
  }
}

provider "konnect-beta" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

resource "konnect_event_gateway_schema_registry" "my_schema_registry" {
  provider = konnect-beta
  type = "confluent"
  config = {
    schema_type = "avro"
    endpoint = "endpoint"
    timeout_seconds = 10

    authentication = {
      type = "basic"
      username = "username"
      password = "$MY_PASSWORD"
    }
  }



  gateway_id = konnect_event_gateway.my_event_gateway.id
}

Copied!

The following creates a new schema registry called my-schema-registry.

Add this snippet to an event_gateways resource in your declarative configuration file, and then manage it with kongctl:

schema_registry.yaml

Copied!

event_gateways:
  - ref: eventGatewayName
    name: eventGatewayName
    schema_registries:
    - ref: my-schema-registry
      name: my-schema-registry
      type: confluent
      config:
        schema_type: avro
        endpoint: endpoint
        timeout_seconds: 10
        authentication:
          type: basic
          username: username
          password: "$MY_PASSWORD"

Make sure to replace the following placeholders with your own values:

eventGatewayName: The name of your Event Gateway.

In Konnect, navigate to Event Gateway in the sidebar.
Click an Event Gateway.
Navigate to Resources in the sidebar.
Click New Schema Registry.
In the Name field, enter my-schema-registry.
Configure your schema registry.
Click Create.

Schema registry

What is a schema registry?

Set up a schema registry

Schema

Help us make these docs great!

Still need help?