Questions tagged [backstage]

Backstage is an open platform for building developer portals. This tag should be used for questions seeking help with integrating with the Backstage API.

Backstage is an open platform for building developer portals. Powered by a centralized service catalog, Backstage restores order to your microservices and infrastructure and enables your product teams to ship high-quality code quickly — without compromising autonomy.
Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

Out of the box, Backstage includes:

  • Backstage Service Catalog for managing all your software (microservices, libraries, data pipelines, websites, ML models, etc.)

  • Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organization’s best practices

  • Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach

  • Plus, a growing ecosystem of open source plugins that further expand Backstage’s customizability and functionality

Backstage and the CNCF
Backstage is a CNCF Sandbox project. Read the announcement here.

Useful Links

84 questions
6
votes
5 answers

process.env environment variable undefined

I am trying to access an environment variable through process.env in my React/Typescript code, but it's returning undefined. I am able to access NODE_ENV though. console.log(process.env.CURRENT_URL) // prints "undefined" on…
user968437
  • 93
  • 1
  • 1
  • 4
4
votes
2 answers

Backstage tech-docs configuration returning "Error: spawn mkdocs ENOENT"

When I try to run Backstage locally, and visiting the Project documentation, I'm getting the following error: error: Failed to build the docs page: Failed to generate docs from /tmp/backstage-5lZR3i into /tmp/techdocs-tmp-hvh4yi; caused by Error:…
Pablo Darde
  • 5,844
  • 10
  • 37
  • 55
3
votes
1 answer

sonarqube backstage integration is failing

I am currently exploring backstage integration with our own sonarqube instance. Followed instructions…
3
votes
3 answers

Backstage - How to consume environment variables?

The Backstage documentation states that all environment variables must be "exposed" through the central configuration file, app-config.yaml. However, the official documentation is not clear about the use of these variables, for example, in the .ts…
3
votes
2 answers

Cannot create docs for components in backstage docker error

I am trying to display docs stored in repository created by backstage io component on backstage-io /docs page UI, but when I am trying to access the docs I am getting the following error Building a newer version of this documentation failed. Error:…
Veera Silamban
  • 223
  • 1
  • 14
3
votes
1 answer

Backstage: build docker image

I am trying to build a docker image of backstage code (https://github.com/backstage/backstage) Also, my dockerfile is the same as what is documented here: https://backstage.io/docs/deployment/docker#multi-stage-build However, whenever I try to build…
Ena Jain
  • 103
  • 1
  • 12
3
votes
0 answers

why isn't api registered when component is created

I have created a backstage scaffolding template to create a Spring boot rest service deployed to AWS EKS. When a component is created from it in backstage the api is not registered in backstage: the component builds using github actions, is deployed…
stephen newman
  • 533
  • 4
  • 17
2
votes
0 answers

Backstage Techdocs does not render the documentation page. Stuck at "Step 3 of 3: Publishing docs for entity component..."

Techdocs page is stuck at info: Step 3 of 3: Publishing docs for entity component:default/ssr-demo-1 {"timestamp":"2023-08-11T03:39:51.346Z"} I have built Backstage Docker image following the multi-stage build Dockerfile provided in the…
2
votes
1 answer

Backstage Docker build error in yarn step

I created a Dockerfile following the steps in https://backstage.io/docs/deployment/docker/#multi-stage-build When running the Dockerfile at the root "docker image build -t backstage .", I'm getting the error below. I confirm that index.ts exists in…
Jonas Arcangel
  • 2,085
  • 11
  • 55
  • 85
2
votes
1 answer

Backstage errors out when trying to parse definition element of the API component

when backstage tries to process the following api component, it gives an error. apiVersion: backstage.io/v1alpha1 kind: API metadata: name: angry-cats-api description: Lethal cats here spec: type: openapi …
Jimm
  • 8,165
  • 16
  • 69
  • 118
2
votes
1 answer

Backstage running on aws fargate can't fetch catalog on private gitlab repository

I'm trying to run backstage on AWS Fargate, but I'm facing a problem fetching the service catalog that is hosted on a private gitlab. Both gitlab and backstage are running on the same vpc and same private subnets. When I run backstage both locally…
Rafael Marques
  • 1,501
  • 15
  • 23
2
votes
1 answer

error generating documentation my component

I have created a backstage scaffolding template to create a Spring boot rest service deployed to AWS EKS. When a component is created from it in backstage the component builds using github actions, is deployed to AWS EKS and is registered in…
stephen newman
  • 533
  • 4
  • 17
2
votes
1 answer

Customizing spotify backstage UI

I am designing a UI for a developer portal based on spotify backstage. So far i have added google OAuth to the application. Now i want to change the login ui based on a predefined figma. I tried to read through the documentaion for backstage but I…
S.Alvi
  • 144
  • 1
  • 10
2
votes
1 answer

Jira integration in Backstage giving 404 error

I'm currently testing Backstage for my company, and I tried various continuous integration pipelines like Github, Jira, Jenkins, and more. But I'm facing an issue with the Jira plugin. Maybe it's just a bad setup. In my component, I can see the Jira…
Nico
  • 85
  • 1
  • 9
1
vote
1 answer

Backstage failing to start with Schema Error

I have been testing Backstage and all was going well till I did a yarn install this afternoon and now the whole thing has died on me :) Whenever I try to run yarn dev it errors out with [0] Loaded config from app-config.yaml [0]
apr_1985
  • 1,764
  • 2
  • 14
  • 27
1
2 3 4 5 6