Skip to main content

Using Backstage Plugins

Placeholder

This document is a structural draft (placeholder). Each section only lists the items to be covered. Content will be added later.

What this document covers​

Understand the Backstage plugin mechanism so you can add, configure, and build the capabilities you need via plugins.

1. Plugin architecture​

  • Difference between frontend and backend plugins
  • Overview of the new backend system
  • Plugin distribution path (npm packages)

2. Common installation steps​

  • Add the package (yarn add)
  • Register it in the frontend/backend
  • Configure app-config.yaml
  • Handling credentials / secrets

3. Representative core / official plugins​

  • Kubernetes
  • CI/CD (GitHub Actions, Azure DevOps, etc.)
  • TechDocs
  • Search
  • Cost Insights

4. Representative third-party plugins​

  • Security (see the dedicated Dependency Track doc)
  • Monitoring / observability
  • Other community plugins (plugin marketplace)

5. Building your own plugin​

  • Scaffolding (@backstage/cli)
  • Adding frontend components
  • Adding a backend module / API
  • Testing and distribution (internal npm registry)

6. Selecting and managing plugins​

  • Evaluating maintenance status / community activity
  • Version compatibility (alignment with core Backstage)
  • Impact scope during upgrades

Best Practices​

  • Keep to the minimum necessary plugins
  • Pin versions and define an upgrade policy
  • Customize at plugin boundaries
  • Anti-patterns (fork sprawl, depending on unmaintained plugins)

References​