Installing Agents via Docker Compose

The following explains how to install agents via Docker Compose using an example.

If multiple agents are running on the same machine, each agent must be assigned its own Docker volume. Otherwise, the agents will overwrite each other’s persisted data, including username and password credentials.

1. To log in to the Cybus Docker registry, enter the following command in your terminal:

docker login registry.cybus.io

When prompted, enter the following credentials:

• Username: license

• Password: Your Connectware license key

1. Create a folder (e.g. myAgent)

2. Create a new file and name it docker-compose.yml.

3. Paste the following service commissioning file example into the file. For the IMAGE_TAGvariable, make sure to specify the image version that you want to use for the protocol-mapper agent. For example, 1.7.0.

services:
  protocol-mapper-agent:
    image: registry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
    environment:
      CYBUS_AGENT_MODE: distributed
      CYBUS_AGENT_NAME: myAgent
      CYBUS_HOSTNAME_INGRESS: localhost
      CYBUS_TRUST_ALL_CERTS: true
    volumes:
      - protocol-mapper-agent:/data
    restart: unless-stopped
    network_mode: host
    hostname: <some-suitable-hostname>
volumes:
  protocol-mapper-agent:

1. In your terminal, enter the following command to run the file:

docker compose up -d

1. Optional: To run the agent with root permission, add user: root to the docker-compose.yml file.

services:
  protocol-mapper-agent:
    user: root
    image: registry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
    [...]

Result: The agent is installed.