Updates install scripts #150

prasadtalasila · 2023-10-04T06:37:40Z

This PR addresses issue #119 . The progress so far:

Status

Update deploy/single-script-install.sh
Update script/env.sh and script/docker.sh
Cleans up deploy/vagrant/make_boxes/dtaas to separate user and developer environments

Pushed to next PR:

Update deploy/install.sh
Pull out secrets of shell scripts (esp deploy/vagrant/two-machine/services.sh) into .secrets file

codeclimate · 2023-10-04T06:38:29Z

deploy/vagrant/make_boxes/dtaas/user.sh

+curl -fsSL "https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key" | \
+  gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+NODE_MAJOR=18
+printf "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | \


Don't use variables in the printf format string. Use printf "..%s.." "$foo".

codeclimate · 2023-10-04T06:38:29Z

deploy/vagrant/make_boxes/dtaas/provision.sh

+curl -fsSL "https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key" | \
+  gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+NODE_MAJOR=18
+printf "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | \


Don't use variables in the printf format string. Use printf "..%s.." "$foo".

codeclimate · 2023-10-04T06:38:29Z

deploy/vagrant/make_boxes/dtaas/README.md

-* nodejs and yarn
-* jupyter
-* microk8s
+* Provide cross-platform installation of the DTaaS application. Any operating


Lists should be surrounded by blank lines

codeclimate · 2023-10-04T06:38:30Z

deploy/vagrant/make_boxes/dtaas/README.md

+  * influxdb v2.7
+  * grafana v10.1
+  * rabbitmq v3-management
+  * eclipse-mosquitto (mqtt) v2 


Trailing spaces

codeclimate · 2023-10-04T06:38:30Z

deploy/vagrant/make_boxes/dtaas/README.md

+* 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.


Lists should be surrounded by blank lines

prasadtalasila · 2023-10-04T06:39:09Z

@nichlaes These scripts will be part of the new release and are ones need to be checked. I will complete most of them by next Monday. These will be ready by the time you start checking on Tuesday next week.

codeclimate · 2023-10-07T14:34:58Z

script/env.sh

+    sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+fi
+NODE_MAJOR=18
+printf "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | \


Don't use variables in the printf format string. Use printf "..%s.." "$foo".

codeclimate · 2023-10-07T14:34:59Z

deploy/single-script-install.sh

+    sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg
+fi
+NODE_MAJOR=18
+printf "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] \


Don't use variables in the printf format string. Use printf "..%s.." "$foo".

codeclimate · 2023-10-07T14:34:59Z

docs/FAQ.md

-Currently No. **We are looking for users needing this capability.**
-**If you have concrete requirements and an example, we can discuss a way**
-**of realizing it in DTaaS**.
+    Currently No. **We are looking for users needing this capability.**


Code block style

codeclimate · 2023-10-07T14:34:59Z

docs/admin/vagrant/base-box.md

+caters to your needs. You can skip the next step and continue with the 
+creation of vagrant box.
+
+If you are a developer and would like additional software installed, you need 


Trailing spaces

codeclimate · 2023-10-07T14:34:59Z

docs/admin/vagrant/base-box.md

+  * influxdb v2.7
+  * grafana v10.1
+  * rabbitmq v3-management
+  * eclipse-mosquitto (mqtt) v2 


Trailing spaces

codecov-commenter · 2023-10-07T14:35:25Z

Codecov Report

Merging #150 (cc6530b) into feature/distributed-demo (cf516fa) will decrease coverage by 27.10%.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@                      Coverage Diff                      @@
##           feature/distributed-demo     #150       +/-   ##
=============================================================
- Coverage                     93.02%   65.93%   -27.10%     
=============================================================
  Files                             4       42       +38     
  Lines                            43      543      +500     
  Branches                          3       31       +28     
=============================================================
+ Hits                             40      358      +318     
- Misses                            0      166      +166     
- Partials                          3       19       +16

see 38 files with indirect coverage changes

