Skip to content

Commit

Permalink
Merge pull request #227 from DataDog/ara.pulido/service_catalog_defin…
Browse files Browse the repository at this point in the history
…itions

Add service catalog definitions for services
  • Loading branch information
arapulido committed Jul 15, 2022
2 parents 7d96faf + f98accd commit e471926
Show file tree
Hide file tree
Showing 5 changed files with 143 additions and 0 deletions.
17 changes: 17 additions & 0 deletions service-definitions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Service Catalog Definitions

You can use the YAML files on this folder as a base to add service definitions for your services, for them to appear in the new [Service Catalog page](https://docs.datadoghq.com/tracing/faq/service_catalog/).

To send the service definitions to your Datadog org, edit the YAML files to include the correct links (for example, links to the right notebooks in your org for runbooks) and use the API to POST those definitions:

```
curl -vvvv --request POST 'https://api.datadoghq.com/api/unstable/services/definition' \
--header 'DD-API-KEY: <your_api_key>' \
--header 'DD-APPLICATION-KEY: <your_app_key>' \
--header 'Content-Type: application/json' \
--data-binary '@<file.yaml>'
```

After sending the definitions, this is how your Service Catalog page should look like:

![Screenshot for the service catalog page](./screenshot.png)
26 changes: 26 additions & 0 deletions service-definitions/ads.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
schema-version: v2
dd-service: advertisements
team: ads-team
contacts:
- type: slack
contact: http://slack/e-commerce
- type: email
name: Ads Engineering Team
contact: ads@example.com
links:
- name: Runbook
type: runbook
url: http://runbook/advertisements
repos:
- name: Source
provider: github
url: https://github.com/DataDog/ecommerce-workshop/tree/main/ads-service
docs:
- name: Ads Team
provider: wiki
url: http://wiki/ads-team
tags:
- app:storedog
- cost-center:engineering

25 changes: 25 additions & 0 deletions service-definitions/discounts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
schema-version: v2
dd-service: discounts
team: discounts-team
contacts:
- type: slack
contact: http://slack/e-commerce
- type: email
name: Discounts Engineering Team
contact: discounts@example.com
links:
- name: Runbook
type: runbook
url: http://runbook/discounts
repos:
- name: Source
provider: github
url: https://github.com/DataDog/ecommerce-workshop/tree/main/discounts-service
docs:
- name: Discounts Team
provider: wiki
url: http://wiki/discounts-team
tags:
- app:storedog
- cost-center:engineering
75 changes: 75 additions & 0 deletions service-definitions/frontend.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
schema-version: v2
dd-service: store-frontend
team: frontend-team
contacts:
- type: slack
contact: http://slack/e-commerce
- type: email
name: Frontend Engineering Team
contact: frontend@example.com
links:
- name: Runbook
type: runbook
url: http://runbook/store-frontend
repos:
- name: Source
provider: github
url: https://github.com/DataDog/ecommerce-workshop/tree/main/store-frontend
docs:
- name: Frontend Team
provider: wiki
url: http://wiki/frontend-team
tags:
- app:storedog
- cost-center:engineering
---
schema-version: v2
dd-service: store-frontend-cache
team: frontend-team
contacts:
- type: slack
contact: http://slack/e-commerce
- type: email
name: Frontend Engineering Team
contact: frontend@example.com
links:
- name: Runbook
type: runbook
url: http://runbook/store-frontend
repos:
- name: Source
provider: github
url: https://github.com/DataDog/ecommerce-workshop/tree/main/store-frontend
docs:
- name: Frontend Team
provider: wiki
url: http://wiki/frontend-team
tags:
- app:storedog
- cost-center:engineering
---
schema-version: v2
dd-service: store-frontend-sqlite
team: frontend-team
contacts:
- type: slack
contact: http://slack/e-commerce
- type: email
name: Frontend Engineering Team
contact: frontend@example.com
links:
- name: Runbook
type: runbook
url: http://runbook/store-frontend
repos:
- name: Source
provider: github
url: https://github.com/DataDog/ecommerce-workshop/tree/main/store-frontend
docs:
- name: Frontend Team
provider: wiki
url: http://wiki/frontend-team
tags:
- app:storedog
- cost-center:engineering
Binary file added service-definitions/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e471926

Please sign in to comment.