Service Catalog Scorecards

This feature is released as beta and should not be depended upon in a production environment.

Scorecards in Service Catalog allow platform teams to monitor services for compliance with Kong-recommended and industry-defined best practices in Kong Konnect. By integrating Service Catalog with third-party applications, you can also use those in scorecard criteria.

When creating a scorecard, you define the validation criteria and specify which services should be evaluated. Scorecards help you detect issues, like whether there are services in the catalog that don’t have an on-call engineer assigned or if you have GitHub repositories with stale pull requests that aren’t getting reviewed or closed. From the scorecard view, you can view details on either a per-service or per-criteria basis.

Scorecard templates

Konnect provides several scorecard templates to help ensure your services adhere to industry best practices.

Scorecard template	Description
Service documentation	Hosts your documentation files, and API specs.
Service maturity	Measure performance reflecting industry-defined DORA metrics: deployment frequency, lead time for changes, change failure rate, and time to restore service.
Kong best practices	Best practices that we encourage users to follow when using other Konnect applications.
Security and compliance	Checks for that services are protected through external monitoring and vulnerability management tools.

Create a Scorecard

1. In Service Catalog, click Scorecards in the sidebar.
2. Click New Scorecard.
3. Name the scorecard, configure scorecard criteria, and select which services you want the scorecard to apply to.
4. Click Save.

Service documentation linting

By default, the service documentation template supports the following Spectral recipes:

Category	Description	More information
OAS Recommended	Uses Stoplight’s style guide. Only considers criteria tagged with "recommended: true"	Stoplight Style Guide
OWASP Top 10	Set of rules to check for OWASP security guidelines	OWASP Top 10 API Security Guide
URL Versioning	Set of rules to check for versioning	API Versioning Guide
Documentation	Set of rules to check for documentation best practices	API Documentation Guidelines