Components	Coverage Δ
Website	`62.72% <ø> (∅)`
Lib Microservice	`66.38% <ø> (∅)`

codeclimate · 2023-10-07T14:45:30Z

deploy/vagrant/make_boxes/dtaas/README.md

+| `developer.sh` | developer installation | :x: |
+
+If you are installing the DTaaS for developers, the default installation
+caters to your needs. You can skip the next step and continue with the 


Trailing spaces

codeclimate · 2023-10-07T14:45:30Z

deploy/vagrant/make_boxes/dtaas/README.md

+caters to your needs. You can skip the next step and continue with the 
+creation of vagrant box.
+
+If you are a developer and would like additional software installed, you need 


Trailing spaces

codeclimate · 2023-10-07T14:45:30Z

docs/admin/vagrant/base-box.md

+| `developer.sh` | developer installation | :x: |
+
+If you are installing the DTaaS for developers, the default installation
+caters to your needs. You can skip the next step and continue with the 


Trailing spaces

codeclimate · 2023-10-07T14:45:30Z

docs/admin/vagrant/base-box.md


-## Installed Software
+* Provide cross-platform installation of the DTaaS application. Any operating


Lists should be surrounded by blank lines

codeclimate · 2023-10-07T14:45:31Z

docs/admin/vagrant/base-box.md

+* 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.


Lists should be surrounded by blank lines

codeclimate · 2023-10-07T19:50:52Z

deploy/vagrant/make_boxes/dtaas/README.md

-* nodejs and yarn
-* jupyter
-* microk8s
+* Provide cross-platform installation of the DTaaS application. Any operating system supporting use of vagrant software utility can support installation of the DTaaS software.


Line length

@astitva1905 If the line is broken into two lines, then another error comes:

Lists should be surrounded by blank lines

do you know of a good way to resolve this problem?

Yes Prasad
Simply shift some part to the next line and then add enough spaces at the beginning of the line so that the indentation matches the indentation of “Provide”. It should work then.

codeclimate · 2023-10-07T19:50:52Z

docs/admin/vagrant/base-box.md


-## Installed 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.


Line length

codeclimate · 2023-10-07T19:50:52Z

docs/FAQ.md

-DTaaS is software platform on which you can create and run digital twins.
-Please see the [features](user/features.md) page
-to get a sense of the things you can do in DaaS.
+    DTaaS is software platform on which you can create and run digital twins.


Code block style

codeclimate · 2023-10-07T19:50:53Z

docs/FAQ.md

-| Availability | It is a matter of human resources. If you have human
-resources to maintain DTaaS round the clock,
-upwards 95% is easily possible. |
+    | Key Performance Indicator | Value |


Code block style

codeclimate · 2023-10-07T19:50:53Z

docs/FAQ.md

-on Linux-based xfce Desktop environment.
-Users can install software in their workspaces. The licensed software
-installed by one user is not available to another user.
+    The licensed software are not available on the software platform.


Code block style

astitva1905 · 2023-10-07T20:22:41Z

Yes Prasad Simply shift some part to the next line and then add enough spaces at the beginning of the line so that the indentation matches the indentation of “Provide”. It should work then.

…

On Sun, 8 Oct 2023 at 1:34 AM, Prasad Talasila ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In deploy/vagrant/make_boxes/dtaas/README.md <#150 (comment)> : > -* docker -* nodejs and yarn -* jupyter -* microk8s +* Provide cross-platform installation of the DTaaS application. Any operating system supporting use of vagrant software utility can support installation of the DTaaS software. @astitva1905 <https://github.com/astitva1905> If the line is broken into two lines, then another error comes: Lists should be surrounded by blank lines do you know of a good way to resolve this problem? — Reply to this email directly, view it on GitHub <#150 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AQRXSHWVO2JA7QYH5UC4F7TX6GYU5AVCNFSM6AAAAAA5SDAND6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTMNRTGEYDINBVGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- The information contained in this electronic communication is intended solely for the individual(s) or entity to which it is addressed. It may contain proprietary, confidential and/or legally privileged information. Any review, retransmission, dissemination, printing, copying or other use of, or taking any action in reliance on the contents of this information by person(s) or entities other than the intended recipient is strictly prohibited and may be unlawful. If you have received this communication in error, please notify us by responding to this email or telephone and immediately and permanently delete all copies of this message and any attachments from your system(s). The contents of this message do not necessarily represent the views or policies of BITS Pilani.

