Page Comparison

Create a new Environment

To get started, simply open your API Control Plane instance and follow the instructions below.

Add an Environment

• 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

Image Removed

Image Added

Add Environment Information

• Fill in the form (as exemplarily shown below)

Image Removed

Image Added

• Confirm by clicking on the "NextRegister Environment" button

Image Added

• Click Next here to create the environment and the special gateway configuration.

You’ve completed the first step!

Create an Agent as Intermediary

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.

Image Added

• image: The docker image of the API Control Plane Agent

• container_name: You can freely choose the name of your Agent here as well as in line 3.

• environment

  • backendUrl: 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

  • The outer path of the configuration file : The inner path of the configuration file

• Click on “Download” to download your agent docker compose

• Put both files in the same folder. Then run the following commands.

  • Code Block
    docker pull apiida/controlplane-agent:2023.3

    • Download the latest image of the agent.

  • Code Block
    docker compose up

    • Starts the agent. It will connect automatically.

You’ve completed the third step!