agent

README

ReSim Agent

The ReSim Agent allows ReSim jobs to be run on customer-controlled hosts.

It is designed to support the integration of Hardware-in-the-Loop (HiL) testing into your ReSim workflows.

See the Agent page on our docs site for more details.

Prerequisites

Install Docker (e.g. https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)

sudo chgrp docker /run/containerd/containerd.sock

Configuration

By default, the Agent loads config from ~/resim/config.yaml, caches credentials in that directory, and logs to the same directory (as well as stdout), however these settings can be overridden by setting the following environment variables:

• RESIM_AGENT_CONFIG_DIR - to point to a different configuration and cache directory. The Agent will load configuration from config.yaml in this directory and cache credentials here.
• RESIM_AGENT_LOG_DIR - to point to a different directory in which to write log files

The configuration file has the following options:

### Required
# Set a name for the agent which will be shown in ReSim
name: my-robot-arm
# Set the labels for which you would like this agent to run jobs (see below)
pool-labels: 
  - small
# These credentials for authenticating with the ReSim API will be provided by ReSim
username: 
password: 
### Optional 
# Log level - debug, info, warn, error (default: info)
log-level: info
# Size in MB of log file (default: 500), note that 3 compressed backups are kept
log-max-filesize: 200
# Auto update (default: false) - whether the agent will try to update itself when a new release is available
auto-update: false
# Privileged mode (default: false) - if true, your jobs will be run with elevated privileges (equivalent to docker --privileged)
privileged: false
# Privileged mode (default: bridge) - if "host", your jobs will be run without network isolation (equivalent to docker run --net=host)
docker-network-mode: host

Note that the pool-labels are an OR/ANY selection, that is, an agent running with the labels big and small will run jobs tagged with either of those labels.

CI

GO_VERSION is set as global variable in the repository settings

Releases

Binaries are built and uploaded to GitHub: https://github.com/resim-ai/agent/releases

To perform a release, push the appropriate v* tag to main.