Backstage

Keywords: Developer Portal, Software Catalog

Links

• Code Repository
• Main Website
• Plugin
• Spotify / Learn
• Docs
  • Backstage Software Catalog
  • TechDocs Documentation
  • Backstage Software Templates

Demos

• Backstage
• Open edX

Configuration

• app-config.yaml

Glossary

• Internal Developer Platform (IDP)

CLI

Commands

npx @backstage/create-app -h

Bootstrap

#
npx @backstage/create-app \
  --path ./ \
  --skip-install

Tips

Visual Studio Code

#
code --install-extension Intility.vscode-backstage

#
jq '."recommendations" += ["Intility.vscode-backstage"]' "$PWD"/.vscode/extensions.json | sponge "$PWD"/.vscode/extensions.json

Shortcut: Shift (⇧) + N

Issues

TBD

backend:dev: 2023-02-17T09:33:32.879Z backstage error Request failed with status 500 Missing index for techdocs. This could be because the index hasn't been created yet or there was a problem during index creation. type=errorHandler name=MissingIndexError cause=undefined stack=MissingIndexError: Missing index for techdocs. This could be because the index hasn't been created yet or there was a problem during index creation.

TODO

TBD

5error: Failed to build the docs page: Failed to generate docs from /var/folders/p_/l3lkz0q96wl948j7twxnm1pw0000gn/T/backstage-AO2i9G into /private/var/folders/p_/l3lkz0q96wl948j7twxnm1pw0000gn/T/techdocs-tmp-sfmi0L; caused by Error: This operation requires Docker. Docker does not appear to be available. Docker.ping() failed with; caused by Error: connect ENOENT /var/run/docker.sock {"timestamp":"2023-02-17T08:56:41.434Z"}

techdocs:
  builder: local
  generator:
    runIn: local
  publisher:
    type: local

TBD

7ERROR    -  Config value 'markdown_extensions': Failed to load extension 'markdown_inline_mermaid'.8ModuleNotFoundError: No module named 'markdown_inline_mermaid'

TODO

TBD

5error: Failed to build the docs page: Failed to generate docs from /var/folders/p_/l3lkz0q96wl948j7twxnm1pw0000gn/T/backstage-JlQkER into /private/var/folders/p_/l3lkz0q96wl948j7twxnm1pw0000gn/T/techdocs-tmp-KiOw71; caused by Error: spawn mkdocs ENOENT {"timestamp":"2023-02-17T09:01:04.991Z"}

Missing mkdocs in your PATH. Please install it and try again.

TBD

7ERROR    -  Config value 'docs_dir': The path '/private/var/folders/p_/l3lkz0q96wl948j7twxnm1pw0000gn/T/backstage-WR7RRy/docs' isn't an existing directory.

TODO

Helm

Dependencies

• Cert Manager (cert-manager)
  • Local

References

• Chart Repository

Repository

helm repo add backstage 'https://backstage.github.io/charts'
helm repo update

Install

#
kubectl create ns backstage
# kubectl create ns catalog

#
kubens backstage

#
helm search repo -l backstage/backstage

#
export KUBERNETES_IP='<kubernetes-ip>'
export DOMAIN="${KUBERNETES_IP}.nip.io"

#
helm upgrade backstage backstage/backstage \
  --version 0.14.0 \
  -f <(cat << EOF
ingress:
  enabled: true
  className: nginx
  host: backstage.${K8S_DOMAIN}
  tls:
    enabled: true
    secretName: backstage.tls-secret

backstage:
  extraEnvVars:
    - name: APP_CONFIG_app_baseUrl
      value: https://backstage.${K8S_DOMAIN}
    - name: APP_CONFIG_backend_baseUrl
      value: https://backstage.${K8S_DOMAIN}
    # - name: POSTGRES_HOST
    #   value: backstage-postgresql

  # extraEnvVarsSecrets:
  #   - backstage-database-authentication
  #   - backstage-kubernetes-authentication
  #   - backstage-github-authentication

# postgresql:
#   enabled: true
#   auth:
#     username: backstage
#     password: backstage
EOF
)

#
kubectl get all

Status

kubectl rollout status deployment/backstage

Logs

kubectl logs \
  -l 'app.kubernetes.io/instance=backstage' \
  -n backstage \
  -f

Secret

kubectl get secret backstage-postgresql \
  -o jsonpath='{.data.password}' | \
    base64 -d; echo

Issues

TBD

Login failed; caused by Error: Login failed, this email <username>@<domain> does not belong to the expected domain

TODO

TBD

The Google provider is not configured to support sign-in

TODO

Missing Env. Variables

Failed to load entity kinds

index.esm.js:1466          GET http://localhost:7007/api/catalog/entity-facets?facet=kind net::ERR_CONNECTION_REFUSED
index.esm.js:1466          GET http://localhost:7007/api/catalog/entity-facets?facet=metadata.tags net::ERR_CONNECTION_REFUSED
index.esm.js:1466          GET http://localhost:7007/api/catalog/entities?filter=kind=component net::ERR_CONNECTION_REFUSED
index.esm.js:1466          GET http://localhost:7007/api/catalog/entities?filter=kind=component net::ERR_CONNECTION_REFUSED

Missing backstage.extraEnvVars: APP_CONFIG_backend_baseUrl, APP_CONFIG_backend_origin and APP_CONFIG_app_baseUrl.

Delete

helm uninstall backstage \
  -n backstage

kubectl delete ns backstage \
  --grace-period=0 \
  --force