docs for 18e8fc8 commit

INTO-CPS-Association · Nov 25, 2023 · aec6f6a · aec6f6a
1 parent b07225c
commit aec6f6a
Show file tree

Hide file tree

Showing 13 changed files with 699 additions and 47 deletions.
diff --git a/DTaaS-development.pdf b/DTaaS-development.pdf
diff --git a/development/admin/guides/add_service.html b/development/admin/guides/add_service.html
@@ -1477,7 +1477,8 @@ <h1 id="add-other-services">Add other services</h1>
 <span class="normal"><a href="#__codelineno-1-42">42</a></span>
 <span class="normal"><a href="#__codelineno-1-43">43</a></span>
 <span class="normal"><a href="#__codelineno-1-44">44</a></span>
-<span class="normal"><a href="#__codelineno-1-45">45</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="ch">#!/usr/bin/node</span>
+<span class="normal"><a href="#__codelineno-1-45">45</a></span>
+<span class="normal"><a href="#__codelineno-1-46">46</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="ch">#!/usr/bin/node</span>
 </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a><span class="cm">/* Install the optional platform services for DTaaS */</span>
 </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">$</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;execa&quot;</span><span class="p">;</span>
 </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4"></a><span class="k">import</span><span class="w"> </span><span class="nx">chalk</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s2">&quot;chalk&quot;</span><span class="p">;</span>
