Skip to content
This repository was archived by the owner on Apr 28, 2025. It is now read-only.

Commit f98accd

Browse files
committed
Add service catalog definitions for services
Signed-off-by: Ara Pulido <ara.pulido@datadoghq.com>
1 parent 7d96faf commit f98accd

File tree

5 files changed

+143
-0
lines changed

5 files changed

+143
-0
lines changed

service-definitions/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Service Catalog Definitions
2+
3+
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/).
4+
5+
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:
6+
7+
```
8+
curl -vvvv --request POST 'https://api.datadoghq.com/api/unstable/services/definition' \
9+
--header 'DD-API-KEY: <your_api_key>' \
10+
--header 'DD-APPLICATION-KEY: <your_app_key>' \
11+
--header 'Content-Type: application/json' \
12+
--data-binary '@<file.yaml>'
13+
```
14+
15+
After sending the definitions, this is how your Service Catalog page should look like:
16+
17+
![Screenshot for the service catalog page](./screenshot.png)

service-definitions/ads.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
schema-version: v2
3+
dd-service: advertisements
4+
team: ads-team
5+
contacts:
6+
- type: slack
7+
contact: http://slack/e-commerce
8+
- type: email
9+
name: Ads Engineering Team
10+
contact: ads@example.com
11+
links:
12+
- name: Runbook
13+
type: runbook
14+
url: http://runbook/advertisements
15+
repos:
16+
- name: Source
17+
provider: github
18+
url: https://github.com/DataDog/ecommerce-workshop/tree/main/ads-service
19+
docs:
20+
- name: Ads Team
21+
provider: wiki
22+
url: http://wiki/ads-team
23+
tags:
24+
- app:storedog
25+
- cost-center:engineering
26+

service-definitions/discounts.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
schema-version: v2
3+
dd-service: discounts
4+
team: discounts-team
5+
contacts:
6+
- type: slack
7+
contact: http://slack/e-commerce
8+
- type: email
9+
name: Discounts Engineering Team
10+
contact: discounts@example.com
11+
links:
12+
- name: Runbook
13+
type: runbook
14+
url: http://runbook/discounts
15+
repos:
16+
- name: Source
17+
provider: github
18+
url: https://github.com/DataDog/ecommerce-workshop/tree/main/discounts-service
19+
docs:
20+
- name: Discounts Team
21+
provider: wiki
22+
url: http://wiki/discounts-team
23+
tags:
24+
- app:storedog
25+
- cost-center:engineering

service-definitions/frontend.yaml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
schema-version: v2
3+
dd-service: store-frontend
4+
team: frontend-team
5+
contacts:
6+
- type: slack
7+
contact: http://slack/e-commerce
8+
- type: email
9+
name: Frontend Engineering Team
10+
contact: frontend@example.com
11+
links:
12+
- name: Runbook
13+
type: runbook
14+
url: http://runbook/store-frontend
15+
repos:
16+
- name: Source
17+
provider: github
18+
url: https://github.com/DataDog/ecommerce-workshop/tree/main/store-frontend
19+
docs:
20+
- name: Frontend Team
21+
provider: wiki
22+
url: http://wiki/frontend-team
23+
tags:
24+
- app:storedog
25+
- cost-center:engineering
26+
---
27+
schema-version: v2
28+
dd-service: store-frontend-cache
29+
team: frontend-team
30+
contacts:
31+
- type: slack
32+
contact: http://slack/e-commerce
33+
- type: email
34+
name: Frontend Engineering Team
35+
contact: frontend@example.com
36+
links:
37+
- name: Runbook
38+
type: runbook
39+
url: http://runbook/store-frontend
40+
repos:
41+
- name: Source
42+
provider: github
43+
url: https://github.com/DataDog/ecommerce-workshop/tree/main/store-frontend
44+
docs:
45+
- name: Frontend Team
46+
provider: wiki
47+
url: http://wiki/frontend-team
48+
tags:
49+
- app:storedog
50+
- cost-center:engineering
51+
---
52+
schema-version: v2
53+
dd-service: store-frontend-sqlite
54+
team: frontend-team
55+
contacts:
56+
- type: slack
57+
contact: http://slack/e-commerce
58+
- type: email
59+
name: Frontend Engineering Team
60+
contact: frontend@example.com
61+
links:
62+
- name: Runbook
63+
type: runbook
64+
url: http://runbook/store-frontend
65+
repos:
66+
- name: Source
67+
provider: github
68+
url: https://github.com/DataDog/ecommerce-workshop/tree/main/store-frontend
69+
docs:
70+
- name: Frontend Team
71+
provider: wiki
72+
url: http://wiki/frontend-team
73+
tags:
74+
- app:storedog
75+
- cost-center:engineering

service-definitions/screenshot.png

276 KB
Loading

0 commit comments

Comments
 (0)