Edit this page
Report an issueThe Konnect Service Catalog
Track every service across your architecture
This feature is released as beta and should not be depended upon in a production environment.
Kong Konnect’s Service Catalog offers a comprehensive catalog of all services running in your organization. By integrating with both Konnect-internal applications, like Gateway Manager and Mesh Manager, as well as external applications like GitHub and PagerDuty, Service Catalog provides you with a 360 overview into each of your organization’s services. It presents you with information that include who the service’s owner is, its upstream and downstream dependencies, its code repositories, its CI/CD pipelines, and whether it is fronted by an API gateway or is part of a service mesh.
Figure 1: This diagram shows how you can use both external integrations, like GitHub and PagerDuty, as well as internal integrations like Gateway Manager to pull resources into Service Catalog. You can then map those resources (like GitHub repositories, PagerDuty services, and Gateway services) to Service Catalog services.
Service Catalog use cases
| You want to… | Then use… |
|---|---|
| Gain visibility into all your services, including unrecognized or undiscovered APIs in your organization. | Service Catalog integrations |
| Keep track of your organization’s resource ownership by mapping teams to Service Catalog services. | Add the Service Catalog service’s owner when you create a new Service Catalog service in Konnect |
| Consolidate key Service Catalog service health metrics, documentation, and API specs into a single list, allowing you to interact with other tools from one place. | Service Catalog dashboard |
| Govern how services are created and maintained across your company to adhere to security, compliance, and engineering best practices. | Scorecards |
Service Catalog terminology
| Term | Definition |
|---|---|
| Service Catalog | A comprehensive catalog of all resources and Service Catalog services running in your organization. |
| Service Catalog service | A unit of software that is typically owned by a single team, exposes one or more APIs, and may be dependent on other Service Catalog services (as either upstream or downstream). A Service Catalog service can be thought of as a collection of one or more resources. |
| Integration | These are applications, either Konnect-internal or external, that act as sources from which you can ingest resources. For example, GitHub. |
| Events | An event is a captured unit of information logged by the Service Catalog. It includes a wide range of activities such as user-driven actions, configuration changes, and alerts. |
| Resource | An umbrella term that denotes entities ingested by Service Catalog from enabled integrations. A resource can range from an infrastructural component (like Gateway services, mesh services, databases, and caches) to an external application or tool (like code repositories, CI/CD infrastructure, and on-call systems) to a piece of documentation (like API specs). Resources can be mapped to one or more Service Catalog services. |
| Scorecards | Scorecards are a compliance monitoring tool in Service Catalog that assess services and integrations against predefined best practices, identifying gaps and providing actionable insights to improve security, reliability, and adherence to standards. |
FAQs
How do Service Catalog services map to API products? What is the relationship there?
Service Catalog services do not directly map to API products. Rather, a Gateway service can be linked to a Service Catalog service and you can then map the Gateway service to an API product version in Service Catalog.
How do I view the health and status of my services in the Service Catalog?
Navigate to Services in the Service Catalog and click on the Service Catalog service to view the health and status.
How can I identify which resources are available for mapping to my Service Catalog services?
Navigate to the Resources page in the Service Catalog to view a list of all available resources. These are ingested by Service Catalog from the integrations that have been installed and authorized and are found on the Integrations page.
What should I do if I notice discrepancies in the data shown in the Service Catalog?
Check the Service Catalog integration settings and data sources for any issues. Ensure that all connected tools are properly configured and that data synchronization is functioning correctly.
Can I control who has access to specific Service Catalog service or data?
Yes, you can configure access controls and manage permissions to Service Catalog by configuring teams and roles.
