wwwelab - User contributions [en]

Remote Experiment Controller

2021-04-22T16:59:02Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git (2.30.2+)
* Ant (1.10.9+)
* 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+)

= Preparation steps =

Setup JAVA_HOME environment variable pointing to a valid openjdk11 installation:

$ export JAVA_HOME=/path/to/openjdk11

Setup ~/.m2/toolchains.xml pointing to a valid openjdk11 installation:

<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<vendor>openjdk</vendor>
<version>11</version>
</provides>
<configuration>
<jdkHome>/path/to/openjdk/jdk11.0.8</jdkHome>
</configuration>
</toolchain>
</toolchains>

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''deployment/compose/src/main/docker/docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

'''experiments/{experiment}/etc/build.properties'''

* '''experiment.driver.device''': Serial port device (e.g. /dev/ttyS0)

Package everything:
$ mvn clean package -Dmaven.test.skip=true -Djarsigner.alias="REC" -Dbuild.environment=pendulum -Dpack.docker.images -Dpublic.repo=docker.io

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-runner.yml multicast-server-name:/tmp/docker-compose.yml

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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 Docker images (only if building outside target deployment server)
$ sudo -u elab docker load --input /tmp/webswing.tar # ReC client image
$ sudo -u elab docker load --input /tmp/multicast.tar # Multicast Controller image
$ sudo -u elab docker load --input /tmp/webswing-admin.tar # ReC client admin console image
$ sudo -u elab docker load --input /tmp/reverse-proxy.tar # Reverse Proxy image

* Copy docker-compose.yml file to elab user home
$ sudo -u elab cp /tmp/docker-compose.yml /home/elab/

* Start all services
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-16T11:12:30Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git (2.30.2+)
* Ant (1.10.9+)
* 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+)

= Preparation steps =

Setup JAVA_HOME environment variable pointing to a valid openjdk11 installation:

$ export JAVA_HOME=/path/to/openjdk11

Setup ~/.m2/toolchains.xml pointing to a valid openjdk11 installation:

<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<vendor>openjdk</vendor>
<version>11</version>
</provides>
<configuration>
<jdkHome>/path/to/openjdk/jdk11.0.8</jdkHome>
</configuration>
</toolchain>
</toolchains>

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''deployment/compose/src/main/docker/docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

'''experiments/{experiment}/etc/build.properties'''

* '''experiment.driver.device''': Serial port device (e.g. /dev/ttyS0)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-runner.yml multicast-server-name:/tmp/docker-compose.yml

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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 Docker images (only if building outside target deployment server)
$ sudo -u elab docker load --input /tmp/webswing.tar # ReC client image
$ sudo -u elab docker load --input /tmp/multicast.tar # Multicast Controller image
$ sudo -u elab docker load --input /tmp/webswing-admin.tar # ReC client admin console image
$ sudo -u elab docker load --input /tmp/reverse-proxy.tar # Reverse Proxy image

* Copy docker-compose.yml file to elab user home
$ sudo -u elab cp /tmp/docker-compose.yml /home/elab/

* Start all services
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-16T11:11:50Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git (2.30.2+)
* Ant (1.10.9+)
* 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+)

= Preparation steps =

Setup JAVA_HOME environment variable pointing to a valid openjdk11 installation:

$ export JAVA_HOME=/path/to/openjdk11

Setup ~/.m2/toolchains.xml pointing to a valid openjdk11 installation:

<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<vendor>openjdk</vendor>
<version>11</version>
</provides>
<configuration>
<jdkHome>/path/to/openjdk/jdk11.0.8</jdkHome>
</configuration>
</toolchain>
</toolchains>

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''deployment/compose/src/main/docker/docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

'''experiments/{experiment}/etc/build.properties'''

* '''experiment.driver.device''': Serial port device (e.g. /dev/ttyS0)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-runner.yml multicast-server-name:/tmp/docker-compose.yml

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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 Docker images (only if building outside target deployment server)
$ sudo -u elab docker load --input /tmp/webswing.tar # ReC client image
$ sudo -u elab docker load --input /tmp/multicast.tar # Multicast Controller image
$ sudo -u elab docker load --input /tmp/webswing-admin.tar # ReC client admin console image
$ sudo -u elab docker load --input /tmp/reverse-proxy.tar # Reverse Proxy image

* Copy docker-compose-template.yml and docker-compose-pendulum.yml to elab user home
$ sudo -u elab cp /tmp/docker-compose.yml /home/elab/

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-16T11:10:13Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git (2.30.2+)
* Ant (1.10.9+)
* 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+)

