Introduction
eventcatalog@2.18.0Dual-licenseEventCatalog 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.
- Your teams create their own EventCatalog instances
- Your teams document their services, messages and domains in their own EventCatalog
- Your teams commit their EventCatalog to a git repository, either in the same repo as your code or in a separate repo
- You setup a main catalog that will be the source of truth for your documentation
- You use the federation generator to merge your teams catalogs into the main catalog
- You setup CI/CD to keep your main catalog up to date with your teams catalogs (or just rebuild every X time)
To use the federation generator you will need a License Key from EventCatalog Cloud. You can get a free 14 day trial license key for the plugin.
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
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.