Waiting for engine...
Skip to main content

Register a gateway and run the agent

After you create a custom Platform Type, register a gateway for it and run the agent using Docker. The agent container loads your plugin, connects to API Control Plane, and makes your implemented capabilities available.

Prerequisites​

  • Custom Platform Type created in API Control Plane (see Create a custom Platform Type)
  • Agent plugin JAR file available on your local filesystem
  • Docker installed and running

Register a gateway​

  1. In API Control Plane, select Environments > Register Gateway.
  2. Select Custom Platforms.

  1. Select your custom platform and add the Gateway Information. The fields here are those defined in the JSON file that you previously uploaded. The JAR File Location is the path to the directory that contains the compiled JAR file of your Agent SDK implementation, with no trailing slash. The path can be absolute or relative to the docker-compose.yml file. This directory will be mounted as a volume onto the /plugin path of the agent docker container.

  2. Select Next.

  3. Add Environment Information and select Connect to Gateway.

note

If your agent is for a multi-environment gateway with environment discovery capability, add the information for any of your environments.

  1. Select Download and Next to download the docker compose file.

Run the agent​

  1. Place the downloaded docker-compose.yml file in the same directory as your JAR file, or ensure the plugin directory path in the file is correct.

  2. From the directory containing the docker-compose.yml file, run:

    docker compose up

  3. The agent container starts, loads your plugin from the mounted plugin directory, and connects to API Control Plane. The capabilities you implemented are now available.

  4. In Environments, you will see your agent connected. You can now run discovery on your agent to bring in components to API Control Plane.

On this Page