= Preparation steps =

Setup JAVA_HOME environment variable pointing to a valid openjdk11 installation:

$ export JAVA_HOME=/path/to/openjdk11

Setup ~/.m2/toolchains.xml pointing to a valid openjdk11 installation:

<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<vendor>openjdk</vendor>
<version>11</version>
</provides>
<configuration>
<jdkHome>/path/to/openjdk/jdk11.0.8</jdkHome>
</configuration>
</toolchain>
</toolchains>

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''deployment/compose/src/main/docker/docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

'''experiments/{experiment}/etc/build.properties'''

* '''experiment.driver.device''': Serial port device (e.g. /dev/ttyS0)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-runner.yml multicast-server-name:/tmp/docker-compose.yml

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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.yml /home/elab/

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-16T11:08:30Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git
* Ant (1.10.9+)
* 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+)

= Preparation steps =

Setup JAVA_HOME environment variable pointing to a valid openjdk11 installation:

$ export JAVA_HOME=/path/to/openjdk11

Setup ~/.m2/toolchains.xml pointing to a valid openjdk11 installation:

<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<vendor>openjdk</vendor>
<version>11</version>
</provides>
<configuration>
<jdkHome>/path/to/openjdk/jdk11.0.8</jdkHome>
</configuration>
</toolchain>
</toolchains>

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''deployment/compose/src/main/docker/docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

'''experiments/{experiment}/etc/build.properties'''

* '''experiment.driver.device''': Serial port device (e.g. /dev/ttyS0)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-runner.yml multicast-server-name:/tmp/docker-compose.yml

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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.yml /home/elab/

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-15T15:37:00Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git
* Ant (1.10.9+)
* 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+)

= Preparation steps =

Setup JAVA_HOME environment variable pointing to a valid openjdk11 installation:

$ export JAVA_HOME=/path/to/openjdk11

Setup ~/.m2/toolchains.xml pointing to a valid openjdk11 installation:

<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<vendor>openjdk</vendor>
<version>11</version>
</provides>
<configuration>
<jdkHome>/path/to/openjdk/jdk11.0.8</jdkHome>
</configuration>
</toolchain>
</toolchains>

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''deployment/compose/src/main/docker/docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

'''experiments/{experiment}/etc/build.properties'''

* '''experiment.driver.device''': Serial port device (e.g. /dev/ttyS0)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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/

* Create compose file for 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 config > /home/elab/docker-compose.yml

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-15T14:39:45Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git
* Ant (1.10.9+)
* 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+)

= Preparation steps =

Setup JAVA_HOME environment variable pointing to a valid openjdk11 installation:

$ export JAVA_HOME=/path/to/openjdk11

Setup ~/.m2/toolchains.xml pointing to a valid openjdk11 installation:

<toolchains>
<toolchain>
<type>jdk</type>
<provides>
<vendor>openjdk</vendor>
<version>11</version>
</provides>
<configuration>
<jdkHome>/path/to/openjdk/jdk11.0.8</jdkHome>
</configuration>
</toolchain>
</toolchains>

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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/

* Create compose file for 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 config > /home/elab/docker-compose.yml

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-15T13:52:47Z

Ist149563:

= Pre-requisites =

== Build environment ==

* Git
* Ant (1.10.9+)
* Maven (3.6.3+)
* OpenJDK 11 (11.0.8+) and JAVA_HOME environment variable pointing to a valid openjdk11 installation
* 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+)

= Preparation steps =

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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/

* Create compose file for 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 config > /home/elab/docker-compose.yml

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-13T13:58:54Z

Ist149563:

= Pre-requisites =

== 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+)

= Preparation steps =

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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/

* Create compose file for 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 config > /home/elab/docker-compose.yml

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client and Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-13T13:58:19Z

Ist149563:

= Pre-requisites =

== 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+)

= Preparation steps =

First checkout the project from github:

$ git clone https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client, 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/

* Create compose file for 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 config > /home/elab/docker-compose.yml

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

