Remote Experiment Controller

From wwwelab
Revision as of 11:32, 13 April 2021 by Ist149563 (talk | contribs)
Jump to navigation Jump to search


Build environment

  • Maven 3.6.3
  • OpenJDK 11 (11.0.8+)
  • Docker (20.10+)
  • docker-compose (1.25.4+)

Multicast Controller and rec.client

  • Docker (20.10+)
  • docker-compose (1.25.4+)

Hardware Server

  • OpenJDK 11 (11.0.8+)

rec.web (recommended only for testing locally)

  • Docker (20.10+)
  • docker-compose (1.25.4+)

Preparation steps

First checkout the project from github:

   $ git clone

(FIXME) Then we need to switch to jdk11-migration branch:

   $ git checkout jdk11-migration

To create a pendulum experiment, the script helps to create a base experiment for a brand new pendulum


   Mandatory arguments:
   * 1st argument: Name of the experiment (e.g. worldpendulum)
   * 2nd argument: ID of the experiment (e.g. ELAB_WORLD_PENDULUM)
   * 3rd argument: Pendulum location (e.g. Faro)
   Optional arguments:
   * 4th argument: URL to the video (e.g. rtsp://
   * 5th argument: Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

   $ ./ wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp:// /dev/ttyS0


Configure the following properties based on your environment:

  • pendulum.experiment.list: Name of the experiment(s) to build, comma (,) delimited.
  • Hostname where Multicast controller is going to be installed (default: elab-multicast)
  • pendulum.multicast.controller.port: Listen CORBA port used to recieve connections from Hardware Server, rec.web and rec.client (default: 9001)
  • pendulum.rec.multicastcontroller.jmxremote.port: Listen JMX port used to recieve connections from rec.web (default: 25001)
  • install.dir: Base directory where Multicast Controller is going to be installed (default: /home/elab)
  • deployment.subdir: Sub directory where Multicast Controller is going to be installed (default: /rec-deployment)



   $ mvn clean package -Dmaven.test.skip=true -Djarsigner.alias="REC" -Dbuild.environment=pendulum -Dpack.docker.images

Copy to destination servers:

   $ scp deployment/images/target/*.tar multicast-server-name:/tmp/
   $ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/
   $ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/


ReC, Webswing and Multicast Controller

   # Create user elab
   $ sudo useradd --create-home --shell /bin/false --expiredate 1 elab
   # Add user to docker group
   $ sudo usermod -a -G docker elab
   # Load ReC client image
   $ sudo -u elab docker load --input /tmp/webswing.tar
   # Load Multicast Controller image
   $ sudo -u elab docker load --input /tmp/multicast.tar
   # Load ReC client admin console image
   $ sudo -u elab docker load --input /tmp/webswing-admin.tar
   # Load Reverse Proxy image
   $ sudo -u elab docker load --input /tmp/reverse-proxy.tar
   # Copy docker-compose-template.yml and docker-compose-pendulum.yml to elab user home
   $ sudo -u elab cp /tmp/docker-compose-{pendulum,template}.yml /home/elab/
   # Start ReC client, ReC client Administration Console, ReC Multicast Controller and Reverse Proxy
   $ sudo -u elab docker-compose -f /home/elab/docker-compose-template.yml -f /home/elab/docker-compose-pendulum.yml up -d

Hardware Server

   # Replace wpexperiment with your experiment name
   $ export experiment=wpexperiment
   $ sudo useradd --create-home --shell /bin/false --expiredate 1 elab
   $ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}
   $ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d  /home/elab/rec-deployment/${experiment}
   $ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment} start

Steps to connect to IST environment:

  1. TODO Steps