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.
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
Create a folder (e.g.
myAgent
)Create a new file and name it
docker-compose.yml
.Paste the following service commissioning file example into the file. For the
IMAGE_TAG
variable, make sure to specify the image version that you want to use for the protocol-mapper agent. For example,1.7.0
.
version: '2.0'
services:
protocol-mapper-agent:
image: registry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
environment:
CYBUS_AGENT_MODE: distributed
CYBUS_AGENT_NAME: myAgent
CYBUS_MQTT_HOST: 10.11.12.13
volumes:
- protocol-mapper-agent:/data
restart: unless-stopped
network_mode: host
hostname: <some-suitable-hostname>
volumes:
protocol-mapper-agent:
In your terminal, enter the following command to run the file:
docker compose up -d
Optional: To run the agent with root permission, add
user: root
to thedocker-compose.yml
file.
version: '2.0'
services:
protocol-mapper-agent:
user: root
image: registry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
[...]
Result: The agent is installed.
Last updated
Was this helpful?