diff --git a/README.md b/README.md index 2a75f20c7..6bb1efd2a 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,10 @@ if there is a suggestion to improve the software. This is a mono repo containing code for both the web client and the microservices code base. -Only the [web client](client) and -[library microservice](servers/lib) -components are functional at present. +The [web client](client), +[library](servers/lib) and +[runner](servers/execution/runner) +microservices are functional at present. Everything else is a work-in-progress. Please see the @@ -46,7 +47,8 @@ The DTaaS software platform uses [Træfik](https://github.com/traefik/traefik), [ML Workspace](https://github.com/ml-tooling/ml-workspace), [Grafana](https://github.com/grafana/grafana), -[InfluxDB](https://github.com/influxdata/influxdb) and +[InfluxDB](https://github.com/influxdata/influxdb), +[MQTT](https://github.com/eclipse/mosquitto) and [RabbitMQ](https://github.com/rabbitmq/rabbitmq-server) open-source components. These software components have their own licenses. diff --git a/deploy/vagrant/make_boxes/dtaas/README.md b/deploy/vagrant/make_boxes/dtaas/README.md index 6af170ed7..483295bb4 100644 --- a/deploy/vagrant/make_boxes/dtaas/README.md +++ b/deploy/vagrant/make_boxes/dtaas/README.md @@ -4,7 +4,9 @@ This README provides instructions on creating a custom Operating System virtual disk for running the DTaaS software. The virtual disk is managed by **vagrant**. The purpose is two fold: -* Provide cross-platform installation of the DTaaS application. Any operating system supporting use of vagrant software utility can support installation of the DTaaS software. +* Provide cross-platform installation of the DTaaS application. + Any operating system supporting use of vagrant software utility can + support installation of the DTaaS software. * Create a ready to use development environment for code contributors. There are two scripts in this directory: diff --git a/deploy/vagrant/make_boxes/dtaas/developer.sh b/deploy/vagrant/make_boxes/dtaas/developer.sh index 14d9f5698..de446ff1c 100755 --- a/deploy/vagrant/make_boxes/dtaas/developer.sh +++ b/deploy/vagrant/make_boxes/dtaas/developer.sh @@ -37,6 +37,7 @@ newgrp microk8s docker pull telegraf:1.28.2 # Install markdownlint +sudo apt-get install -y rubygems sudo gem install mdl # Install madge for generating dependency graphs of typescript projects diff --git a/deploy/vagrant/make_boxes/dtaas/user.sh b/deploy/vagrant/make_boxes/dtaas/user.sh index 4fd8203a9..62a880aed 100755 --- a/deploy/vagrant/make_boxes/dtaas/user.sh +++ b/deploy/vagrant/make_boxes/dtaas/user.sh @@ -13,7 +13,9 @@ apt-get install -y \ lsb-release \ zsh \ apache2-utils \ - net-tools + net-tools \ + python3-dev \ + python3-pip mkdir -p /etc/apt/keyrings if [ ! -f /etc/apt/keyrings/docker.gpg ] diff --git a/docs/admin/services.md b/docs/admin/services.md index 8abf69723..96362b054 100644 --- a/docs/admin/services.md +++ b/docs/admin/services.md @@ -28,7 +28,7 @@ InfluxDB services on the second vagrant machine. If you would like to install some of these services for native OS installation or single vagrant machine, you can do this as well. -## RabbitMQ Service +## RabbitMQ Start the RabbitMQ service with @@ -56,7 +56,7 @@ TCP/UDP traffic. There are two possible choices here: Unless you are an informed user of Traefik, we recommend bypassing traefik for RabbitMQ service. -## Grafana Service +## Grafana Grafana service can run well behind Traefik gateway. Here is a sample docker command to run Grafana service at port 3000: @@ -97,7 +97,7 @@ The user credentials have also been set in the command as: Remember to change these credentials before starting the docker container. -## InfluxDB Service +## InfluxDB The barebones InfluxDB service can be installed using: diff --git a/docs/index.md b/docs/index.md index f11b7c38f..52daafde2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,6 +28,8 @@ and is available under [the INTO-CPS License](LICENSE.md). The DTaaS software platform uses [Træfik](https://github.com/traefik/traefik), [ML Workspace](https://github.com/ml-tooling/ml-workspace), [Grafana](https://github.com/grafana/grafana), -[InfluxDB](https://github.com/influxdata/influxdb) and -[RabbitMQ](https://github.com/rabbitmq/rabbitmq-server) open-source components. +[InfluxDB](https://github.com/influxdata/influxdb), +[MQTT](https://github.com/eclipse/mosquitto) and +[RabbitMQ](https://github.com/rabbitmq/rabbitmq-server) +open-source components. These software components have their own licenses. diff --git a/docs/thanks.md b/docs/thanks.md index 5b8705d95..f6872380b 100644 --- a/docs/thanks.md +++ b/docs/thanks.md @@ -12,7 +12,8 @@ Henrik Ejersbo, Tanusree Roy, Farshid Naseri 1. Talasila, P., Gomes, C., Mikkelsen, P. H., Arboleda, S. G., Kamburjan, E., & Larsen, P. G. (2023). - Digital Twin as a Service (DTaaS): A Platform for Digital Twin Developers and Users + Digital Twin as a Service (DTaaS): A Platform for + Digital Twin Developers and Users [arXiv preprint arXiv:2305.07244](https://arxiv.org/abs/2305.07244). 1. Astitva Sehgal 1. Tanusree Roy diff --git a/script/env.sh b/script/env.sh index b87d453f3..f95d2554e 100755 --- a/script/env.sh +++ b/script/env.sh @@ -12,7 +12,9 @@ sudo apt-get install -y \ lsb-release \ zsh \ apache2-utils \ - net-tools + net-tools \ + python3-dev \ + python3-pip sudo mkdir -p /etc/apt/keyrings if [ ! -f /etc/apt/keyrings/docker.gpg ] @@ -107,6 +109,7 @@ sudo -H pip3 install mkdocs-with-pdf sudo -H pip3 install qrcode # Install markdownlint +sudo apt-get install -y rubygems sudo gem install mdl # Install madge for generating dependency graphs of typescript projects