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.

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.

Table 1. Kong Gateway [cmdb_ci_kong_gateway]
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.
Table 2. Kong Load Balancer [cmdb_ci_lb_appl]
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.
Table 3. Kong Target [cmdb_ci_kong_target]
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.

Table 4. Kong relationships
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:

Table 5. Kong Workspace [kong_workspace]
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.


Dependency View of the Kong data model populated from a gateway.