@@ -1516,12 +1517,13 @@ <h1 id="add-other-services">Add other services</h1>
 </span><span id="__span-1-37"><a id="__codelineno-1-37" name="__codelineno-1-37"></a>
 </span><span id="__span-1-38"><a id="__codelineno-1-38" name="__codelineno-1-38"></a><span class="nx">log</span><span class="p">(</span><span class="nx">chalk</span><span class="p">.</span><span class="nx">green</span><span class="p">(</span><span class="s2">&quot;Start new Mongodb server docker container&quot;</span><span class="p">));</span>
 </span><span id="__span-1-39"><a id="__codelineno-1-39" name="__codelineno-1-39"></a><span class="k">await</span><span class="w"> </span><span class="nx">$$</span><span class="sb">`docker run -d -p </span><span class="si">${</span><span class="nx">mongodbConfig</span><span class="p">.</span><span class="nx">port</span><span class="si">}</span><span class="sb">:27017 \</span>
-</span><span id="__span-1-40"><a id="__codelineno-1-40" name="__codelineno-1-40"></a><span class="sb">--name mongodb \</span>
-</span><span id="__span-1-41"><a id="__codelineno-1-41" name="__codelineno-1-41"></a><span class="sb">-v </span><span class="si">${</span><span class="nx">mongodbConfig</span><span class="p">.</span><span class="nx">datapath</span><span class="si">}</span><span class="sb">:/data/db \</span>
-</span><span id="__span-1-42"><a id="__codelineno-1-42" name="__codelineno-1-42"></a><span class="sb">-e MONGO_INITDB_ROOT_USERNAME=</span><span class="si">${</span><span class="nx">mongodbConfig</span><span class="p">.</span><span class="nx">username</span><span class="si">}</span><span class="sb"> \</span>
-</span><span id="__span-1-43"><a id="__codelineno-1-43" name="__codelineno-1-43"></a><span class="sb">-e MONGO_INITDB_ROOT_PASSWORD=</span><span class="si">${</span><span class="nx">mongodbConfig</span><span class="p">.</span><span class="nx">password</span><span class="si">}</span><span class="sb"> \</span>
-</span><span id="__span-1-44"><a id="__codelineno-1-44" name="__codelineno-1-44"></a><span class="sb">mongo:7.0.3`</span><span class="p">;</span>
-</span><span id="__span-1-45"><a id="__codelineno-1-45" name="__codelineno-1-45"></a><span class="nx">log</span><span class="p">(</span><span class="nx">chalk</span><span class="p">.</span><span class="nx">green</span><span class="p">(</span><span class="s2">&quot;MongoDB server docker container started successfully&quot;</span><span class="p">));</span>
+</span><span id="__span-1-40"><a id="__codelineno-1-40" name="__codelineno-1-40"></a><span class="sb">  --name mongodb \</span>
+</span><span id="__span-1-41"><a id="__codelineno-1-41" name="__codelineno-1-41"></a><span class="sb">  -v </span><span class="si">${</span><span class="nx">mongodbConfig</span><span class="p">.</span><span class="nx">datapath</span><span class="si">}</span><span class="sb">:/data/db \</span>
+</span><span id="__span-1-42"><a id="__codelineno-1-42" name="__codelineno-1-42"></a><span class="sb">  -e MONGO_INITDB_ROOT_USERNAME=</span><span class="si">${</span><span class="nx">mongodbConfig</span><span class="p">.</span><span class="nx">username</span><span class="si">}</span><span class="sb"> \</span>
+</span><span id="__span-1-43"><a id="__codelineno-1-43" name="__codelineno-1-43"></a><span class="sb">  -e MONGO_INITDB_ROOT_PASSWORD=</span><span class="si">${</span><span class="nx">mongodbConfig</span><span class="p">.</span><span class="nx">password</span><span class="si">}</span><span class="sb"> \</span>
+</span><span id="__span-1-44"><a id="__codelineno-1-44" name="__codelineno-1-44"></a><span class="sb">  --restart always \</span>
+</span><span id="__span-1-45"><a id="__codelineno-1-45" name="__codelineno-1-45"></a><span class="sb">  mongo:7.0.3`</span><span class="p">;</span>
+</span><span id="__span-1-46"><a id="__codelineno-1-46" name="__codelineno-1-46"></a><span class="nx">log</span><span class="p">(</span><span class="nx">chalk</span><span class="p">.</span><span class="nx">green</span><span class="p">(</span><span class="s2">&quot;MongoDB server docker container started successfully&quot;</span><span class="p">));</span>
 </span></code></pre></div></td></tr></table></div>
 <p><strong>3. Run the script:</strong></p>
 <p>Go to the directory <code>/deploy/services/</code>

diff --git a/development/admin/host.html b/development/admin/host.html
@@ -1631,7 +1631,9 @@ <h3 id="traefik-gateway-server">Traefik gateway server</h3>
 <h4 id="authentication">Authentication</h4>
 <p>This step requires <code>htpasswd</code> commandline utility. If
 it is not available on your system, please install the same by using</p>
-<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>apache2-utils
+<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
+<span class="normal"><a href="#__codelineno-0-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>update
+</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>apache2-utils
 </span></code></pre></div></td></tr></table></div>
 <p>You can now proceed with update of the gateway authentication setup.
 The dummy username is <code>foo</code> and the password is <code>bar</code>.

diff --git a/development/admin/services.html b/development/admin/services.html
@@ -1499,6 +1499,10 @@ <h2 id="use">Use</h2>
 <td align="left">MQTT Broker</td>
 <td align="left">services.foo.com:1883</td>
 </tr>
+<tr>
+<td align="left">MongoDB database</td>
+<td align="left">services.foo.com:27017</td>
+</tr>
 </tbody>
 </table>
 <p>The firewall and network access settings of corporate / cloud network need to be

diff --git a/development/admin/vagrant/basebox.png b/development/admin/vagrant/basebox.png
diff --git a/development/admin/vagrant/single-machine.png b/development/admin/vagrant/single-machine.png
diff --git a/development/admin/vagrant/two-machine-use-legend.png b/development/admin/vagrant/two-machine-use-legend.png
diff --git a/development/admin/vagrant/two-machine.png b/development/admin/vagrant/two-machine.png
diff --git a/development/admin/vagrant/two-machines.html b/development/admin/vagrant/two-machines.html
@@ -1580,28 +1580,28 @@ <h3 id="launch-dtaas-platform-default-services">Launch DTaaS Platform Default Se
 </thead>
 <tbody>
 <tr>
-<td align="left">InfluxDB and visualization service</td>
+<td align="left">InfluxDB database</td>
 <td align="left">services.foo.com</td>
 </tr>
 <tr>
 <td align="left">Grafana visualization service</td>
 <td align="left">services.foo.com:3000</td>
 </tr>
 <tr>
-<td align="left">MQTT communication service</td>
+<td align="left">MQTT Broker</td>
 <td align="left">services.foo.com:1883</td>
 </tr>
 <tr>
-<td align="left">RabbitMQ communication service</td>
+<td align="left">RabbitMQ Broker</td>
 <td align="left">services.foo.com:5672</td>
 </tr>
 <tr>
-<td align="left">RabbitMQ management service</td>
+<td align="left">RabbitMQ Broker management website</td>
 <td align="left">services.foo.com:15672</td>
 </tr>
 <tr>
-<td align="left"></td>
-<td align="left"></td>
+<td align="left">MongoDB database</td>
+<td align="left">services.foo.com:27017</td>
 </tr>
 </tbody>
 </table>

diff --git a/development/developer/system/DTaaS.drawio b/development/developer/system/DTaaS.drawio
diff --git a/development/search/search_index.json b/development/search/search_index.json
diff --git a/development/sitemap.xml.gz b/development/sitemap.xml.gz
diff --git a/development/user/examples/incubator/index.html b/development/user/examples/incubator/index.html
@@ -1368,9 +1368,13 @@ <h1 id="incubator-demo">Incubator Demo</h1>
 </span></code></pre></div></td></tr></table></div>
 <div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1">1</a></span>
 <span class="normal"><a href="#__codelineno-2-2">2</a></span>
-<span class="normal"><a href="#__codelineno-2-3">3</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>--name<span class="w"> </span>rabbitmq-server<span class="w"> </span>-p<span class="w"> </span><span class="m">15672</span>:15672<span class="w"> </span>-p<span class="w"> </span><span class="m">5672</span>:5672<span class="w"> </span>rabbitmq:3-management
-</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2"></a>docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>rabbitmq-server<span class="w"> </span>rabbitmqctl<span class="w"> </span>add_user<span class="w"> </span>incubator<span class="w"> </span>incubator
-</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3"></a>docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>rabbitmq-server<span class="w"> </span>rabbitmqctl<span class="w"> </span>set_permissions<span class="w"> </span>-p<span class="w"> </span><span class="s2">&quot;/&quot;</span><span class="w"> </span>incubator<span class="w"> </span><span class="s2">&quot;.*&quot;</span><span class="w"> </span><span class="s2">&quot;.*&quot;</span><span class="w"> </span><span class="s2">&quot;.*&quot;</span>
+<span class="normal"><a href="#__codelineno-2-3">3</a></span>
+<span class="normal"><a href="#__codelineno-2-4">4</a></span>
+<span class="normal"><a href="#__codelineno-2-5">5</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>--name<span class="w"> </span>rabbitmq-server<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2"></a><span class="w">  </span>--restart<span class="w"> </span>always<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3"></a><span class="w">  </span>-p<span class="w"> </span><span class="m">15672</span>:15672<span class="w"> </span>-p<span class="w"> </span><span class="m">5672</span>:5672<span class="w"> </span>rabbitmq:3-management
+</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4"></a>docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>rabbitmq-server<span class="w"> </span>rabbitmqctl<span class="w"> </span>add_user<span class="w"> </span>incubator<span class="w"> </span>incubator
+</span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5"></a>docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>rabbitmq-server<span class="w"> </span>rabbitmqctl<span class="w"> </span>set_permissions<span class="w"> </span>-p<span class="w"> </span><span class="s2">&quot;/&quot;</span><span class="w"> </span>incubator<span class="w"> </span><span class="s2">&quot;.*&quot;</span><span class="w"> </span><span class="s2">&quot;.*&quot;</span><span class="w"> </span><span class="s2">&quot;.*&quot;</span>
 </span></code></pre></div></td></tr></table></div>
 <p>Access InfluxDB running on another machine.
 Remember that InfluxDB works only on a distinct sub-domain