Check mandatory Backstage metadata is set

Published on October 6th, 2022

Entity metadata such, as the title and description, is pretty much necessary to make the Backstage Catalog useful. You can use Tech Insights to find components which are not fully filled out.

For example, you can create a check with the following attributes to find services which are missing the title metadata:

FieldInput
NameEnsure titles are present on Backstage entities.
DescriptionA title is a human readable name for the Backstage component.
Data sourceEntity Metadata (built-in).
FactHas Title
Fact operatorIs True

Roadie provides other metadata values to check for, such as the description, tags, lifecycle, namespace, and owner.