Versions Compared

Key

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

...

(tick) You’ve completed the second step!

...

Include Page
Create

...

Agent

...

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

...

Create Agent

...

Check the Agent's Status

  • Head over to your API Control Plane instance

  • Select “Environments” in the menu on the left side

    • Your AWS Agent should now be connected to API Control Plane

...