Introduction

View as Markdown

---

Deprecated

The @eventcatalog/generator-federation generator is deprecated. Federation is now built into EventCatalog and runs with eventcatalog federate. See the EventCatalog Federation docs to get started.

This page documents the legacy generator for existing users.

Added in eventcatalog@2.18.0

---

EventCatalog Federation is a feature that allows you to merge multiple EventCatalog instances into a single catalog.

This is useful if you:

• Have multiple teams that want to own there own EventCatalog / Documentation
• Want to keep your documentation close to your code
• Want to give ownership of documentation to different teams and still have a single source of truth

How it works

EventCatalog Federation is powered by the EventCatalog Federation Generator.

1. Your teams create their own EventCatalog instances
2. Your teams document their services, messages and domains in their own EventCatalog
3. Your teams commit their EventCatalog to a git repository, either in the same repo as your code or in a separate repo
4. You setup a main catalog that will be the source of truth for your documentation
5. You use the federation generator to merge your teams catalogs into the main catalog
6. You setup CI/CD to keep your main catalog up to date with your teams catalogs (or just rebuild every X time)

The federation generator is open source under the MIT License and doesn't need a license key.

You can read more documentation:

• Configuring your main catalog
  • This is the main catalog for your organization. It will pull in and merge documentation from your teams catalogs.
• Configuring your team catalogs
  • This is the documentation for how to setup your team catalogs

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