Validating Service Definition YAMLs
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、
お気軽にご連絡ください。
Overview
Software Catalog uses service definition schemas to store and display metadata about your services. These schemas follow the JSON Schema specification, so you can validate your metadata as you edit it. This validation is important, because a mistake in a service definition file could cause you to create a service
with invalid data or introduce an error into the metadata of an existing service.
To prevent this, there are two ways for you to validate your service definition files:
Create the service definition in-app
To validate your service definition file in-app:
- Navigate to the Software Catalog Setup & Config page.
- Click Create a New Entry.
- Select the Code tab.
- Paste the schema content.
Validate with an IDE extension
Built-in validation mechanisms prevent you from sending incorrect metadata into Software Catalog.
Validate with Datadog Event Management and Github Integration
To validate your service definitions ingested by Datadog’s Github integration, you can view events when services or updated or when there is an error. You can view validation errors in Event Management by filtering by source:software_catalog and status:error. Adjust the timeframe as needed.
Further reading
