Skip to main content

Introduction

Federation is still in beta, and API's may change based on feedback.
Please report any issues on Discord or GitHub
Added in eventcatalog@2.18.0
License: Dual-license

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

EventCatalog Federation

How it works​

EventCatalog Federation is powered by the EventCatalog Federation Generator.

You will need to create a new EventCatalog instance that will be your main catalog, this will be the one you will use to generate your documentation and host your documentation for your users.

In your main catalog you will need to use the federation generator to connect to your other distributed catalogs. The federation generator uses git to clone your other catalogs and merge them into your main catalog, this means the generator supports any git repository (e.g GitHub, GitLab, Bitbucket, etc).

Commercial Use​

This plugin is governed by a dual-license. To ensure the sustainability of the project, you can freely make use of this software if usage is also Open Source. Otherwise for proprietary use, internal use, and private modifications you must obtain a commercial license.

To purchase a license you to login to the EventCatalog Dashboard or if you have any questions you you can email us at hello@eventcatalog.dev.

Login to EventCatalog Dashboard