codeclimate · 2023-10-07T20:24:30Z

docs/FAQ.md

-Linux desktop / terminal tools  inside the DTaaS. So you can create
-models inside DTaaS and run them using tools that can run in Linux.
-The Windows only tools can not run in DTaaS.
+    DTaaS is not a model creation  tool. You can put model creation tool


Code block style

codeclimate · 2023-10-07T20:24:30Z

docs/FAQ.md

-these kinds of tools, you need to bring them onto the platform.
-For example, if you need Matlab for your work, you need to bring
-he licensed Matlab software.
+    Well, DTaaS by itself does not produce any models. DTaaS only provides


Code block style

codeclimate · 2023-10-07T20:24:30Z

docs/FAQ.md


 ??? Question "Commercial DT platforms in market provide modelling and simulation alongside integration and UI. DTaas is not able to do any modelling or simulation on its own like other commercial platforms. Is this a correct understanding?"

-Yes, you are right
+    Yes, you are right


Code block style

codeclimate · 2023-10-07T20:24:30Z

docs/FAQ.md

-DTaaS does not provide dedicated solvers. But if you can install
-a solver in your workspace, then you don't need the platform
-to provide one.
+    The DTaaS as such is agnostic to the kind of models you use. DTaaS can


Code block style

codeclimate · 2023-10-07T20:24:30Z

docs/FAQ.md

-services for digital twin communication.
-Having said that, DTaaS allows you to utilize other communication
-technologies and services hosted elsewhere on the Internet.
+    The real measurements are done at physical twin which are then


Code block style

codeclimate · 2023-10-08T08:21:30Z

docs/FAQ.md

-support execution of digital twins. If a tool can be executed on
-a Linux desktop / commandline, the tool can be supported within DTaaS.
-The tool (ex. Matlab) itself can take care of the metadata requirements.
+    DTaaS can not understand the static or dynamic nature of data.


Code block style

codeclimate · 2023-10-08T08:21:30Z

docs/FAQ.md

-communication with relative ease.
-You can use InfluxDB, RabbitMQ and Mosquitto services hosted on DTaaS for
-two communication between digital and physical entities.
+    At a very abstract level, there is a communication from physical entity


Code block style

codeclimate · 2023-10-08T08:21:30Z

docs/FAQ.md

-broker services. There is a user interface for InfluxDB which can be
-used to analyze the data collected.
-Users can also manually upload their data files into DTaaS.
+    The DTaaS provids InfluxDB, RabbitMQ, MQTT  services. Both the physical twin


Code block style

codeclimate · 2023-10-08T08:21:31Z

docs/FAQ.md


 ??? Question "Which transmission protocol does DTaaS allow?"

-InfluxDB, RabbitMQ, MQTT and anything else that can be used from
-Cloud service providers.
+    InfluxDB, RabbitMQ, MQTT and anything else that can be used from


Code block style

codeclimate · 2023-10-08T08:21:31Z

docs/FAQ.md

-You can store information from multiple sources. The existing InfluxDB
-services hosted on DTaaS already has a dedicated Influx / Flux query
-language for doing sensor fusion, analysis and inferences.
+    You can store information from multiple sources. The existing InfluxDB


Code block style

codeclimate · 2023-10-08T14:22:42Z

docs/FAQ.md

-Graphical, geometric and images. If you need specific licensed software
-for the visualization, you will have to bring the license for it.
-DTaaS does not support AR/VR.
+    Graphical, geometric and images. If you need specific licensed software


Code block style

codeclimate · 2023-10-08T14:22:42Z

