Overview

Schema v2.1 introduces support for additional UI elements such as service groupings and new fields like application, tier, and lifecycle.

Key features

  • New UI elements such as service groupings and fields for application, tier, and lifecycle
  • Application and Teams can be used as grouping variables in Service Catalog
  • Lifecycle field indicates development stage to differentiate between production, experimental, or deprecated services
  • Tier field indicates service criticality for prioritizing during incident triage

Schema structure

The full schema is available on GitHub.

Example YAML

schema-version: v2.1
dd-service: delivery-state-machine
team: serverless
application: delivery-state-machine
tier: tier0
lifecycle: production
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
  - name: Source
    provider: github
    url: https://github.com/DataDog/shopist-serverless/tree/main/delivery-state-machine
    type: repo
  - name: Deployment
    provider: github
    url: https://github.com/DataDog/shopist-serverless/blob/main/delivery-state-machine/serverless.yml
    type: repo
  - name: Datadog Doc
    provider: link
    url: https://docs.datadoghq.com/
    type: doc
tags:
  - "app:serverless-delivery"
  - "tier:3"
  - "business-unit:operations"

Further reading

PREVIEWING: antoine.dussault/service-representation-ga-docs-us1