Installation

View as Markdown

---

Added in eventcatalog@2.6.0

The EventBridge plugin is a generator that can be used to generate your EventCatalog from an EventBridge registry.

You can map your schemas to services, domains and messages. You can also map all events from your registry into your catalog.

Installation

Run the following command to install the plugin.

"Don't have an EventCatalog project yet?"

If you don't have an EventCatalog project yet, you can follow the instructions in the Getting Started guide.

Install on existing catalog

npm i @eventcatalog/generator-eventbridge

Create new catalog with the EventBridge template

npx @eventcatalog/create-eventcatalog@latest my-catalog --template eventbridge

Configuration

Configure the plugin in your eventcatalog.config.js file.

Add the plugin to the generators array.

Import all schemas

---

In this example we import all schemas from an EventBridge registry.

We don't map them to any services or domains.

eventcatalog.config.js

// ...
generators: [
  // Import all schemas into your catalog
  [
    '@eventcatalog/generator-eventbridge',
    {
      // The region of your EventBridge registry
      region: 'us-east-1',
      // The name of your EventBridge registry
      registryName: 'discovered-schemas'
    },
  ],
],
// ...

Map schemas to producers and consumers

---

In this example we map schemas to producers and consumers (services).

Every time you run the plugin, it will check if the service already exists in your catalog.

If the service already exists, it will not create a new one and just maintain the schema mappings.

We create two services, the orders service and the inventory service.

eventcatalog.config.js

// ...
generators: [
  [
    '@eventcatalog/generator-eventbridge',
    {
      // The region of your EventBridge registry
      region: 'us-east-1',
      // The name of your EventBridge registry
      registryName: 'discovered-schemas',
      // Creating producers and consumers, and mapping them to your catalog
      services: [
        
        // We map schemas to the orders service
        // Using the detailType we can map specific events to the service
        { id: 'Orders Service', version: '1.0.0', sends: [{ detailType: ['OrderPlaced', 'OrderUpdated'], eventBusName: 'orders'}], receives:[{ detailType: "InventoryAdjusted", eventBusName: 'inventory'}] },

        // Map events to the Inventory Service
        // Filter by source (all events that match the source get assigned). This example shows any event matching the source
        // "myapp.orders" will be assigned to the inventory service. The inventory service will publish these events.
        { id: 'Inventory Service', version: '1.0.0', sends: [{ source: "myapp.orders", eventBusName: 'orders'}], receives:[{ detailType: "UserCheckedOut", eventBusName: 'inventory'}] },


        // This service sends events that match the SchemaName prefixing myapp, and will receive events that end with Payment
        // this also does not map any event buses to your events
        { id: 'Payment Service', version: '1.0.0', sends: [{ prefix: "myapp"}], receives:[{ suffix: "Payment" }] }
      ],

      // all services are mapped to this domain
      domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
    },
  ],
],
// ...

Multiple domains, services and events

---

In this example we have two domains, orders and inventory.

We map schemas to the orders and inventory services, and we assign these services to new domains.

If the domain or service already exists in your catalog, the plugin will not create a new one and just maintain the schema mappings.

Why do we define the plugin twice?

The plugin can be defined multiple times in your eventcatalog.config.js file.

In this example we define the plugin twice, the first time we import the schemas and create the orders domain.

The second time we map the inventory service to the inventory domain.

eventcatalog.config.js

// ...
generators: [
  [
    '@eventcatalog/generator-eventbridge',
    {
      // The region of your EventBridge registry
      region: 'us-east-1',
      // The name of your EventBridge registry
      registryName: 'discovered-schemas',
      // Creating producers and consumers, and mapping them to your catalog
      services: [
        // We map schemas to the orders service
        // Using the detailType we can map specific events to the service
        { id: 'Orders Service', version: '1.0.0', sends: [{ detailType: ['OrderPlaced', 'OrderUpdated'], eventBusName: 'orders'}], receives:[{ detailType: "InventoryAdjusted", eventBusName: 'inventory'}] },
      ],

      // all services are mapped to this domain
      domain: { id: 'orders', name: 'Orders', version: '0.0.1' },
    },
  ],
  [
    '@eventcatalog/generator-eventbridge',
    {
      region: 'us-east-1',
      registryName: 'discovered-schemas',
      services: [
        // Create the inventory service and map schemas to it (producer/consumer relationship)
        { id: 'Inventory Service', version: '1.0.0', sends: [{ source: "myapp.orders", eventBusName: 'orders'}], receives:[{ detailType: "UserCheckedOut", eventBusName: 'inventory'}] },
      ],

      // create the inventory domain and assign the inventory service to it
      domain: { id: 'inventory', name: 'Inventory', version: '0.0.1' },
    },
  ],
],
// ...

Configure license key

The EventBridge plugin requires an EventCatalog Scale license key to work with EventCatalog.

You can get a 30-day trial Scale license key by going to EventCatalog Cloud.

You have a few options for setting the license key:

1. Setting license key in .env file (recommended)
2. Setting license key in eventcatalog.config.js

1. Setting license key in .env file (recommended)

Added in eventcatalog@2.35.4

Create a .env file in the root of your project and add the following:

.env

EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key

Using an Older API Key?

If you already have an older EventBridge plugin key, you can still use it with the EventBridge-specific environment variable.

.env

EVENTCATALOG_LICENSE_KEY_EVENTBRIDGE=your-license-key

2. Setting license key in eventcatalog.config.js

If you prefer, you can set the license key in the eventcatalog.config.js file using the licenseKey property in the EventCatalog EventBridge plugin.

eventcatalog.config.js

export default {
  generators: [
    [
      '@eventcatalog/generator-eventbridge',
      {
        licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
        region: 'us-east-1',
        registryName: 'discovered-schemas'
      },
    ],
  ],
};

White listing EventCatalog domains

If you are behind a firewall you will need to white list the domain https://api.eventcatalog.cloud in your firewall. This is because the plugin needs to verify your license key.

Run the plugin

This command will run the generators in your eventcatalog.config.js file.

npm run generate

View your catalog

Run your catalog locally to see the changes

npm run dev

AWS Configuration

Policy for AWS

This plugin will require some read access to your Schema Registry and Versions.

It's recommended you create a new IAM user with the following policy.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "EventCatalog",
            "Effect": "Allow",
            "Action": [
                "schemas:ExportSchema",
                "schemas:SearchSchemas",
                "schemas:ListSchemas",
                "schemas:ListSchemaVersions",
                "schemas:DescribeSchema",
                "schemas:GetDiscoveredSchema"
            ],
            "Resource": "*"
        }
    ]
}

Commercial and License

This plugin requires an EventCatalog Scale license key to be used.

You can get a 30-day trial Scale license key by going to EventCatalog Cloud.

After the trial, you can continue using this plugin with EventCatalog Scale.

See pricing for more information.

Have any questions? You can email us at hello@eventcatalog.dev.

License FAQ

What is the license key for?

The EventCatalog Scale license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.

How do I get an EventCatalog Scale license key?

You can obtain an EventCatalog Scale license key by visiting EventCatalog Cloud. New users can start with a 30-day free trial.

Terms

• Trial Period: 30-day free trial no credit card required
• Support: Discord community support (extra for priority support)

After your trial period ends, you can continue with EventCatalog Scale through EventCatalog Cloud.

Issues

If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators