Prompt
How do I connect Backstage to our existing tools?
Latest observation
Backstage connects to existing tools by bringing their data into Backstage through plugins and integrations. In practice, you usually do three things:
-
Choose the systems you want to surface
- Source control: GitHub, GitLab, Bitbucket, Azure DevOps
- CI/CD: Jenkins, GitHub Actions, Argo CD, CircleCI
- Incident/alerts: PagerDuty, Opsgenie, ServiceNow
- Docs: Confluence, MkDocs, ADRs in Git
- Cloud/platform: Kubernetes, AWS, GCP, Azure
- Monitoring: Datadog, Prometheus, Grafana
- Ticketing: Jira, Linear, ServiceNow
-
Install/configure the matching Backstage plugins
- Many integrations are available as:
- core/backstage-integrations for SCM discovery
- frontend plugins to display data in the UI
- backend modules to fetch and normalize data
- Example categories:
- Catalog: discover services from repos and YAML metadata
- TechDocs: render docs from your repo
- CI/CD / K8s / Monitoring: show runtime status, build status, dashboards
- Scaffolder: create standardized repos/services
- Permissions/identity: connect to your SSO/IdP
- Many integrations are available as:
-
Describe your tools in Backstage metadata
- Backstage’s Software Catalog is the backbone.
- Add
catalog-info.yamlto each repo/service so Backstage can ingest it. - Example:
apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: payments-service description: Handles payment processing spec: type: service lifecycle: production owner: team-payments system: checkout dependsOn: - resource:postgres-main - Then point Backstage at your repos or a location that contains those YAML files.
Typical connection patterns
Git provider
Use the SCM integration to:
- discover repos automatically
- import catalog files
- link “View Source”, “Edit”, and “CI” buttons
CI/CD
Use a CI plugin to show:
- build status
- deployment status
- pipeline links
Kubernetes / deployments
Use the Kubernetes plugin or Argo CD plugin to show:
- pod health
- deployment replicas
- rollouts
- namespace resources
Docs
Use TechDocs so documentation lives with the code:
- docs in
/docs - generated and hosted automatically
Identity and access
Connect your IdP:
- Okta / Azure AD / Google Workspace / Auth0 / Keycloak
- use SSO for login and group membership mapping
Recommended implementation approach
-
Start with the Catalog
- Integrate GitHub/GitLab and ingest
catalog-info.yaml - Get entities, ownership, and relationships working first
- Integrate GitHub/GitLab and ingest
-
Add docs
- Enable TechDocs for developer-facing documentation
-
Add operational visibility
- CI/CD, Kubernetes, incidents, dashboards
-
Add scaffolding
- Standardize service creation and repo setup
-
Add permissions and entity ownership
- Map teams/groups from your IdP into Backstage
Example setup steps
If you’re on GitHub:
- configure GitHub integration in
app-config.yaml - add catalog entity locations
- create
catalog-info.yamlin each repo - enable GitHub, TechDocs, and any runtime plugins you need
Example config snippet:
integrations:
github:
- host: github.com
token: ${GITHUB_TOKEN}
catalog:
locations:
- type: url
target: https://github.com/your-org/some-repo/blob/main/catalog-info.yaml
What you usually need to decide first
- Which tools are “source of truth” for each domain?
- Do you want automatic discovery or manual registration?
- Which systems should be visible in the portal vs. just linked out?
- Who owns each service and how do you map teams?
If you want, I can help you with a specific integration plan for your environment, for example:
- GitHub + Jenkins + Kubernetes
- GitLab + Argo CD + Confluence
- Azure DevOps + AKS + Jira
If you share your current tools, I can outline the exact Backstage plugins and config you’d need.