Skip to main content

Backstage configuration

Overview

The EventCatalog backstage plugin requires configuration in your app-config.yaml files.

Example app-config.yaml file

app-config.yaml
# Backstage configrations...

# eventcatalog plugin configuration
eventcatalog:
# URL of your catalog (has to be public, if private please raise and issue and we can fix this)
URL: "https://demo.eventcatalog.dev"
# map your services (Components type="Service") to EventCatalog services
services:
# The name of the service in backstage
- backstage-name: "backend-service"
# The id of the service in EventCatalog
eventcatalog-id: "InventoryService"
# (optional) the filter value for your discovery table embed
eventcatalog-page-discovery-default-filter: "Inventory Service"
- backstage-name: "backend-service2"
eventcatalog-id: "Orders"
eventcatalog-version: "1.0.0"
# map your APIS (kind: API) to EventCatalog
apis:
- backstage-name: "example-grpc-api"
eventcatalog-id: "NotificationService"

Required fields

URL

  • Type: String

URL of your hosted EventCatalog.

app-config.yaml
eventcatalog:
URL: "https://demo.eventcatalog.dev"

Optional fields

services

This property is to map Backstage Components (spec = service) to EventCatalog.

  • Type: ResourceMap[]
app-config.yaml
eventcatalog:
services:
- backstage-name: "backend-service"
eventcatalog-id: "InventoryService"
eventcatalog-page-discovery-default-filter: "Inventory Service"

Service properties

Property nameRequiredDescription
backstage-nametrueThe name of your service in backstage you want to map
eventcatalog-idtrueThe ID of the service you wish to map to in EventCatalog
eventcatalog-versionoptionalThe version of the service you wish to map too. By default the latest is selected.
eventcatalog-page-discovery-default-filteroptionalFor the discover table (table of messages). This is the default search field entered into the box. Put this as the service name of your EventCatalog service if you want it to load that by default.

apis

This field is to map Backstage APIS to EventCatalog.

  • Type: ResourceMap[]
app-config.yaml
eventcatalog:
apis:
- backstage-name: "example-grpc-api"
eventcatalog-id: "NotificationService"
eventcatalog-version: "1.0.0"
eventcatalog-page-discovery-default-filter: "Notification Service"

Apis properties

Property nameRequiredDescription
backstage-nametrueThe name of your api in backstage you want to map
eventcatalog-idtrueThe ID of the service you wish to map to in EventCatalog
eventcatalog-versionoptionalThe version of the service you wish to map too. By default the latest is selected.
eventcatalog-page-discovery-default-filteroptionalFor the discover table (table of messages). This is the default search field entered into the box. Put this as the service name of your EventCatalog service if you want it to load that by default.

Looking for more mappings? Let us know! Raise an issue on GitHub.