Service Definition Schema v2.0

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Overview

Schema v2 is the earliest supported version of the Service Definition schema. It provides basic metadata structure for services and some experimental features.

Key features

  • Basic service metadata
  • Team associations
  • Contact information
  • External links

Schema structure

The full schema is available on GitHub.

Example YAML

schema-version: v2
dd-service: delivery-api
team: distribution-management
contacts:
  - type: slack
    contact: https://datadogincidents.slack.com/archives/C01EWN6319S
links:
  - name: Demo Dashboard
    type: dashboard
    url: https://app.datadoghq.com/dashboard/krp-bq6-362
repos:
  - name: Source
    provider: github
    url: https://github.com/DataDog/shopist/tree/prod/rails-storefront
docs:
  - name: Datadog Doc
    provider: link
    url: https://docs.datadoghq.com/
tags: []
integrations:
  pagerduty: https://datadog.pagerduty.com/service-directory/PXZNFXP

Further reading

Additional helpful documentation, links, and articles:

Create and manage service definitions with TerraformEXTERNAL SITE more more Learn about the Service Definition APIAPI more more Learn about the GitHub IntegrationDOCUMENTATION more more Import Backstage YAML files into DatadogBLOG more more