問題を報告するこのページは、まだ日本語ではご利用いただけません。翻訳中です。
Service Catalog Scorecards
この機能はbetaとしてリリースされており、本番環境では依存すべきではありません。
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 | Ensures that your services are well-documented with ownership information, 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 | Enforces that services are protected through external monitoring and vulnerability management tools. |
Enable scorecards on a service
- In Service Catalog, click Scorecards in the sidebar.
- Click New Scorecard.
- Name the scorecard, enable or disable scorecard criteria, and select which services you want the scorecard to apply to.
- Click Save.
Service documentation linting
By default, the service documentation template supports the following Spectral recipes:
| Category | Description | Link |
|---|---|---|
| OAS Recommended | Uses Stoplight’s style guide. Only considers criteria tagged with "recommended: true"
|
Stoplight Style Guide |
| OWASP Top 10 | Set of rules to enforce OWASP security guidelines | OWASP Top 10 API Security Guide |
| URL Versioning | Set of rules to enforce versioning | API Versioning Guide |
| Documentation | Set of rules to enforce documentation best practices | API Documentation Guidelines |
