devxp-tech/backstage

⚙️ Backstage System

Backstage

Backstage - IDP

Environments you need before start

Name	Where to get?
GITHUB_ACCESS_TOKEN	Generate a new personal access token in GIthub Secure page
AUTH_GITHUB_CLIENT_ID	Get in Github app ID
AUTH_GITHUB_CLIENT_SECRET	Open a tiket to Devxp to share this value
SONARQUBE_TOKEN	Create a Sonarqube token using this documentation

All environments above MUST be exported in your bash context like below:

# .bashrc or .zshrc
export GITHUB_ACCESS_TOKEN='YOUR-TOKEN-HERE'
export AUTH_GITHUB_CLIENT_ID='YOUR-TOKEN-HERE'
export AUTH_GITHUB_CLIENT_SECRET='YOUR-TOKEN-HERE'
export SONARQUBE_TOKEN='YOUR-TOKEN-HERE'

Setup your hosts

You'll need to create an entry to your /etc/hosts to specify backstage.local like below:

# /etc/hosts

# ...
127.0.0.1 backstage.local
#...

🚀 Start project

You'll need Docker and docker-compose installed before you continue!

Once all you need is in your bash context, just run the commands below:

docker-compose run --rm app yarn # to install node_modules
docker-compose up -d app # to up the backstage application

Backstage in develop mode will be available in http://backstage.local:3000 and it's using GitHub SSO integration

🆙 Backstage Update

docker-compose run --rm app bash
yarn backstage-cli versions:bump

🚦 Work Flux

graph TD;
    Dev-->Backstage;
    Backstage--create-->devxp-app;
    devxp-app-->golang;
    devxp-app-->python;
    devxp-app-->node;
    golang--new-app-->backstage-catalog;
    backstage-catalog--fetch-->github/devxp-tech/template-golang;
    backstage-catalog--fetch-->kubernetes-skelleton;
    backstage-catalog--push-->github/devxp-tech/new-app;
    kubernetes-skelleton--PullRequest-->ArgoCD;
    github/devxp-tech/new-app--workflow-->devxp-tech/.github/workflows;
    ArgoCD--pull-->helm-charts/devxp-app;
    ArgoCD--deploy-->Kubernetes;
    devxp-tech/.github/workflows--push/docker-image-->ghcr.github.com/devxp-tech;
    Kubernetes--pull/docker-image-->ghcr.github.com/devxp-tech;
    Kubernetes-->new-app;

Loading

🧩 References

• ArgoCD
• helm-charts
• Backstage
• backstage-catalog:
• template-golang
• github-workflows

✨ Contributions

We ❤️ contributions big or small. See our guide on how to get started.

Thanks to all our contributors!

Made with 💜 by DevXP-Tech.

backstage's Issues

Docker build fails

Hi When trying to build a docker image I get the following error

#14 583.8 packages/backend/src/plugins/kubernetes.ts:9:60 - error TS2345: Argument of type '{ logger: winston.Logger; config: Config; }' is not assignable to parameter of type 'KubernetesEnvironment'. #14 583.8 Property 'catalogApi' is missing in type '{ logger: winston.Logger; config: Config; }' but required in type 'KubernetesEnvironment'. #14 583.8 #14 583.8 9 const { router } = await KubernetesBuilder.createBuilder({ #14 583.8 ~ #14 583.8 10 logger: env.logger, #14 583.8 ~~~~~~~~~~~~~~~~~~~~~~~ #14 583.8 11 config: env.config, #14 583.8 ~~~~~~~~~~~~~~~~~~~~~~~ #14 583.8 12 }).build(); #14 583.8 ~~~ #14 583.8 #14 583.8 node_modules/@backstage/plugin-kubernetes-backend/dist/index.d.ts:250:5 #14 583.8 250 catalogApi: CatalogApi; #14 583.8 ~~~~~~~~~~ #14 583.8 'catalogApi' is declared here. #14 583.8 #14 583.8 #14 583.8 Found 1 error in packages/backend/src/plugins/kubernetes.ts:9 #14 583.8 #14 584.1 info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command. #14 584.1 error Command failed with exit code 2.

The backstage-catalog link is broken.

I try to access https://github.com/devxp-tech/backstage-catalog following this document in this repo, but the link return not found or may be not public.

Could you please make it available?

🚧 Sonarqube integration

Fix Sonarqube Integration

🚧 Sonarqube integration

Fix Sonarqube plugin and integration