Configure API Service Graph Connector for Kong Gateway using the guided setup
Set up scheduled import jobs to pull in Kong Gateway data into your Configuration Management Database (CMDB).
Antes de Iniciar
- The Integration Commons for CMDB store app, which is automatically installed. See Integration Commons for CMDB.
- The CMDB CI class models store app, which is automatically installed. See CMDB CI Class Models app.
- The ITOM Discovery License plugin (com.snc.itom.discovery.license). You must activate this plugin.
- ITOM Licensing plugin (com.snc.itom.license). See Request Discovery.
For basic authentication, obtain the user name and password required for authenticating requests to the Kong Gateway Admin API.
For token-based authentication, obtain the API key for connecting to the Kong Gateway service.
Role required: admin
Procedimento
-
Verify that the application scope is set to the API Service Graph Connector for Kong Gateway application by using the application picker.
For more information, see Application picker.
- Navigate to All > Service Graph Connectors > Kong Gateway > Setup.
-
Configure the authentication type, credentials, and HTTP connection details.
- In the Configure connection and credentials section of the Kong Gateway Integration with CMDB page, select Get Started.
-
Configure the authentication type.
- For the Set authentication type task, select Configure.
- Set the Auth Type property to one of the following values:
Basic: Basic authentication that uses a user name and password.Token: Token-based authentication that uses a user name and password to retrieve a token.
- Select Update.
- Set the Set authentication type task to complete by selecting Mark as Complete.
-
Configure the authentication credentials used for sending requests to the Kong Gateway Admin API.
- For the Configure the connection task, select Configure.
- Based on the authentication type, select the connection type.
- For basic authentication, on the Connections page, search for and select Kong Basic Authentication and then select View Details.
- For token-based authentication, on the Connections page, search for and select Kong RBAC Authentication and then select View Details.
- Edit the basic authentication details available by default.Nota:Skip this step if using token-based authentication.
- In the Connection Information section of the Edit Connection window, fill in the fields.
Tabela 1. Connection Information Field Description Connection Name Name to identify the Kong Gateway connection record. Kong Basic Authenticationis the default connection name. You can add multiple Kong Gateway instances. However, try not to modify the default connection name.Host Name Target domain name or IP address used to access the Kong Gateway instance. Protocol Protocol used for the connection ensuring secured communication between the client and the Kong server. This field is automatically set to https. Valid values are:- http
- https
Override default port Port used by the Kong Admin API. - In the Credential Information section of the Edit Connection window, fill in the fields.
Tabela 2. Credential Information Field Description User name User name required for authenticating requests to the Kong Gateway Admin API as noted in the Before you begin section. Password Password associated with the user name required for authenticating requests as noted in the Before you begin section. - Select Edit Connection.
- In the Connection Information section of the Edit Connection window, fill in the fields.
- Edit the token-based authentication details available by default.Nota:Skip this step if using basic authentication.
- In the Connection Information section of the Edit Connection window, fill in the fields.
Tabela 3. Connection Information Field Description Connection Name Name to identify the Kong Gateway connection record. Kong RBAC Authenticationis the default connection name. You can add multiple Kong Gateway instances. However, try not to modify the default connection name.Host Name Target domain name or IP address used to access the Kong Gateway instance. Protocol Protocol used for the connection ensuring secured communication between the client and the Kong server. This field is automatically set to https. Valid values are:- http
- https
Override default port Port used by the Kong Admin API. - In the Credential Information section of the Edit Connection window, in the API Key field, enter the authentication secret to connect to the Kong Gateway service as noted in the Before you begin section.
- Select Edit Connection.
- In the Connection Information section of the Edit Connection window, fill in the fields.
- Set the Configure the connection task to complete by selecting Mark as Complete.
-
Configure the properties to control the scope of data retrieval.
- For the Set configuration properties task, select Configure.
- In the Service Graph Connection Properties related list, configure the properties.
Tabela 4. Properties Property Description Exclude Workspaces Name of the workspace to exclude. Entities in this workspace won't be populated in the Kong Gateway service. For multiple workspaces, separate them with commas. For example:
workspace1,workspace2.If you leave this field empty, the data sources within the connector import data from all the workspaces.
Import Tags Tags to ingest from the Kong Gateway service. For multiple tags, separate them with commas.
When specified, enter the key-value pair separator for tags in the Tags Value Separator property. If not specified, tags won't be fetched.
Tags Value Separator Separator for key and value in tags. For example, if the tag value separator is set to
=, the tagenv=prodis saved withenvas the key andprodas the value.If left empty, no tags are ingested.
Nota:The Auth Type, Workspaces, and Load Balancers properties are populated automatically. - Set the Set configuration properties task to complete by selecting Mark as Complete.
-
Test the connection.
- For the Test connection task, select Configure.
- Test the connection by selecting the Test Connection related link.
Testing the connection might take a few moments. The page is refreshed to show the test results.
- When the Status field is set to Success, select Update.
If any of the tests have errors, follow the suggestions for remediation.
- Set the Test connection task to complete by selecting Mark as Complete.
- Opcional:
Add multiple instances.
Nota:If you don't need to add multiple instances, you can skip this step.
- In the Add multiple Instances section of the Kong Gateway Integration with CMDB page, select Get Started.
-
Enable creating data sources for the new Kong Gateway connection.
- Ensure that you have edit permissions for the Datasource [sys_data_source] table.
- For the Update data source access task, select Configure.
- To edit the record, select the Global application scope from the application picker.
- In the Application Access related list of the Update Data Source Access form, select the Can create, Can update, and Can delete check boxes.
- Select Update.
- Select the API Service Graph Connector for Kong Gateway application by using the application picker.
- Set the Update data source access task to complete by selecting Mark as Complete.
-
To enable creating data sources for the new connection, clear the cache of the tables Data Source [sys_data_source] and Tables [sys_db_object].
To clear the cache:
- For the Clear cache task, select Configure.
- In the Run script text box of the background script page, enter the following script:
GlideTableManager.invalidateTable("sys_data_source"); GlideCacheManager.flushTable("sys_data_source"); GlideTableManager.invalidateTable("sys_db_object"); GlideCacheManager.flushTable("sys_db_object"); - Select Run Script to run the background script in the global scope.
The script may take several minutes to execute.
- After the script is executed, select Close.
- Select the API Service Graph Connector for Kong Gateway application by using the application picker.
- Set the Clear cache task to complete by selecting Mark as Complete.
-
Add a new connection.
- For the Add another connection task, select Configure.
- Based on the authentication type, select the connection type.
- For basic authentication, on the Connections page, search for and select Kong Basic Authentication and then select Add Connection.
- For token-based authentication, on the Connections page, search for and select Kong RBAC Authentication and then select Add Connection.
- Fill in the basic authentication details.Nota:Skip this step if using token-based authentication.
- In the Connection Information section of the Create Connection window, fill in the fields.
Tabela 5. Connection Information Field Description Connection Name Name to identify the Kong Gateway connection record. Host Name Target domain name or IP address used to access the Kong Gateway instance. Protocol Protocol used for the connection ensuring secured communication between the client and the Kong server. This field is automatically set to https. Valid values are:- http
- https
Override default port Port used by the Kong Admin API. - In the Credential Information section of the Create Connection window, fill in the fields.
Tabela 6. Credential Information Field Description User name User name required for authenticating requests to the Kong Gateway Admin API as noted in the Before you begin section. Password Password associated with the user name required for authenticating requests as noted in the Before you begin section. - Select Create Connection.
- In the Connection Information section of the Create Connection window, fill in the fields.
- Fill in the token-based authentication details.Nota:Skip this step if using basic authentication.
- In the Connection Information section of the Create Connection window, fill in the fields.
Tabela 7. Connection Information Field Description Connection Name Name to identify the Kong Gateway connection record. Host Name Target domain name or IP address used to access the Kong Gateway instance. Protocol Protocol used for the connection ensuring secured communication between the client and the Kong server. This field is automatically set to https. Valid values are:- http
- https
Override default port Port used by the Kong Admin API. - In the Credential Information section of the Create Connection window, in the API Key field, enter the authentication secret to connect to the Kong Gateway service as noted in the Before you begin section.
- Select Create Connection.
- In the Connection Information section of the Create Connection window, fill in the fields.
- Set the Add another connection task to complete by selecting Mark as Complete.
-
Configure the properties for the new connection.
- For the Set configuration properties for new connection task, select Configure.
- From the Name column, select the connection record of the new connection.
- In the Service Graph Connection Properties related list, configure the properties.
Tabela 8. Properties Property Description Exclude Workspaces Name of the workspace to exclude. Entities in this workspace won't be populated in the Kong Gateway service. For multiple workspaces, separate them with commas. For example:
workspace1,workspace2. If you leave this field empty, the data sources within the connector import data from all the workspaces.Import Tags Tags to ingest from the Kong Gateway service. For multiple tags, separate them with commas.
When specified, enter the key-value pair separator for tags in the Tags Value Separator property. If not specified, tags won't be fetched.
Tags Value Separator Separator for key and value in tags. For example, if the tag value separator is set to
=, the tagenv=prodis saved withenvas the key andprodas the value.If left empty, no tags are ingested.
Nota:The Auth Type, Workspaces, and Load Balancers properties are populated automatically. - Select Update.
- Set the Set configuration properties for new connection task to complete by selecting Mark as Complete.
-
Test the new connection.
- For the Test new connections task, select Configure.
- From the Name column, select the connection record of the new connection.
- Test the connection by selecting the Test Connection related link.
Testing the connection might take a few moments. The page is refreshed to show the test results.
- When the Status field is set to Success, select Update.
If any of the tests have errors, follow the suggestions for remediation.
- Set the Test new connections task to complete by selecting Mark as Complete.
- Repeat steps from 4.a until 4.f to add another instance.
-
Set up the scheduled import jobs.
- In the Set up scheduled import jobs section of the Kong Gateway Integration with CMDB page, select Get Started.
- For the Configure the scheduled import task, select Configure.
- From the Name column, select the parent scheduled job SG-Kong Gateway.
-
On the Scheduled Data Import form, verify the field values for the scheduled job.
For more information, see Schedule a data import.
- Select the Active check box to activate the SG-Kong Gateway scheduled import.
- In the Run field, select Periodically to specify how often the job will run.
- Select Update.
- Set the Configure the scheduled import task to complete by selecting Mark as Complete.