Target tables for storing API Service Graph Connector for Kong Gateway data

  • Release version: Washingtondc
  • Updated March 21, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Target Tables for Storing API Service Graph Connector for Kong Gateway Data

    This document outlines the target tables for storing data collected from the Kong Gateway application after establishing the API Service Graph Connector. The data is organized in tables extending from Configuration Item (CMDB) classes and other non-CMDB classes, enabling better management and visibility of API resources.

    Show full answer Show less

    Key Features

    • Kong Gateway Table: Stores essential attributes such as ID, Name, Admin URL, Database, Description, and Version.
    • Kong Workspace Table: Captures attributes including ID, Name, and API Gateway.
    • API Policy Table: Contains Frontend, ID, Active status, Name, Protocols, Managed API, and Consumer information.
    • API Consumer Table: Records attributes like ID, API Gateway, Custom ID, and Username.
    • Kong Load Balancer Table: Holds ID, Name, and Algorithm data.
    • Kong Target Table: Includes ID, Name, and Target attributes.
    • Managed API Table: Gathers information on Life Cycle Stage, Life Cycle Stage Status, ID, Name, Base URL, Type, and Model ID.
    • API Frontend and Backend Tables: Store details about hosts, methods, paths, URLs, names, ports, and protocols.
    • Key Value Table: Contains configuration items, keys, and values.

    Key Outcomes

    By integrating with Kong Gateway, customers can effectively manage their API services through a structured database setup. This enables streamlined operations, better tracking of API policies, consumers, and load balancers, and enhances overall visibility into the API architecture, leading to improved service management and performance analytics.

    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 classes.

    Kong Gateway [cmdb_ci_kong_gateway]

    The following attributes in the Kong Gateway [cmdb_ci_kong_gateway] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Admin URL admin_url
    Database database
    Description short_description
    Version version
    Table 1. Relationships created for Kong Gateway
    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]

    The following attributes in the Kong Workspace [kong_workspace] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    API Gateway api_gateway
    Table 2. Relationship created for Kong Workspace
    Parent class Relationship type Child class
    Kong Workspace [kong_workspace] Reference Kong Gateway [cmdb_ci_kong_gateway]

    API Policy [api_policy]

    The following attributes in the API Policy [api_policy] table are populated by collected data:
    Attribute label Attribute name
    Frontend frontend
    ID id
    Active active
    Name name
    Protocols protocols
    Managed API managed_api
    Consumer consumer
    API Gateway api_gateway
    Table 3. Relationship created for API Policy
    Parent class Relationship type Child class
    API Policy [api_policy] Reference Kong Gateway [cmdb_ci_kong_gateway]

    API Consumer [api_consumer]

    The following attributes in the API Consumer [api_consumer] table are populated by collected data:
    Attribute label Attribute name
    ID id
    API Gateway api_gateway
    Custom ID custom_id
    Username username
    Table 4. Relationship created for API Consumer
    Parent class Relationship type Child class
    API Consumer [api_consumer] Reference Kong Gateway [cmdb_ci_kong_gateway]

    Kong Load Balancer [cmdb_ci_kong_lb]

    The following attributes in the Kong Load Balancer [cmdb_ci_kong_lb] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Algorithm algorithm
    Table 5. Relationships created for Kong Load Balancer
    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]

    The following attributes in the Kong Target [cmdb_ci_kong_target] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Target target
    Table 6. Relationship created for Kong Target
    Parent class Relationship type Child class
    Kong Target [cmdb_ci_kong_target] Reference Key Value [cmdb_key_value]

    Managed API [cmdb_ci_managed_api]

    The following attributes in the Managed API [cmdb_ci_managed_api] table are populated by collected data:
    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
    Table 7. Relationships created for Managed API
    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 Frontend [cmdb_ci_api_frontend]

    The following attributes in the API Frontend [cmdb_ci_api_frontend] table are populated by collected data:
    Attribute label Attribute name
    Host host
    ID id
    Method method
    Path path
    URL url
    Name name
    Protocol protocol
    Table 8. Relationship created for API Frontend
    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 Backend [cmdb_ci_api_backend]

    The following attributes in the API Backend [cmdb_ci_api_backend] table are populated by collected data:
    Attribute label Attribute name
    Host host
    ID id
    Path path
    URL url
    Name name
    Port port
    Protocol protocol
    Table 9. Relationship created for API Backend
    Parent class Relationship type Child class
    API Backend [cmdb_ci_api_backend] Uses::Used by Kong Load Balancer [cmdb_ci_kong_lb]

    Key Value [cmdb_key_value]

    The following attributes in the Key Value [cmdb_key_value] table are populated by collected data:
    Attribute label Attribute name
    Configuration item configuration_item
    Key key
    Value value