Kong extension classes
Summarize
Summary of Kong extension classes
The CMDB CI Class Models app for ServiceNow extends the CMDB class hierarchy by adding or updating classes specifically for Kong gateways, an API management platform. These classes enable ServiceNow customers to model, discover, and manage Kong API gateways and their components within the CMDB. This supports applications like Discovery and Service Mapping Patterns to better populate Configuration Items (CIs) related to Kong technologies.
Show less
Key Features
- New and Updated Classes: The app introduces three key Kong-related classes:
- Kong Gateway [cmdbcikonggateway]: Represents the Kong gateway application hosting APIs.
- Kong Load Balancer [cmdbcikonglb]: Represents the default load balancer on the gateway pointing to backend services.
- Kong Target [cmdbcikongtarget]: Represents the load-balanced backend components fulfilling API requests.
- Class Attributes: Each class includes specific attributes to capture critical configuration details, such as:
- Kong Gateway: Admin URL and database type (e.g., Postgres or Cassandra).
- Kong Load Balancer: Load balancing algorithm and unique source system ID.
- Kong Target: Target integration URL.
- Defined Relationships: The app defines key dependent and containment relationships between Kong classes and related API classes, facilitating accurate dependency mapping within the CMDB.
- Related Non-CMDB Tables: Includes the Kong Workspace table that links workspaces to Kong API gateways, enriching the context of Kong deployments.
Key Outcomes
With these extensions, ServiceNow customers can:
- Accurately represent Kong gateway infrastructure and its components in the CMDB.
- Leverage Discovery and Service Mapping to automatically populate CIs for Kong technologies.
- Visualize and manage dependencies between Kong gateways, load balancers, and targets for improved operational insight.
- Bind alerts, configure dynamic CIs, and establish workflows based on Kong-related CIs to enhance incident and service management.
This empowers organizations to better manage API traffic and backend services through a comprehensive, integrated CMDB model aligned with Kong gateway deployments.
The CMDB CI Class Models app adds or updates classes for Kong gateways.
CMDB CI Class Models is a ServiceNow Store app that adds class models that extend the CMDB class hierarchy. The new or updated classes include 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 release notes for all CMDB CI class models.
Request apps on the Store
Visit the ServiceNow Store 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 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 front-end and back-end 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.