Kong extension classes
Summarize
Summary of Kong extension classes
The CMDB CI Class Models store app, release version Yokohama, adds and updates classes specifically for managing Kong API gateway components within the ServiceNow CMDB. These classes extend the existing CMDB hierarchy and allow you to model Kong gateways, load balancers, and targets as configuration items (CIs), complete with class descriptions, identification rules, and relationships.
Show less
This integration supports ServiceNow applications such as Discovery and Service Mapping Patterns by enabling them to populate CIs and discover Kong-related technologies and software components.
Key Features
- New Kong-specific classes:
- Kong Gateway [cmdbcikonggateway] – Represents the Kong gateway application hosting APIs.
- Kong Load Balancer [cmdbcikonglb] – Represents the default load balancer on the Kong gateway directing traffic to backend services.
- Kong Target [cmdbcikongtarget] – Represents the backend targets fulfilling API requests behind the load balancer.
- Class attributes tailored for Kong: Each class has attributes relevant to its role, such as Admin URL and database type for Kong Gateway, load balancing algorithm and unique IDs for Kong Load Balancer, and target URLs for Kong Target.
- Defined relationships: The app establishes key parent-child and dependent relationships among API backend, Kong load balancer, Kong targets, and Kong gateway classes to accurately model dependencies and usage.
- Integration with non-CMDB tables: The Kong Gateway class links to the Kong Workspace table, which contains workspace names, IDs, and references to Kong API gateways.
Key Outcomes
- Enables precise modeling of Kong API gateway infrastructure within your CMDB, improving configuration visibility.
- Supports automated discovery and service mapping of Kong components, enhancing accuracy of service views and incident management.
- Allows binding of alerts and configuration of dynamic CIs based on Kong gateway dependencies, facilitating proactive monitoring and streamlined workflows.
- Provides a structured dependency view that helps you understand and manage first- and second-level relationships among Kong gateways, APIs, load balancers, and backend targets.
The CMDB CI Class Models store app adds or updates classes for Kong gateways.
The CMDB CI Class Models app adds class models that extend the CMDB class hierarchy, including class descriptions, identification rules, identifier entries, and, if applicable, dependent relationships. You can use the added classes just like any other CMDB class. Applications such as Discovery and Service Mapping Patterns can use the class extensions to populate CIs and discover technologies and software.
See the full release notes for all CMDB CI Class Models.
Request apps on the Store
Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Kong
Kong is an API management platform that enables enterprise companies to better manage client and host traffic.
Classes
This section lists the classes that the CMDB CI Class Models store app adds or updates. For the list of classes in the base system, including classes that this app might extend, see CMDB tables descriptions.
CMDB CI Class Models: Release 1.49.0 adds the following classes for Kong.
| Class | Extends | Description |
|---|---|---|
| Kong Gateway [cmdb_ci_kong_gateway] |
API Gateway [cmdb_ci_api_gateway] |
The Kong gateway application that hosts and manages individual APIs. Example: Kong Gateway instanceName. |
| Kong Load Balancer [cmdb_ci_kong_lb] |
Load Balancer Application [cmdb_ci_lb_appl] |
The default load balancer on the Kong gateway application that points to backend service instances when fulfilling API requests. Example: httpbin-upstream. |
| Kong Target [cmdb_ci_kong_target] |
API Component [cmdb_ci_api_component] |
The load-balanced backend of the gateway that fulfills API requests. Example: httpbin-target1. |
Class attributes
CMDB CI Class Models: Release 1.49.0 adds the following attributes to the respective classes.
| Attribute | Data type | Description |
|---|---|---|
| Admin URL | String (255) | URL for making admin API requests. |
| Database | String | Type of database used by the Kong gateway. Example: Postgres or Cassandra. |
| Attribute | Data type | Description |
|---|---|---|
| Algorithm | String | Type of algorithm used for load balancing. Example: round robin. |
| ID | String (255) | Unique identifier from the source system. |
| Attribute | Data type | Description |
|---|---|---|
| Target | String (255) | URL of target integration. |
Key Relationship Structures
There are a number of key relationships that must be defined for API and Kong classes.
| Parent class | Relationship | Child class | Relationship type |
|---|---|---|---|
| API Backend [cmdb_ci_api_backend] | Uses::Used By | Kong Load Balancer | Suggested |
| Kong Load Balancer [cmdb_ci_lb_appl] | Contains::Contained By | Kong Target | Dependent |
| Kong Gateway [cmdb_ci_kong_gateway] | Provides::Provided By | Kong Load Balancer | Dependent |
Related non-CMDB tables
The Kong Gateway class uses the Kong Workspace non-CMDB table as a related list:
| Attribute | Data type | Description |
|---|---|---|
| Name | String (100) | Name of the Kong workspace. |
| ID | String (255) | Unique identifier from the source system. |
| API Gateway | Reference | Reference to the Kong API gateway. |
Kong gateway example
Here is an example of a dependency view for the Kong gateway class that shows how a gateway would populate the dependent managed API-dependent class with related APIs and components. The Managed API class is considered a first-level relationship with respect to the gateway, while the frontend and backend components are considered second-level relationships. From here, you can then bind alerts to these CIs, configure dynamic CIs for service views and incidents, or establish any additional workflows that use CIs.