* Logs
$ /home/elab/rec-deployment/${experiment}/*.log

== ReC Client, Multicast Controller ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

* Logs:
$ docker logs rec.client # ReC client logs (webswing)
$ docker logs rec.multicast # ReC Multicast Controller logs
$ docker logs rec.proxy # ReC Proxy logs
$ docker logs rec.client-admin # ReC client Administration Console logs (webswing)

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-13T13:47:13Z

Ist149563:

= Pre-requisites =

== 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 https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/
* Optional (rec.web)
$ scp deployment/images/target/rec.web.tar multicast-server-name:/tmp/
$ scp deployment/images/target/rec.web-upgrade-db.tar multicast-server-name:/tmp/
$ scp deployment/images/target/rec.web-db.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-rec.web.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client, Multicast Controller and ReC Web (Optional) ==

* 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/

* Create compose file for 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 config > /home/elab/docker-compose.yml

* Optional (rec.web)
$ sudo -u elab docker load --input /tmp/rec.web.tar
$ sudo -u elab docker load --input /tmp/rec.web-upgrade-db.tar
$ sudo -u elab docker load --input /tmp/rec.web-db.tar
$ sudo -u elab echo AS_ADMIN_ALIASPASSWORD=askPass > /home/elab/asadmin_mail.secret
$ sudo -u elab echo AS_ADMIN_ALIASPASSWORD=rec > /home/elab/asadmin_recdb.secret
$ sudo -u elab echo rec > /home/elab/rec-db.secret
$ sudo -u elab echo root > /home/elab/root-db.secret
$ sudo -u elab docker-compose -f /home/elab/docker-compose-template.yml -f /home/elab/docker-compose-pendulum.yml -f /home/elab/docker-compose-rec.yml config > /home/elab/docker-compose.yml

* Start Components
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

* Direct access to experiment:

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com) + experiment name (e.g. wpalentejo)

https://elab.my.url.com/wpalentejo

* Webswing and administration console

Access configured URL at WEBSWING_PUBLIC_URL property (e.g. https://elab.my.url.com)

https://elab.my.url.com/

User: admin
Pass: pwd

= Operations =

== Hardware Server ==

* Startup
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

* Shutdown
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh stop

== ReC Client, Multicast Controller and ReC Web (Optional) ==

* Startup
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml up -d

* Shutdown
$ sudo -u elab docker-compose -f /home/elab/docker-compose.yml down

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-13T12:15:23Z

Ist149563:

= Pre-requisites =

== 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 https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/
* Optional (rec.web)
$ scp deployment/images/target/rec.web.tar multicast-server-name:/tmp/
$ scp deployment/images/target/rec.web-upgrade-db.tar multicast-server-name:/tmp/
$ scp deployment/images/target/rec.web-db.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-rec.web.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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

* Optional (rec.web)
$ sudo -u elab docker load --input /tmp/rec.web.tar
$ sudo -u elab docker load --input /tmp/rec.web-upgrade-db.tar
$ sudo -u elab docker load --input /tmp/rec.web-db.tar
$ sudo -u elab echo AS_ADMIN_ALIASPASSWORD=askPass > /home/elab/asadmin_mail.secret
$ sudo -u elab echo AS_ADMIN_ALIASPASSWORD=rec > /home/elab/asadmin_recdb.secret
$ sudo -u elab echo rec > /home/elab/rec-db.secret
$ sudo -u elab echo root > /home/elab/root-db.secret
$ sudo -u elab docker-compose -f /home/elab/docker-compose-template.yml -f /home/elab/docker-compose-pendulum.yml -f /home/elab/docker-compose-rec.web.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-13T12:14:47Z

Ist149563:

= Pre-requisites =

== 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 https://github.com/linkareti/rec-project.git

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

$ git checkout jdk11-migration

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

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Configure the following properties based on your environment:

'''build_pendulum.properties''':

* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': 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)

'''docker-compose-pendulum.yml''':

* '''WEBSWING_PUBLIC_URL''': URL where webswing is accessible (e.g. https://elab-dev.vps.tecnico.ulisboa.pt/)

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

Copy resulting packages to destination servers:

* Multicast Server
$ scp deployment/images/target/reverse-proxy.tar multicast-server-name:/tmp/
$ scp deployment/images/target/multicast.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing-admin.tar multicast-server-name:/tmp/
$ scp deployment/images/target/webswing.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-{pendulum,template}.yml multicast-server-name:/tmp/
* Optional (rec.web)
$ scp deployment/images/target/rec.web.tar multicast-server-name:/tmp/
$ scp deployment/images/target/rec.web-upgrade-db.tar multicast-server-name:/tmp/
$ scp deployment/images/target/rec.web-db.tar multicast-server-name:/tmp/
$ scp deployment/compose/target/docker-compose-rec.web.yml multicast-server-name:/tmp/

* Hardware Server
$ scp dist/java/*HardwareServer*.zip hardware-server-name:/tmp/

= Install =

== ReC Client 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

* Optional (rec.web)
$ sudo -u elab docker load --input /tmp/rec.web.tar
$ sudo -u elab docker load --input /tmp/rec.web-upgrade-db.tar
$ sudo -u elab docker load --input /tmp/rec.web-db.tar
$ sudo -u elab echo AS_ADMIN_ALIASPASSWORD=askPass > /home/elab/asadmin_mail.secret
$ sudo -u elab echo AS_ADMIN_ALIASPASSWORD=rec > /home/elab/asadmin_recdb.secret
$ sudo -u elab echo rec > /home/elab/rec-db.secret
$ sudo -u elab echo root > /home/elab/root-db.secret
$ sudo -u elab docker-compose -f /home/elab/docker-compose-template.yml -f /home/elab/docker-compose-pendulum.yml -f /home/elab/docker-compose-rec.yml up -d

== Hardware Server ==

* Replace wpexperiment with your experiment name
$ export experiment=wpexperiment

* Create user elab
$ sudo useradd --create-home --shell /bin/false --expiredate 1 elab

* Create experiment directory
$ sudo -u elab mkdir /home/elab/rec-deployment/${experiment}

* Unpack experiment package to experiment directory
$ sudo -u elab unzip /tmp/${experiment}HardwareServer*.zip -d /home/elab/rec-deployment/${experiment}

* Start experiment
$ sudo -u elab /home/elab/rec-deployment/${experiment}/${experiment}Daemon.sh start

= Test =

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-13T11:40:45Z

Ist149563:

Remote Experiment Controller

2021-04-13T11:33:34Z

Ist149563:

Remote Experiment Controller

2021-04-13T11:32:53Z

Ist149563:

Remote Experiment Controller

2021-04-13T11:22:05Z

Ist149563:

Remote Experiment Controller

2021-04-12T12:48:59Z

Ist149563:

Remote Experiment Controller

2021-04-12T12:43:23Z

Ist149563:

Remote Experiment Controller

2021-04-12T10:05:07Z

Ist149563:

= Pre-requisites =

== 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 =

To create a pendulum experiment, the script create_pendulum_experiment.sh allows to create a base experiment for a new pendulum

'''experiments/create_pendulum_experiment.sh'''

'''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://elabmc.ist.utl.pt:80/wp_ccalg.sdp)
* '''5th argument''': Pendulum serial device location (default: /dev/ttyS0)

Sample script execution to create pendulum:

$ ./create_pendulum_experiment.sh wpalentejo ELAB_WP_ALENTEJO Alentejo rtsp://elabmc.ist.utl.pt:80/wp_alentejo.sdp /dev/ttyS0

= Build =

Follow the next steps to build and run at target environments.

'''build_pendulum.properties:'''

* '''lab.list''': Name of the laboratories to build, comma (,) delimited.
* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': Hostname where Multicast controller is going to be installed
* '''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)

== Local ==

This option only serves testing purposes (install locally a clean environment), Pendulum Hardware Server is not used at this step.

$ mvn clean package -Dmaven.test.skip=true -Djarsigner.alias="REC" -Dbuild.environment=local

Be aware that a virtual experiment is started by this step, not the pendulum!

== Production ==

Build the project:

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

Steps to build and deploy ReC at target environments:

# TODO Steps

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-12T09:21:18Z

Ist149563:

= Pre-requisites =

== 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+)

= Pre-Steps =

experiments/create_pendulum_experiment.sh
echo "experiment name - Name of the experiment (e.g. worldpendulum)"
echo "experiment ID - ID of the experiment (e.g. ELAB_WORLD_PENDULUM_CCVALG)"
echo "Location - Pendulum location (e.g. Faro)"
echo "(optional) Video Location - URL to the video (e.g. rtsp://elabmc.ist.utl.pt:80/wp_ccvalg.sdp)"
echo "(optional) Serial Device - Pendulum serial device location at the server (e.g. /dev/ttyS0)"

= Build =

Follow the next steps to build and run at target environments.

'''build_pendulum.properties:'''

* '''lab.list''': Name of the laboratories to build, comma (,) delimited.
* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': Hostname where Multicast controller is going to be installed
* '''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)

== Local ==

This option only serves testing purposes (install locally a clean environment), Pendulum Hardware Server is not used at this step.

$ mvn clean package -Dmaven.test.skip=true -Djarsigner.alias="REC" -Dbuild.environment=local

Be aware that a virtual experiment is started by this step, not the pendulum!

== Production ==

Build the project:

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

Steps to build and deploy ReC at target environments:

# TODO Steps

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-12T09:21:00Z

Ist149563:

= Pre-requisites =

== 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)==

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

= Pre-Steps =

experiments/create_pendulum_experiment.sh
echo "experiment name - Name of the experiment (e.g. worldpendulum)"
echo "experiment ID - ID of the experiment (e.g. ELAB_WORLD_PENDULUM_CCVALG)"
echo "Location - Pendulum location (e.g. Faro)"
echo "(optional) Video Location - URL to the video (e.g. rtsp://elabmc.ist.utl.pt:80/wp_ccvalg.sdp)"
echo "(optional) Serial Device - Pendulum serial device location at the server (e.g. /dev/ttyS0)"

= Build =

Follow the next steps to build and run at target environments.

'''build_pendulum.properties:'''

* '''lab.list''': Name of the laboratories to build, comma (,) delimited.
* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': Hostname where Multicast controller is going to be installed
* '''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)

== Local ==

This option only serves testing purposes (install locally a clean environment), Pendulum Hardware Server is not used at this step.

$ mvn clean package -Dmaven.test.skip=true -Djarsigner.alias="REC" -Dbuild.environment=local

Be aware that a virtual experiment is started by this step, not the pendulum!

== Production ==

Build the project:

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

Steps to build and deploy ReC at target environments:

# TODO Steps

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-12T09:14:41Z

Ist149563:

= Pre-requisites =

* OpenJDK 11
* Docker
* docker-compose

= Pre-Steps =

experiments/create_pendulum_experiment.sh
echo "experiment name - Name of the experiment (e.g. worldpendulum)"
echo "experiment ID - ID of the experiment (e.g. ELAB_WORLD_PENDULUM_CCVALG)"
echo "Location - Pendulum location (e.g. Faro)"
echo "(optional) Video Location - URL to the video (e.g. rtsp://elabmc.ist.utl.pt:80/wp_ccvalg.sdp)"
echo "(optional) Serial Device - Pendulum serial device location at the server (e.g. /dev/ttyS0)"

= Build =

Follow the next steps to build and run at target environments.

'''build_pendulum.properties:'''

* '''lab.list''': Name of the laboratories to build, comma (,) delimited.
* '''pendulum.experiment.list''': Name of the experiment(s) to build, comma (,) delimited.
* '''pendulum.multicast.controller.host''': Hostname where Multicast controller is going to be installed
* '''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)

== Local ==

This option only serves testing purposes (install locally a clean environment), Pendulum Hardware Server is not used at this step.

$ mvn clean package -Dmaven.test.skip=true -Djarsigner.alias="REC" -Dbuild.environment=local

Be aware that a virtual experiment is started by this step, not the pendulum!

== Production ==

Build the project:

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

Steps to build and deploy ReC at target environments:

# TODO Steps

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-12T08:34:03Z

Ist149563:

Steps to build and run ReC Local Environment:

To test locally, edit build_pendulum.properties:

pendulum.experiment.list=wpchangeme
pendulum.multicast.controller.host=yourhost

Other important properties:

pendulum.multicast.controller.port=9001 # CORBA port
pendulum.rec.multicastcontroller.jmxremote.port=25001 # JMX Port
install.dir=/home/elab # Base directory for the multicast controller installation
deployment.subdir=/rec-deployment # Deployment directory for the multicast controller installation

Build the project:

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

Steps to build and deploy ReC at target environments:

# TODO Steps

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-09T18:51:56Z

Ist149563:

Steps to build and run ReC Local Environment:

To test locally, edit build_pendulum.properties:

pendulum.experiment.list=wpchangeme

pendulum.multicast.controller.host=yourhost

Other important properties:

pendulum.multicast.controller.port=9001 # CORBA port

pendulum.rec.multicastcontroller.jmxremote.port=25001 # JMX Port

install.dir=/home/elab # Base directory for the multicast controller installation

deployment.subdir=/rec-deployment # Deployment directory for the multicast controller installation

Build the project:

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

Steps to build and deploy ReC at target environments:

# TODO Steps

Steps to connect to IST environment:

# TODO Steps

Remote Experiment Controller

2021-04-09T15:26:29Z

Ist149563: Created page with "Steps to build and run ReC Local Environment: # TODO Steps Steps to build and deploy ReC at target environments: # TODO Steps Steps to connect to IST environment: # TODO..."

Steps to build and run ReC Local Environment:

# TODO Steps

Steps to build and deploy ReC at target environments:

# TODO Steps

Steps to connect to IST environment:

# TODO Steps

File:Logo info tech.png

2014-02-18T20:25:46Z

Ist149563: uploaded a new version of "File:Logo info tech.png"

Linkare logo.