Versions Compared

Version Old Version 14 New Version 15
Changes made by

Mirco Hoffmann

Mirco Hoffmann

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Excerpt
nameCreate a new Environment

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

  • Fill in the form (as exemplarily shown below)

Image Modified

  • Confirm by clicking on the "Register Environment" button

Select your Provider

  • Choose your provider by clicking on it

  • Confirm by clicking on the "Next" button

...

Image Added

(tick) You’ve completed the first step!

...

Provide the Gateway Information

...

(tick) You’ve completed the second step!

...

Excerpt

...

nameCreate an Agent as Intermediary

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 ghcr.io/apiida/obsidian-agent:latest

      • Download the latest image of the agent.

    • Code Block
      docker compose up

      • Starts the agent. It will connect automatically.

(tick) You’ve completed the third step!

...

Excerpt
nameCheck the Agent's Status

Check the Agent's Status

  • 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

Image Added

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

 

(tick) You’ve completed the last step!

You can now interact with your Gateways through APIIDA´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.

...

Q&A

Expand
titleHow do I get my accessKey and secretAccessKey?

...