basic

EventCatalog Federation Example

This example shows you how to use EventCatalog federation to connect multiple EventCatalog instances together.

In this example we have three teams customer-experience-team, order-management-team and payment-team. Each team has their own EventCatalog instance and keeps there catalog close to their code.

We also have a central EventCatalog instance that is used to view all the teams catalogs and merge them together using federation.

Why Federation?

Federation can help large organizations and teams to:

• Keep their catalog close to their code (no need to swap context)
• Keep their catalog up to date with their code
• Merge many catalogs into a single catalog for an organization
• Create a single source of truth for an organization
• Ease the burden of keeping multiple catalogs in sync
• Ease the burden of keeping documentation up to date as it's close to the code
• Surface relevant information from across an organization

How it works

1. Teams create their own EventCatalog instance. This can be next to the their code or where ever they want.
2. Teams generate there documentation (using plugins or just manual).
3. They commit their documentation to their repository.
4. The central catalog is created, and using the federation plugin it merges many catalogs together into one view.
5. The central catalog is hosted for the organization where people can view the merged catalog and single source of truth.

Making changes to catalogs

1. Teams continue to make changes to their own catalogs as they always have.
2. The central catalog is updated using the federation plugin and changes are merged into the central catalog.
3. The central catalog is rebuilt and redeployed.

Running this example

1. Clone the repository and go into the central-catalog directory
2. Run npm install
3. Get a Federation license key from EventCatalog Cloud (14 day trial)
4. Run the generate command (this will merge many teams catalogs into one, in this example we are merging the customer-experience-team, order-management-team and payment-team catalogs into one central catalog)
5. Run the catalog locally
6. View your catalog at https://localhost:3000