Import Entries from Backstage
If you already have data or services registered in Backstage, you can import these services into Datadog directly.
If you use API or Terraform, replace the YAMLs in your requests.
If you use GitHub integration, directly save your Backstage YAMLs to a repo with Datadog read permission. Datadog scans for files named catalog-info.yaml
located at the root folder of a repo.
Upon import, the following occurs:
- Datadog only recognizes
kind:component
in Backstage YAMLs as services metadata.name
gets mapped to dd-service
metadata.namespace
gets mapped to a custom tag with the format namespace:${metadata.namespace}
spec.lifecycle
gets mapped to lifecycle
spec.owner
gets mapped to team
metadata.links
gets mapped to links
- The annotation
github.com/project-slug
maps to a link with type=repo
and url=https://www.github.com/${github.com/project-slug}
metadata.description
gets mapped to description
spec.system
gets mapped to application
- Other
spec
values get mapped to custom tags
Note: The Service Catalog processes the entire YAML file as a whole. If any section of the YAML file does not have kind:Component
, the entire catalog-info.yaml file
is rejected.
Further reading
Additional helpful documentation, links, and articles: