Import Entities

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Overview

If you already have data or services registered in Backstage or ServiceNow, you can import these services into Datadog directly.

Import from Backstage

Service panel highlighting backstage metadata, links and definition

To import Backstage definitions:

  • API or Terraform: Replace the YAMLs in your requests with Backstage YAMLs.
  • GitHub integration: Save your Backstage YAMLs in a repository with Datadog read permissions. Datadog scans for files named catalog-info.yaml in your repositories.

During import, Datadog maps Backstage data to Datadog data:

Backstage FieldDatadog Mapping
kind:component and kind:systemDatadog recognizes these; kind:component is recognized as a service
metadata.namedd-service
metadata.namespaceCustom tag with format namespace:${metadata.namespace}
spec.lifecyclelifecycle
spec.ownerteam
metadata.linkslinks
Annotation github.com/project-slugLink with type=repo and url=https://www.github.com/${github.com/project-slug}
Annotations pagerduty.com/service-id and pagerduty.com/accountCombined and mapped to integration.pagerduty
metadata.descriptiondescription
spec.systemapplication
spec.dependsOndependsOn
Other spec valuesMapped to custom tags
The Software Catalog processes the entire YAML file as a whole. If any section of the YAML file does not have kind:component or kind:system, the entire catalog-info.yaml file is rejected. Schema version v3.0 is required to use kind:system and the dependsOn field.

Example YAML for catalog-info.yaml

catalog-info.yaml

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: artist-web
  description: The place to be, for great artists
spec:
  type: service
  lifecycle: production
  owner: artist-relations-team
  system: artist-engagement-portal
  dependsOn:
    - service:email-service

Import from ServiceNow

To populate your Datadog Software Catalog with services from your ServiceNow Configuration Management Database (CMDB), use the Service Ingestion feature in the Datadog-ServiceNow integration.

Screenshot of the Service Configuration panel showing metadata populated from ServiceNow

Further reading

Documentation, liens et articles supplémentaires utiles:

Import Backstage YAML files into DatadogBLOG more more Manage your infrastructure with ServiceNow CMDB and DatadogBLOG more more