Skip to content

Commit 32b95db

Browse files
manchickenmanchicken
authoredDec 21, 2023
Support v2.2 (#76)
* Updated dependencies. * Initial support commit for v2.2. - Added the fields - Fixed broken tests - The `uuid` dependency was added because `@actions/core` requires it now * Finished updating the field versions, tests pass now. * Adding a bit of debug code. * building, and adding debug. * Adding org rules file support for `type` and `language`. * Updating snapshots. * Adding some minor tests, and updating docs. - Also added `ci-pipeline-fingerprints` support in `action.yml` - Prepping to release.
·
v2.3.2v2
1 parent 657aac0 commit 32b95db

17 files changed

+974
-484
lines changed
 

‎.github/workflows/automated-testing.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
- name: Datadog Service Catalog Metadata Provider Manual Test
2929
uses: ./
3030
with:
31-
schema-version: v2.1
31+
schema-version: v2.2
3232
github-token: ${{ secrets.GITHUB_TOKEN }}
3333
datadog-hostname: api.us5.datadoghq.com
3434
datadog-key: ${{ secrets.DATADOG_API_KEY }}
@@ -38,6 +38,11 @@ jobs:
3838
description: This is a test of the Datadog Service Catalog Metadata Provider
3939
lifecycle: production
4040
tier: p3
41+
type: function
42+
languages: |
43+
- javascript
44+
- hopes
45+
- dreams
4146
team: Team Name Here
4247
email: team-name-here@fakeemaildomainthatdoesntexist.com
4348
slack-support-channel: 'https://fakeorg.slack.com/archives/A0000000000'

‎CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog],
66
and this project adheres to [Semantic Versioning].
77

8+
## [2.2.0] - unreleased
9+
10+
### Added
11+
12+
- Added support for schema version v2.2
13+
- Added the `uuid` dependency since `@actions/core` insists
14+
- Added some more edge case tests
15+
16+
### Changed
17+
18+
- Updated dependencies
19+
820
## [2.1.0] - 2023-10-20
921

1022
### Added

‎README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ At this time, this GitHub Action supports the following versions of the Service
2929

3030
- `v2`
3131
- `v2.1`
32+
- `v2.2`
3233

3334
## Wait, but why?
3435

@@ -69,35 +70,38 @@ Using a field which is not supported in the schema version you've selected will
6970

