Kong extension classes
Summarize
Summary of Kong Extension Classes
The CMDB CI Class Models store app enhances the capabilities of ServiceNow by adding or updating classes specifically for Kong gateways. These enhancements allow better management of class descriptions, identification rules, and relationships associated with configuration items (CIs) relevant to API management.
Show less
Key Features
- Kong Gateway Class: Represents the Kong gateway application managing APIs.
- Kong Load Balancer Class: Serves as the default load balancer for directing traffic to backend services.
- Kong Target Class: Represents the backend services that fulfill API requests.
Class attributes are defined for each class, including:
- Kong Gateway: Admin URL and Database type.
- Kong Load Balancer: Load balancing algorithm and unique ID.
- Kong Target: Target URL for integration.
Key Outcomes
With these extensions, applications like Discovery and Service Mapping Patterns can effectively populate CIs and discover various technologies. The defined relationships among classes enhance the management of dependencies, enabling better integration and workflow configurations for alerts, service views, and incident management.
The CMDB CI Class Models store app adds or updates classes for Kong gateways.
The app adds class models that extend the CMDB class hierarchy, including class descriptions, identification rules, identifier entries, and dependent relationships (if applicable). You can use the added classes as any other CMDB class. Applications such as Discovery and Service Mapping Patterns can use these class extensions to populate CIs and discover various 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.
CMDB CI Class Models: Release 1.49.0 adds the following classes for Kong. For the list of CMDB classes in a base system, including ones that this store app might be extending, see CMDB tables descriptions.
| 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.