Building an Internal Software Catalog with Backstage

说明与用途

Backstage 内部目录加速了服务发现，明确了所有权，并简化了团队入职，带来了可衡量的业务影响。

问题

Developers cannot quickly locate services, libraries, or documentation, leading to duplicated work, slow onboarding, and delayed incident response.

结果

The catalog enabled immediate discoverability, reduced duplicate work, clarified ownership, and accelerated onboarding, while providing metrics for adoption and business impact.

工作流

• Define minimal catalog-info.yaml schema with required fields (name, description, tags, owner, type, lifecycle).
• Create a scaffolder template that generates a new repo with catalog-info.yaml, README, TechDocs stub, and CI pipeline.
• Configure app-config.yaml integrations for GitHub (or other hosts) to enable discovery providers and schedule scans.
• Set up automated catalog health jobs to flag missing owners, stale lifecycles, or failing CI and notify via Slack.
• Enforce governance rules: require catalog-info.yaml for production services, allow lighter rules for libraries, and establish trusted committer roles.

证据

Every time a developer can’t find the service they need, work halts.

来源

Backstage’s Software Catalog is built precisely for that purpose: it centralizes metadata about services, libraries, APIs, docs, and teams so discovery becomes a first‑class developer action rather than an archaeological dig.

来源

Provide a scaffolder template that creates the repo with a catalog-info.yaml, README.md, TechDocs stub, and a CI pipeline.

来源

Use scheduled discovery providers (GitHub Discovery, GitLab Discovery) to re‑scan repositories for descriptor changes.

来源