docs/FAQ.md


 ??? Question "Can DTaaS collect data directly from sensors?"

-Yes
+    Yes


Code block style

codeclimate · 2023-10-08T14:22:43Z

docs/FAQ.md


 ??? Question "Is DTaaS able to transmit data to cloud in real time?"

-Yes
+    Yes


Code block style

codeclimate · 2023-10-08T14:22:43Z

docs/FAQ.md


 ## Platform Native Services on DTaaS Platform

 ??? Question "Is DTaaS able to detect the anomalies about-to-fail components and prescribe solutions?"

-This is the job of a digital twin. If you have a ready to use digital twin
-that does the job, DTaaS allows others to use your solution.
+    This is the job of a digital twin. If you have a ready to use digital twin


Code block style

codeclimate · 2023-10-08T14:22:43Z

docs/FAQ.md

-... & Gomes, C. (2023). Digital twin of electric vehicle battery systems:
-Comprehensive review of the use cases, requirements, and platforms.
-Renewable and Sustainable Energy Reviews, 179, 113280.
+    Here is a qualitative comparison of different DT integration platforms:


Code block style

codeclimate · 2023-10-08T15:39:34Z

docs/thanks.md

@@ -12,8 +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](https://arxiv.org/abs/2305.07244).
-   arXiv preprint arXiv:2305.07244.
+   Digital Twin as a Service (DTaaS): A Platform for Digital Twin Developers and Users


Line length

codeclimate · 2023-10-08T15:39:35Z

docs/user/servers/lib/LIB-MS.md

+    Content-Type: application/json; charset=utf-8
+    Date: Tue, 26 Sep 2023 20:26:49 GMT
+    X-Powered-By: Express
+    {"data":{"listDirectory":{"repository":{"tree":{"blobs":{"edges":[]},"trees":{"edges":[{"node":{"name":"data","type":"tree"}},{"node":{"name":"digital twins","type":"tree"}},{"node":{"name":"functions","type":"tree"}},{"node":{"name":"models","type":"tree"}},{"node":{"name":"tools","type":"tree"}}]}}}}}}


Line length

codeclimate · 2023-10-08T15:39:35Z

docs/user/servers/lib/LIB-MS.md

+    Content-Type: application/json
+    Content-Length: 217
+    {
+      "query":"query {\n  readFile(path: \"user2/data/welcome.txt\") {\n    repository {\n      blobs {\n        nodes {\n          name\n          rawBlob\n          rawTextBlob\n        }\n      }\n    }\n  }\n}"


Line length

codeclimate · 2023-10-08T15:39:35Z

docs/user/servers/lib/LIB-MS.md

+    Content-Type: application/json; charset=utf-8
+    Date: Wed, 27 Sep 2023 09:17:18 GMT
+    X-Powered-By: Express
+    {"data":{"readFile":{"repository":{"blobs":{"nodes":[{"name":"welcome.txt","rawBlob":"hello world","rawTextBlob":"hello world"}]}}}}}


Line length

codeclimate · 2023-10-08T15:39:35Z

docs/user/servers/lib/LIB-MS.md

-X-Powered-By: Express
-{"data":{"listDirectory":{"repository":{"tree":{"blobs":{"edges":[]},"trees":{"edges":[{"node":{"name":"data","type":"tree"}},{"node":{"name":"digital twins","type":"tree"}},{"node":{"name":"functions","type":"tree"}},{"node":{"name":"models","type":"tree"}},{"node":{"name":"tools","type":"tree"}}]}}}}}}
-```
+    ``` http-response


Code block style

codeclimate · 2023-10-08T17:26:12Z

docs/user/servers/lib/LIB-MS.md

-          name
-          rawBlob
-          rawTextBlob
+    ```graphql-request


Code block style

codeclimate · 2023-10-08T17:26:12Z

docs/user/servers/lib/LIB-MS.md

-X-Powered-By: Express
-{"data":{"readFile":{"repository":{"blobs":{"nodes":[{"name":"welcome.txt","rawBlob":"hello world","rawTextBlob":"hello world"}]}}}}}
-```
+    ```http-response


Code block style

codeclimate · 2023-10-08T17:26:12Z

docs/FAQ.md

-Azure services or third-party services to get the kind of capabilities
-that GE Predix natively provides in one interface.
-The takeaway is that we pick horses for the courses.
+    The fundamental confusion comes from the fact that different DT platforms


Code block style

codeclimate · 2023-10-09T11:25:04Z

docs/admin/trial.md

+
+### Gitlab OAuth application
+
+The DTaaS react website requires Gitlab OAuth provider. 


Trailing spaces

codeclimate · 2023-10-09T11:29:25Z

Code Climate has analyzed commit cc6530b and detected 23 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Style	23

View more on Code Climate.

prasadtalasila requested a review from nichlaes October 4, 2023 06:38

codeclimate bot reviewed Oct 4, 2023

View reviewed changes

codeclimate bot reviewed Oct 7, 2023

View reviewed changes

codeclimate bot reviewed Oct 8, 2023

View reviewed changes

prasadtalasila added 7 commits October 8, 2023 16:21

Updates scripts for vagrant base box

55f45e5

Updates install scripts and READMEs

4e25685

Fixes formatting mistakes in docs

736330d

Updates docs

aa9ada6

Fixes codeclimate issues

e632c3b

Disable rule for markdownlint

175b097

Fix codeclimate issue

1bfa2b5

prasadtalasila force-pushed the update-install-scripts branch from cb1e8fd to 1bfa2b5 Compare October 8, 2023 14:22

codeclimate bot reviewed Oct 8, 2023

View reviewed changes

prasadtalasila added 2 commits October 8, 2023 17:16

Reverts markdownlint config

9dec00a

Cleans up more markdownlint errors

6e82be9

codeclimate bot reviewed Oct 8, 2023

View reviewed changes

prasadtalasila added 2 commits October 8, 2023 19:22

Completes the single script install and corresponding documentation

8903448

Reverts markdown lint ignore variable

16287ff

codeclimate bot reviewed Oct 8, 2023

View reviewed changes

prasadtalasila added 4 commits October 8, 2023 21:26

Updates install scripts

1990e87

Improves install scripts and docs

b3941ea

fix mistakes in scripts

fe20d71

Cleans up OAuth explanation in docs

ea08075

codeclimate bot reviewed Oct 9, 2023

View reviewed changes

docs/admin/trial.md Outdated

### Gitlab OAuth application

The DTaaS react website requires Gitlab OAuth provider.

Copy link

codeclimate bot Oct 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trailing spaces

fix markdownlint issue

cc6530b

prasadtalasila merged commit 10b4924 into INTO-CPS-Association:feature/distributed-demo Oct 9, 2023

prasadtalasila mentioned this pull request Oct 9, 2023

Update install scripts #119

Closed

prasadtalasila deleted the update-install-scripts branch October 9, 2023 13:11


		## Installed Software
		* Provide cross-platform installation of the DTaaS application. Any operating


		### Gitlab OAuth application

		The DTaaS react website requires Gitlab OAuth provider.

Updates install scripts #150

Updates install scripts #150

Conversation

prasadtalasila commented Oct 4, 2023 • edited Loading

codeclimate bot Oct 4, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 4, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 4, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 4, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 4, 2023

Choose a reason for hiding this comment

prasadtalasila commented Oct 4, 2023 • edited Loading

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codecov-commenter commented Oct 7, 2023 • edited Loading

Codecov Report

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

prasadtalasila Oct 7, 2023

Choose a reason for hiding this comment

astitva1905 Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

astitva1905 commented Oct 7, 2023 via email

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 7, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

codeclimate bot Oct 8, 2023

Choose a reason for hiding this comment

prasadtalasila commented Oct 4, 2023 •

edited

Loading

prasadtalasila commented Oct 4, 2023 •

edited

Loading

codecov-commenter commented Oct 7, 2023 •

edited

Loading