Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backstage #731

Closed
hvandenb opened this issue Aug 21, 2024 · 4 comments
Closed

Backstage #731

hvandenb opened this issue Aug 21, 2024 · 4 comments
Labels
enhancement New feature or request integrations

Comments

@hvandenb
Copy link

Feature Request

Backstage is a popular developer portal. It support catalogs and markdown documention. Ideally Event Catalog is integrated with it.

Some suggested options

  1. Plugin to allow content from EC to be shown
  2. Integrate the software catalog (services etc) into EV
@boyney123 boyney123 added enhancement New feature or request integrations labels Aug 22, 2024
@boyney123
Copy link
Collaborator

Will be exploring this in September, any suggestions are welcome. I'm new to backstage, so any thoughts would be welcome if anyone has any.

@hpatoio
Copy link
Contributor

hpatoio commented Sep 9, 2024

Ciao, a couple of notes that I hope can speedup your on boarding on Backstage.

Backstage's catalog is a collection of entities. An entity can be of kind component. Quoting Backstage's doc a Component describes a software component. See here the details.

I think that you can map a component to an EV'service

Components can provide or consume APIs

Also api is a kind of entity. (details here) API can be of differents types. I think you are interested only in openapi and asyncapi.

Specs can be put inline as in the example of you can reference a file. Both in the same repo

  definition:
    $text: my-openapi.yml

or external as URL.

  definition:
    $text: https://my.source/asyncapi.com

To group components you can use systems and domains https://backstage.io/docs/features/software-catalog/system-model/#ecosystem-modeling

Hope it helps to put your head on Backstage

@brunocascio
Copy link

Backstage and eventcatlog have more likely the same structure, so due to both tools are code driven (one with yaml and the other one with markdown) sounds like it will generate a lof of "duplication". Maybe if eventcatalog provides an iframe or something that can be embbed within a backstage entity could be a good experience.

Backstage lacks of visualization about events and eventcatalog provides an amazing experience for event documentation but it lacks the rest of the backstage's features.

I was doing some PoC extending backstage model creating a new kind: Event and adding publishEvent and consumeEvent custom relationships because there's no way to visualize who produce/consume which event in Backstage but then I found this and I would to see how it goes :)

@boyney123
Copy link
Collaborator

Folks this is now live! https://www.eventcatalog.dev/docs/development/plugins/backstage/intro

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request integrations
Projects
None yet
Development

No branches or pull requests

4 participants