7071
| Field | Description | Required | Default | Schema Versions |
7172
| --- | --- | --- | --- | --- |
72-
| `service-name` | The name of the service. This must be unique across all services. | Yes | | `v2`, `v2.1` |
73-
| `team` | The team that owns the service. | Yes | | `v2`, `v2.1` |
74-
| `description` | A description of the service. | No | | `v2.1` |
75-
| `application` | The application that the service belongs to. | No | | `v2.1` |
76-
| `tier` | The importance tier of the service. This is an unconstrained text field where you can use your own tiering definitions. Examples would be `High`, `Critical`, or however you or your organization classify criticality tiers. | No | | `v2.1` |
77-
| `lifecycle` | This is the lifecycle of the service. This text field is unconstrained, and some examples are `production`, `development`, `staging`. | No | | `v2.1` |
78-
| `contacts` | The list of contacts for the service. Each of these contacts is an object. Keep in mind that `email` and `slack-support-channel` are already included as contacts. This list should be in addition to that. These values are supplied as objects, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. | No | `[]` | `v2`, `v2.1` |
79-
| `contacts[].name` | The name of the contact. | Yes | | `v2`, `v2.1` |
80-
| `contacts[].type` | The type of the contact. Acceptable values are: `email`, `slack`, and `microsoft-teams` | Yes | | `v2`, `v2.1` |
81-
| `contacts[].contact` | The actual contact information for the contact. For example, if the type is `email`, this would be the email address. | Yes | | `v2`, `v2.1` |
73+
| `service-name` | The name of the service. This must be unique across all services. | Yes | | `v2`, `v2.1`, `v2.2` |
74+
| `team` | The team that owns the service. | Yes | | `v2`, `v2.1`, `v2.2` |
75+
| `description` | A description of the service. | No | | `v2.1`, `v2.2` |
76+
| `application` | The application that the service belongs to. | No | | `v2.1`, `v2.2` |
77+
| `type` | The type of resource that this service constitutes. Values are constrained to one of "web", "db", "cache", "function", "browser", "mobile", or "custom". | No | | `v2.2` |
78+
| `languages` | This is a list of the languages used in this service. This is an array, so you may supply multiple values. | No | `[]` | `v2.2` |
79+
| `tier` | The importance tier of the service. This is an unconstrained text field where you can use your own tiering definitions. Examples would be `High`, `Critical`, or however you or your organization classify criticality tiers. | No | | `v2.1`, `v2.2` |
80+
| `lifecycle` | This is the lifecycle of the service. This text field is unconstrained, and some examples are `production`, `development`, `staging`. | No | | `v2.1`, `v2.2` |
81+
| `contacts` | The list of contacts for the service. Each of these contacts is an object. Keep in mind that `email` and `slack-support-channel` are already included as contacts. This list should be in addition to that. These values are supplied as objects, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. | No | `[]` | `v2`, `v2.1`, `v2.2` |
82+
| `contacts[].name` | The name of the contact. | Yes | | `v2`, `v2.1`, `v2.2` |
83+
| `contacts[].type` | The type of the contact. Acceptable values are: `email`, `slack`, and `microsoft-teams` | Yes | | `v2`, `v2.1`, `v2.2` |
84+
| `contacts[].contact` | The actual contact information for the contact. For example, if the type is `email`, this would be the email address. | Yes | | `v2`, `v2.1`, `v2.2` |
8285
| `repos` | The list of GitHub repositories that are part of the service. You must supply at least one repository. The repositories are supplied as objects, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. In `v2.1`, this field is moved under `links`. | Yes | `[]` | `v2` |
8386
| `repos[].name` | The name of the repository. | Yes | | `v2` |
8487
| `repos[].url` | The URL of the repository. | Yes | | `v2` |
8588
| `repos[].provider` | The provider of the repository. Acceptable values are: `Github`. | No | | `v2` |
8689
| `tags` | The list of tags that are associated with the service. This should be a list of key-value pairs separated by colons. | No | |
87-
| `links` | A list of links associated with the service. These links are objects with a variety of properties, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. | No | `[]` | `v2`, `v2.1` |
88-
| `links[].name` | The name of the link. | Yes | | `v2`, `v2.1` |
89-
| `links[].url` | The URL of the link. | Yes | | `v2`, `v2.1` |
90-
| `links[].type` | The type for the link. Acceptable values for the `v2` API are: `doc`, `wiki`, `runbook`, `url`, `repo`, `dashboard`, `oncall`, `code`, and `link`. Acceptable values for the `v2.1` API are: `doc`, `runbook`, `repo`, `dashboard`, and `other`. | Yes | | `v2`, `v2.1` |
90+
| `links` | A list of links associated with the service. These links are objects with a variety of properties, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. | No | `[]` | `v2`, `v2.1`, `v2.2` |
91+
| `links[].name` | The name of the link. | Yes | | `v2`, `v2.1`, `v2.2` |
92+
| `links[].url` | The URL of the link. | Yes | | `v2`, `v2.1`, `v2.2` |
93+
| `links[].type` | The type for the link. Acceptable values for the `v2` API are: `doc`, `wiki`, `runbook`, `url`, `repo`, `dashboard`, `oncall`, `code`, and `link`. Acceptable values for the `v2.1` API are: `doc`, `runbook`, `repo`, `dashboard`, and `other`. | Yes | | `v2`, `v2.1`, `v2.2` |
9194
| `docs` | A list of documentation links associated with the service. These links are objects with a variety of properties, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. In `v2.1`, this field moved under `links`. | No | `[]` | `v2` |
9295
| `docs[].name` | The name of the document. | Yes | | `v2` |
9396
| `docs[].url` | The URL of the document. | Yes | | `v2` |
9497
| `docs[].provider` | The provider for where the documentation lives. Acceptable values are: `Confluence`, `GoogleDocs`, `Github`, `Jira`, `OneNote`, `SharePoint`, and `Dropbox` | No | | `v2` |
95-
| `integrations` | Integrations associated with the service. These integrations are objects with a variety of properties, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. | No | `{}` | `v2`, `v2.1` |
96-
| `integrations.opsgenie` | The OpsGenie details for the service. | No | | `v2`, `v2.1` |
97-
| `integrations.opsgenie.service-url` | The service URL for the OpsGenie integration. A team URL will work, but if you want on-call metadata then make sure that this URL is to a service, not a team. | Yes | | `v2`, `v2.1` |
98-
| `integrations.opsgenie.region` | The region for the OpsGenie integration. Acceptable values are `US` and `EU`. | No | | `v2`, `v2.1` |
99-
| `integrations.pagerduty` | The PagerDuty URL for the service. **Important:** In `v2`, this field is just a URL. In `v2.1` this field is a dictionary with a `service-url` property. | No | | `v2`, `v2.1` |
100-
| `integrations.pagerduty.service-url` | The PagerDuty URL for the service. | Yes | | `v2.1` |
98+
| `integrations` | Integrations associated with the service. These integrations are objects with a variety of properties, but due to the limitations of GitHub Actions, please supply these object properties as a multi-line string. | No | `{}` | `v2`, `v2.1`, `v2.2` |
99+
| `integrations.opsgenie` | The OpsGenie details for the service. | No | | `v2`, `v2.1`, `v2.2` |
100+
| `integrations.opsgenie.service-url` | The service URL for the OpsGenie integration. A team URL will work, but if you want on-call metadata then make sure that this URL is to a service, not a team. | Yes | | `v2`, `v2.1`, `v2.2` |
101+
| `integrations.opsgenie.region` | The region for the OpsGenie integration. Acceptable values are `US` and `EU`. | No | | `v2`, `v2.1`, `v2.2` |
102+
| `integrations.pagerduty` | The PagerDuty URL for the service. **Important:** In `v2`, this field is just a URL. In `v2.1` this field is a dictionary with a `service-url` property. | No | | `v2`, `v2.1`, `v2.2` |
103+
| `integrations.pagerduty.service-url` | The PagerDuty URL for the service. | Yes | | `v2.1`, `v2.2` |
104+
| `ci-pipeline-fingerprints` | A set of CI pipeline fingerprints related to the service. | No | `[]` | `v2.2` |
101105

