On this page you will learn how to connect your Kong Gateway to Obsidian step-by-step.
Prerequisites
The following is required to proceed:
A running instance of APIIDA´s API Control Plane
Access to the instance of your Kong Gateway (Open Source)
Docker to use the image of our agent (that acts as an intermediary)
To get started, simply open your API Control Plane instance and follow the instructions below. Navigate to “Environments” in the menu on the left side Click on the “Create New Environment” button in the top right corner Choose your provider by clicking on it Confirm by clicking on the "Next" button Complete the form below following the example below: In Environment Settings you will receive detailed information about the fields to be filled in. Confirm by clicking on the "Register Environment" button Click Next here to start the Connection Wizard.Create a new Environment
Add an Environment
Add Environment Information
You’ve completed the first step!
Provide the Gateway Information
The following describes how to create the gateway configuration for a Kong Gateway Agent.
Gateway Configuration
url: Insert the URL to your Kong Management API
You’ve completed the second step!
The following describes how to create a Docker container for the agent. It is described using a Docker compose file so that additional agents can be easily added to your docker stack later. The outer path of the configuration file : The inner path of the configuration file Click on “Download and Next” to download your agent docker compose Put both files in the same folder. Then run the following commands. Download the latest image of the agent. Starts the agent. It will connect automatically.Create an Agent as Intermediary
image: The docker image of the API Control Plane Agentcontainer_name: You can freely choose the name of your Agent here as well as in line 3.environmentbackendUrl: The agent will establish a web-socket to this URL and thereby connect to your API Control Plane.gateway-config: The path inside the container to the configuration you downloaded in step 2.volumes
docker pull apiida/controlplane-agent
docker compose up
You’ve completed the third step!
Head over to your API Control Plane instance Select “Environments” in the menu on the left side Your Agent should now be connected to API Control Plane Admin Portal Click on the tile or the entry in the table to get more detailed information about the status of the connection. This can be very useful in case of an error. You can now interact with your Gateways through Boomi´s API Control Plane. Try it right now and discover your APIs! 💡 Tip: It is easy to add more agents! Repeat this guide or that of another gateway and simply add the agents to the existing Docker compose file.Check the Agent's Status
You’ve completed the last step!