Target tables for storing API Service Graph Connector for Kong Gateway data
Summarize
Summary of Target Tables for Storing API Service Graph Connector for Kong Gateway Data
This document outlines the target tables used to store data from the API Service Graph Connector for Kong Gateway. After establishing the connection, the integration will periodically pull data from Kong Gateway applications, storing it in various tables extending from Configuration Item (CI) classes and other non-CMDB tables.
Show less
Key Features
- Kong Gateway Table: Stores attributes such as ID, name, admin URL, database, description, operational status, and version.
- Kong Workspace Table: Captures attributes including ID, name, and associated API Gateway.
- Kong Load Balancer Table: Records attributes like ID, name, algorithm, and operational status.
- Kong Target Table: Contains ID, name, target, and operational status.
- Managed API Table: Includes lifecycle stage, status, ID, name, base URL, type, model ID, and operational status.
- API Backend Table: Captures host, ID, path, URL, name, port, protocol, and operational status.
- API Frontend Table: Stores host, ID, method, path, URL, name, protocol, and operational status.
- API Consumer Table: Contains ID, API Gateway, custom ID, and username.
- API Policy Table: Records frontend, ID, active status, name, protocols, managed API, consumer, and API Gateway.
- Key Value Table: Stores configuration item, key, and value attributes.
Key Outcomes
By using these tables, ServiceNow customers can efficiently manage and analyze data related to their Kong Gateway integrations. This enables improved visibility and control over their API services, ensuring better operational management and support for their IT environments.
When you complete setting up the connection, you can configure the integration to periodically pull data from a Kong Gateway application. The data is saved in tables that extend from the Configuration item [cmdb_ci] classes and other non-CMDB tables.
Kong Gateway [cmdb_ci_kong_gateway]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| Admin URL | admin_url |
| Database | database |
| Description | short_description |
| Operational status | operational_status |
| Version | version |
| Parent class | Relationship type | Child class |
|---|---|---|
| Kong Gateway [cmdb_ci_kong_gateway] | Provides::Provided by | Kong Load Balancer [cmdb_ci_kong_lb] |
| Kong Gateway [cmdb_ci_kong_gateway] | Provides::Provided by | Managed API [cmdb_ci_managed_api] |
| Kong Gateway [cmdb_ci_kong_gateway] | Reference | Kong Workspace [kong_workspace] |
| Kong Gateway [cmdb_ci_kong_gateway] | Reference | API Policy [api_policy] |
| Kong Gateway [cmdb_ci_kong_gateway] | Reference | API Consumer [api_consumer] |
Kong Workspace [kong_workspace]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| API Gateway | api_gateway |
| Parent class | Relationship type | Child class |
|---|---|---|
| Kong Workspace [kong_workspace] | Reference | Kong Gateway [cmdb_ci_kong_gateway] |
Kong Load Balancer [cmdb_ci_kong_lb]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| Algorithm | algorithm |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Kong Load Balancer [cmdb_ci_kong_lb] | Contains::Contained by | Kong Target [cmdb_ci_kong_target] |
| Kong Load Balancer [cmdb_ci_kong_lb] | Reference | Key Value [cmdb_key_value] |
Kong Target [cmdb_ci_kong_target]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| Name | name |
| Target | target |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Kong Target [cmdb_ci_kong_target] | Reference | Key Value [cmdb_key_value] |
Managed API [cmdb_ci_managed_api]
| Attribute label | Attribute name |
|---|---|
| Life Cycle Stage | life_cycle_stage |
| Life Cycle Stage Status | life_cycle_stage_status |
| ID | id |
| Name | name |
| Base URL | base_url |
| Type | type |
| Model ID | model_id |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| Managed API [cmdb_ci_managed_api] | Uses::Used by | API Frontend [cmdb_ci_api_frontend] |
| Managed API [cmdb_ci_managed_api] | Uses::Used by | API Backend [cmdb_ci_api_backend] |
API Backend [cmdb_ci_api_backend]
| Attribute label | Attribute name |
|---|---|
| Host | host |
| ID | id |
| Path | path |
| URL | url |
| Name | name |
| Port | port |
| Protocol | protocol |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Backend [cmdb_ci_api_backend] | Uses::Used by | Kong Load Balancer [cmdb_ci_kong_lb] |
API Frontend [cmdb_ci_api_frontend]
| Attribute label | Attribute name |
|---|---|
| Host | host |
| ID | id |
| Method | method |
| Path | path |
| URL | url |
| Name | name |
| Protocol | protocol |
| Operational status | operational_status |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Frontend [cmdb_ci_api_frontend] | Use End Point To::Use End Point From | API Backend [cmdb_ci_api_backend] |
API Consumer [api_consumer]
| Attribute label | Attribute name |
|---|---|
| ID | id |
| API Gateway | api_gateway |
| Custom ID | custom_id |
| Username | username |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Consumer [api_consumer] | Reference | Kong Gateway [cmdb_ci_kong_gateway] |
API Policy [api_policy]
| Attribute label | Attribute name |
|---|---|
| Frontend | frontend |
| ID | id |
| Active | active |
| Name | name |
| Protocols | protocols |
| Managed API | managed_api |
| Consumer | consumer |
| API Gateway | api_gateway |
| Parent class | Relationship type | Child class |
|---|---|---|
| API Policy [api_policy] | Reference | Kong Gateway [cmdb_ci_kong_gateway] |
Key Value [cmdb_key_value]
| Attribute label | Attribute name |
|---|---|
| Configuration item | configuration_item |
| Key | key |
| Value | value |