102106
### Convenience Fields
103107

‎__tests__/data/datadog-service-catalog-schema-v2.2.json

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"$id": "https://github.com/DataDog/schema/tree/main/service-catalog/v2.2/schema.json",
4+
"title": "Service Definition Schema v2.2",
5+
"description": "A service definition for providing additional service metadata and integrations v2.2",
6+
"type": "object",
7+
"properties": {
8+
"schema-version": {
9+
"description": "Schema version being used",
10+
"examples": ["v2.2"],
11+
"type": "string",
12+
"default": "v2.2",
13+
"enum": ["v2.2"]
14+
},
15+
"dd-service": {
16+
"description": "Unique identifier of the service. Must be unique across all services, and is used to match with a service in Datadog",
17+
"examples": ["my-service"],
18+
"type": "string"
19+
},
20+
"team": {
21+
"description": "Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists",
22+
"examples": ["my-team"],
23+
"type": "string"
24+
},
25+
"application": {
26+
"description": "Identifier for a group of related services serving a product feature, which the service is a part of",
27+
"examples": ["my-app"],
28+
"type": "string"
29+
},
30+
"description": {
31+
"description": "A short description of the service",
32+
"examples": ["My app description"],
33+
"type": "string"
34+
},
35+
"tier": {
36+
"description": "Importance of the service",
37+
"examples": ["1", "High"],
38+
"type": "string"
39+
},
40+
"lifecycle": {
41+
"description": "The current life cycle phase of the service.",
42+
"examples": ["sandbox", "staging", "production", "deprecated"],
43+
"type": "string"
44+
},
45+
"type": {
46+
"description": "The type of service",
47+
"examples": [
48+
"web",
49+
"db",
50+
"cache",
51+
"function",
52+
"browser",
53+
"mobile",
54+
"custom"
55+
],
56+
"type": "string",
57+
"enum": ["web", "db", "cache", "function", "browser", "mobile", "custom"]
58+
},
59+
"languages": {
60+
"description": "The service's programming language. See examples for a list of recognizable languages",
61+
"examples": [
62+
["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"]
63+
],
64+
"type": "array",
65+
"items": {
66+
"type": "string"
67+
}
68+
},
69+
"contacts": {
70+
"description": "A list of contacts related to the services. ",
71+
"type": "array",
72+
"items": {
73+
"$ref": "#/$defs/contact"
74+
}
75+
},
76+
"links": {
77+
"description": "A list of links related to the services. ",
78+
"type": "array",
79+
"items": {
80+
"$ref": "#/$defs/link"
81+
}
82+
},
83+
"tags": {
84+
"description": "A set of custom tags",
85+
"examples": [["my:tag"]],
86+
"type": "array",
87+
"items": {
88+
"type": "string"
89+
}
90+
},
91+
"integrations": {
92+
"description": "Third party integrations that Datadog supports",
93+
"type": "object",
94+
"properties": {
95+
"pagerduty": {
96+
"description": "Pagerduty integration for the service",
97+
"type": "object",
98+
"properties": {
99+
"service-url": {
100+
"description": "Pagerduty Service URL",
101+
"examples": [
102+
"https://my-org.pagerduty.com/service-directory/PMyService"
103+
],
104+
"type": "string",
105+
"pattern": "^(https?://)?[a-zA-Z\\d_\\-.]+\\.pagerduty\\.com/service-directory/(P[a-zA-Z\\d_\\-]+)/?$"
106+
}
107+
},
108+
"required": ["service-url"],
109+
"additionalProperties": false
110+
},
111+
"opsgenie": {
112+
"description": "Opsgenie integration for the service",
113+
"type": "object",
114+
"properties": {
115+
"service-url": {
116+
"description": "Opsgenie Service URL",
117+
"examples": [
118+
"https://www.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"
119+
],
120+
"type": "string",
121+
"pattern": "^(https?://)?[a-zA-Z\\d_\\-.]+\\.opsgenie\\.com/service/([a-zA-Z\\d_\\-]+)/?$"
122+
},
123+
"region": {
124+
"description": "Opsgenie Instance Region",
125+
"type": "string",
126+
"examples": ["US", "EU"],
127+
"enum": ["US", "EU"]
128+
}
129+
},
130+
"required": ["service-url"],
131+
"additionalProperties": false
132+
}
133+
},
134+
"additionalProperties": false
135+
},
136+
"extensions": {
137+
"description": "Custom extensions",
138+
"type": "object",
139+
"additionalProperties": true
140+
},
141+
"ci-pipeline-fingerprints": {
142+
"description": "A set of CI pipeline fingerprints related to the service",
143+
"examples": [["j88xdEy0J5lc", "eZ7LMljCk8vo"]],
144+
"type": "array",
145+
"items": {
146+
"type": "string"
147+
}
148+
}
149+
},
150+
"additionalProperties": false,
151+
"required": ["schema-version", "dd-service"],
152+
"$defs": {
153+
"link": {
154+
"additionalProperties": false,
155+
"type": "object",
156+
"properties": {
157+
"name": {
158+
"description": "Link name",
159+
"examples": ["Runbook", "Dashboard"],
160+
"type": "string"
161+
},
162+
"type": {
163+
"description": "Link type. See examples for a list of recognizable types",
164+
"examples": ["runbook", "doc", "repo", "dashboard", "other"],
165+
"type": "string",
166+
"default": "other"
167+
},
168+
"url": {
169+
"description": "Link url",
170+
"examples": ["https://my-runbook"],
171+
"type": "string",
172+
"format": "uri"
173+
},
174+
"provider": {
175+
"description": "Link provider. See examples for a list of recognizable providers",
176+
"examples": ["Github", "Confluence"],
177+
"type": "string"
178+
}
179+
},
180+
"required": ["name", "type", "url"]
181+
},
182+
"contact": {
183+
"additionalProperties": false,
184+
"type": "object",
185+
"properties": {
186+
"name": {
187+
"description": "Contact name",
188+
"examples": ["Oncall Slack", "Team Email"],
189+
"type": "string",
190+
"minLength": 2
191+
},
192+
"type": {
193+
"description": "Contact type. See examples for a list of recognizable types",
194+
"examples": ["email", "slack", "microsoft-teams"],
195+
"type": "string"
196+
},
197+
"contact": {
198+
"description": "Contact value",
199+
"examples": [
200+
"contact@datadoghq.com",
201+
"https://my-org.slack.com/archives/my-channel"
202+
],
203+
"type": "string"
204+
}
205+
},
206+
"if": {
207+
"properties": { "type": { "const": "email" } }
208+
},
209+
"then": {
210+
"properties": { "contact": { "format": "email" } }
211+
},
212+
"else": {
213+
"properties": { "contact": { "format": "uri" } }
214+
},
215+
"required": ["type", "contact"]
216+
}
217+
}
218+
}

0 commit comments

Comments
 (0)
Please sign in to comment.