Backstage Catalog Info

Generate, update, and validate standard Backstage descriptor files (catalog-info.yaml) to register software entities and metadata in the Backstage Software Catalog.

What to do

Phase 1 — Identify Entity Kind & Purpose

1. Determine the target entity kind based on what is being cataloged:
   • Component: Individual software units (services, websites, libraries, pipelines).
   • API: API interfaces and contracts (OpenAPI, gRPC, GraphQL, AsyncAPI).
   • Resource: Infrastructure or dependencies (databases, S3 buckets, queues, clusters).
   • System: Collections of components and APIs serving a unified business purpose.
   • Domain: High-level organizational boundaries wrapping systems.
   • User / Group: Organizational hierarchy, teams, and individuals.
   • Template: Software Scaffolder templates for creating new projects.
   • Location: References to external catalog files or directories.