2 posts tagged with "plugin"

EventCatalog now supports integration and document generation from Amazon EventBridge.

The new amazon-eventbridge-plugin has now been released which allows you to generate documentation from your Schema Registry, Targets, Rules and much more.

Plugin Features​

• 📄 Automatic documentation with versioning
• 👨‍⚕️ Add owners (people/teams) to your events
• 📊 Visualise Targets and Rules for Each Event
• 🌎 Quick access to AWS Console within each Event
• 🗄 JSONDraft4 and OpenAPI Schemas
• 💅 Customise and add content to each event (capture information, and details)
• ⚡️ Powered by markdown, setup in seconds.

How plugins work with EventCatalog​

EventCatalog is built to support many brokers, languages and specifications. This allows us to remain technology agnostic and integrate with users existing solutions.

EventCatalog supports generation plugins which you can use to generate documentation from any third party source.

Let's take a quick look at how the generation works...

As we see in the diagram above, EventCatalog supports a generation phase. This means when you run npm run generate on your catalog it will go through all your configured plugins and execute them.

How does generation work with Amazon EventBridge?​

When you configure and install the amazon-eventbridge-plugin and run npm run generate EventCatalog will request data from your EventBridge Schema Registry and parse your event information into documentation that is rendered by your EventCatalog.

When parsing your schemas EventCatalog will render documentation that has Graphs, Quick Links to AWS Console, JSONDraft4 and OpenAPI schemas and much more...

You can read more details on the features and installation guide.

How does your content stay up to date?​

Once you configure your plugin, every time you call npm run generate the new information is pulled down from AWS and transformed inside your catalog.

The EventBridge plugin will check for version changes and version your old events when it needs too.

The core requirement for EventCatalog is to allow people to easily create and maintain documentation for their Event Architectures. You can add any meta information you want to your schema documentation and that information will be used for future events. This means you can add things like event context, team information or schema information once, and this will be persisted across your events (if you choose).

Getting Started​

To get started head over to the plugin installion guide.

Summary​

This is the second plugin to be officially released and we also have a small community of users that are also building more plugins for EventCatalog.

Amazon EventBridge is a great serverless offering that allows us to write Event Driven Applications and EventCatalog allows you to easily document your event schemas.

Documenting your schemas/events for your teams can help your team discover what events are available in your architecture and understand why your events are created in the first place.

EventCatalog is powered by markdown, which means you can add as much context to your EventBridge schemas as you like and share them around with the static website that EventCatalog generates.

If you have any ideas or feedback feel free to raise an issue on GitHub or come join us on Discord.

Enjoy!

EventCatalog now supports integration and document generation from your AsyncAPI specification files.

The new asyncapi-plugin has now been released which allows you to generate documents from your events and services automatically.

How plugins work with EventCatalog​

EventCatalog is built to support many brokers, languages and specifications. This allows us to remain technology agnostic and integrate with users existing solutions.

EventCatalog supports generation plugins which you can use to generate documentation from any third party source.

Let's take a quick look at how the generation works...

As we see in the diagram above, EventCatalog supports a generation phase. This means when you run npm run generate on your catalog it will go through all your configured plugins and execute them.

How does generation work with AsyncAPI?​

When you configure and install the asyncapi-plugin and run npm run generate your AsyncAPI file is parsed and services, events and schemas are extracted from it.

This information is then stored inside the correct places within your catalog and you should be good to go!

What happens to content already in the Catalog?​

If you already have events and services documented in your catalog, the asyncapi-plugin can version your events for you (configurable) before overriding them.

Any content you add in your existing events or services will be used and not overridden on the next generation phase. This means you can keep all your custom markdown content without replacing it every time you generate your documents. The frontmatter of your services and events will be the only things that are replaced.

Summary​

AsyncAPI is a great way for people to document their architectures, allowing you to describe servers, services, events, schemas and much more.

EventCatalog now supports integration with AsyncAPI which hopefully helps you get all the benefits of the catalog alongside your AsyncAPI files.

To get started head over to the async-api plugin api documentation.

If you have any ideas or feedback feel free to raise an issue on GitHub or come join us on Discord.

Enjoy!