Required Metadata

Published on February 24th, 2022

In order to use some plugins you may need to add metadata to entities. Generally, this means adding an annotation but it could also mean adding a link or label.


Below, in the table, you will find a list of the plugins and required annotations you may need to add. You can read more about annotations and what they represent in Backstage documentations.

Package Plugin name Required Annotations
@roadiehq/backstage-plugin-argo-cd Argo CD argocd/app-name or argocd/project-name
@roadiehq/backstage-plugin-aws-lambda AWS Lambda
@roadiehq/backstage-plugin-bugsnag Bugsnag
@roadiehq/backstage-plugin-buildkite Buildkite
@backstage/plugin-circleci Circle CI
@backstage/plugin-cloudbuild Cloudbuild
@roadiehq/backstage-plugin-datadog Datadog or
@roadiehq/backstage-plugin-firebase-functions Firebase Functions
@roadiehq/backstage-plugin-github-insights Github Insights
@roadiehq/backstage-plugin-github-pull-requests Github Pull Requests
@k-phoen/backstage-plugin-grafana Grafana grafana/alert-label-selector or grafana/dashboard-selector
@backstage/plugin-jenkins Jenkins
@roadiehq/backstage-plugin-jira Jira jira/project-key
@k-phoen/backstage-plugin-opsgenie Opsgenie
@backstage/plugin-pagerduty Pagerduty
@roadiehq/backstage-plugin-prometheus Prometheus or
@backstage/plugin-rollbar Rollbar
@roadiehq/backstage-plugin-security-insights Security Insights
backstage-plugin-snyk Snyk and
@backstage/plugin-sonarqube Sonarqube
@backstage/plugin-splunk-on-call Splunk On-Call or
@roadiehq/backstage-plugin-travis-ci Travis CI
@backstage/plugin-dynatrace Dynatrace
@backstage/plugin-dynatrace Dynatrace

The catalog plugin provides cards to display metadata to users if the relevant metadata isn’t there then the card is hidden. For example, the EntityLinksCard requires links to be set and similarly the EntityLabelsCard requires labels to be set.

Further Reading