@eventcatalog/generator-confluent-schema-registry v0.1.0

Read the Docs | Edit the Docs | View Demo

Core Features

• 📃 Sync your message schemas to services and domains from your Confluent Schema Registry (example)
• ⭐ Go beyond a schema registry. Add semantic meaning to your schemas, business logic and much more. Help you developers understand the message schemas and their relationships.
• 📊 Visualise services and topics in your architecture (demo)
• ⭐ Download your message schemas from EventCatalog (e.g Avro, Protobuf, JSON) (demo)
• 💅 Custom MDX components (read more)
• 🗄️ Auto versioning of your schemas in EventCatalog.
• ⭐ Document your channels and protocols
• ⭐ Document queries, commands and events with your AsyncAPI file using EventCatalog extensions
• ⭐ Discoverability feature (search, filter and more) (demo)
• ⭐ And much more...

How it works

EventCatalog is technology agnostic, meaning it can integrate with any schemas, specs or brokers.

EventCatalog supports generators.

Generators are scripts are run to pre build to generate content in your catalog. Generators can use the EventCatalog SDK.

With this Confluent Schema Registry plugin you can connect your schema registries to your catalog. You can map events and commands to your schemas and keep them in sync with your documentation. You can also define topics and visualize your architecture.

This is done by defining your generators in your eventcatalog.config.js file.

...
generators: [
    // Basic example mapping schemas from confluent schema registry to services without any topics
    [
      '@eventcatalog/generator-confluent-schema-registry',
      {
        // The url of your Confluent Schema Registry
        schemaRegistryUrl: 'http://localhost:8081',
        services: [
          // Maps the exact schema names the service
          // In this example the Orders Service will publish the app.orders.created event and receive the app.orders.updated and app.orders.create commands
          { id: 'Orders Service', version: '1.0.0', sends: [{ events: ["app.orders.created"]}], receives:[{ events: ["app.orders.updated"]}, { commands: ["app.orders.create"]}] },
          // Filter by message (all messages that match the filter get assigned to the service). This example shows any event matching the topic
          { id: 'Inventory Service', version: '1.0.0', sends: [{ events: [{ prefix: "app.orders-"}]}], receives:[{ events: [{ suffix: "app.inventory-"}] }] },
          // Filter by message name (all messages that match the filter get assigned to the service). This example shows any event matching the topic
          { id: 'Payment Service', version: '1.0.0', sends: [{ events: [{ prefix: "app.orders-"}]}], receives:[{ events: [{ suffix: "app.inventory-" }] }] }
        ],
        // All the services are assigned to this domain
        domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
      },
    ],
    // Example of mapping topics to services and domains
    [
      '@eventcatalog/generator-confluent-schema-registry',
      {
        // The url of your Confluent Schema Registry
        schemaRegistryUrl: 'http://localhost:8081',
        topics: [
          { id: 'orders', name: 'Orders Kafka Topic', address: 'broker1.example.com:9092' },
          { id: 'inventory', name: 'Inventory Kafka Topic', address: 'broker2.example.com:9092' },
        ],
        services: [
          // Maps the exact schema names the service
          // In this example the Orders Service will publish the app.orders.created event and receive the app.orders.updated and app.orders.create commands
          { id: 'Orders Service', version: '1.0.0', sends: [{ events: ["app.orders.created"], topic: 'orders' }], receives:[{ events: ["app.orders.updated"], topic: 'orders' }, { commands: ["app.orders.create"], topic: 'orders' }] },
          // Filter by message (all messages that match the filter get assigned to the service). This example shows any event matching the topic
          { id: 'Inventory Service', version: '1.0.0', sends: [{ events: [{ prefix: "app.orders-"}, { topic: 'inventory' }] }], receives:[{ events: [{ suffix: "app.inventory-"}] }] },
          // Filter by message name (all messages that match the filter get assigned to the service). This example shows any event matching the topic
          { id: 'Payment Service', version: '1.0.0', sends: [{ events: [{ prefix: "app.orders-"}, { topic: 'inventory' }] }], receives:[{ events: [{ suffix: "app.inventory-" }] }] }
        ],
        // All the services are assigned to this domain
        domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
      },
    ],
    // This example saves all messages (schemas) from the registry to EventCatalog without mapping to services or domains
    [
      '@eventcatalog/generator-confluent-schema-registry',
      {
        // The url of your Confluent Schema Registry
        schemaRegistryUrl: 'http://localhost:8081',
      },
    ],
  ],
...

In the example above we have three types of usecases for the generator:

1. Map schemas to events/commands and assign them to producers and consumers (services). Group services into a domain or subdomain.
2. Same as number 1, but we also create topics in EventCatalog (channels) and document them.
3. Example number 3, we dont' assign any schemas to services or topics. We just add all schemas to EventCatalog regardless of the service or domain.

Getting started

Installation and configuration

Make sure you are on the latest version of EventCatalog.

1. Install the package

@eventcatalog/generator-confluent-schema-registry

2. Configure your eventcatalog.config.js file (see example)

3. Set credentials for your Confluent Schema Registry. Create a .env file in the root of your project and add the following:

# From eventcatalog.cloud (14 day free trial)
EVENTCATALOG_LICENSE_KEY_CONFLUENT_SCHEMA_REGISTRY=

# From Confluent Schema Registry
CONFLUENT_SCHEMA_REGISTRY_KEY=
CONFLUENT_SCHEMA_REGISTRY_SECRET=

4. Run the generate command

npm run generate

5. See your new domains, services and messages, run

npm run dev

Found a problem?

Raise a GitHub issue on this project, or contact us on our Discord server.

Commercial Use

This generator requires a license to be used with EventCatalog. You can get a 14 day free trial at https://eventcatalog.cloud or email us at hello@eventcatalog.dev.