Auto-deploy docs built from commit 0e2a346

COVESA · Apr 3, 2024 · dd1b095 · dd1b095
1 parent b94370a
commit dd1b095
Show file tree

Hide file tree

Showing 17 changed files with 374 additions and 263 deletions.
diff --git a/docs-gen/assets/Apache-IoTDB-feature-summary.drawio.svg b/docs-gen/assets/Apache-IoTDB-feature-summary.drawio.svg
diff --git a/docs-gen/content/overview/cdsp-implementation-concept.md b/docs-gen/content/overview/cdsp-implementation-concept.md
@@ -3,20 +3,70 @@ title: "Playground implementation"
 weight: 30
 ---
 
-{{% notice warning %}}
-This placeholder text comes from the Playground Proposal and will be replaced with a fuller discussion of the implementation
-{{% /notice %}}
 
-## Implementation Concepts
+The prior section describing the logical concept should be read to understand the concepts to be implemented. 
 
-The logical section above should be read to understand the concepts to be implemented. This section suggests starting points for discussion in the community.
-Initial idea for the Central Data Service
+As outlined in the logical description, as a starting point the Service is realized as a basic building block combining VISS Data Server with highly functional (VSS) Data Store.
 
-As outlined in the logical description, as a starting point the Service could be realised as a basic building block combining VISS Data Server with highly functional VSS Data Store. The availability of generic code allows flexible deployment to meet the two high level implementation needs to support easy development trials, whilst also supporting investigation closer to production, including a path to production.
+### VISS data server
+The reference implementation for the COVESA VISS specification is developed in the [VISSR](https://github.com/COVESA/vissr) project.
+The playground has included VISSR to provide its northbound VISS support.
 
-Initial idea/sketch for base building block:
- - Generic code: VISS Data Server with VSS Data Store backend
-   - Data Architecture requirements: Add Apache IotDB (Apache eco-system, embedded and UDF) and Realm (embedded, sync) as backends to enable research.
-   - Example using WAII VISS Data Protocol Server, which supports historical data and has a data store backend and various embedded databases:
- - Deployment 1 - Easy to develop (assumed first target): x86 host Docker containers
- - Deployment 2 - Closer to production (assumed second target): ARM64 using common automotive deployment, e.g. Yocto Linux.
+Alongside the VISS server the VISSR project provides clients, feeders and tooling Further details can be found in the upstream [VISSR documentation site](https://covesa.github.io/vissr/).
+
+During initial development of the playground the upstream VISSR project supported using SQLite, Redis or memcached databases as its data store.
+
+### Highly functional (VSS) data store
+As explained earlier in the [logical concept]({{< ref "cdsp-logical-concept.md/#components" >}} "data store logical description") the playground includes the use of highly functional VSS data stores to expand the available data processing possibilities. Two archetypes were considered:
+1. Database server with timeseries capabilities
+2. Application database
+
+The OSS Apache IoTDB project was selected for the database server archetype for reasons explained in the [section](#apache-iotdb) below.
+
+To enable access to VSS data stored in IoTDB using the VISS protocol the playground project extended VISSR to support IoTDB as one of its supported data store backends. That support was upstreamed and merged.
+
+For the application database archetype MongoDB Realm was selected. Support for it is currently a work in progress as part of the playground project backlog.
+
+#### Apache IoTDB
+
+The Apache IoTDB [project page](https://iotdb.apache.org/) describes IoTDB as:
+
+_"Apache IoTDB (Database for Internet of Things) is an IoT native database with high performance for data management and analysis, deployable on the edge and the cloud. Due to its light-weight architecture, high performance and rich feature set together with its deep integration with Apache Hadoop, Spark and Flink, Apache IoTDB can meet the requirements of massive data storage, high-speed data ingestion and complex data analysis in the IoT industrial fields."_
+
+The diagram below summarizes some of the features that make it an attractive addition to the playground.
+
+{{< figure src="Apache-IoTDB-feature-summary.drawio.svg" title="Summary of Apache IoTDB features" width=50pc >}}
+
++ The focus on timeseries IoT data delivering high throughput, with low latency are a good fit with the automotive domain. The availability of a single node (Edge) server build is critical for in-vehicle investigations and is supported by the existence of a cluster build for the cloud if needed.
+
++ Its support for client server, event and streaming data architectures allows for flexible operation using a single solution.
+
++ It also has very wide API support that greatly enhances the pluggability of the data store into other components, whilst supporting the playground project goal of loose coupling.
+
++ Similarly the wide range of integrations into other tools and frameworks, particularly the Apache big data stack, simplifies the integration of VSS and associated data into data-centric workflows.
+
++ IoTDB has a wide range of built-in timeseries data processing and analysis functions covering topics such as data quality, profiling, repair, anomaly detection and series discovery. For example, in-vehicle data analysis can be performed to derive some information or knowledge and then data reduced for further processing in the cloud.
+
++ As well as Native APIs IoTDB also supports a SQL-like query language. This supports the describing of work in logical terms that affords some portability to other solutions.
+
+## Deployment
+The project is currently targeting two deployment scenarios:
+1. Easy to develop: make it easy to build, modify and trial by providing a containerized instance running on a host using [Docker containers](https://www.docker.com/).
+2. Closer to production: the same base code should be deployable to systems closer to production, including on automotive hardware (or its simulation), e.g. [Yocto](https://www.yoctoproject.org/), container orchestration, [Service-orientated architecture (SOA)](https://en.wikipedia.org/wiki/Service-oriented_architecture) etc.
+
+Docker containers are chosen to facilitate the rapid integration and/or swapping of technology options. Be it internals of the playground itself, or connection to other components. For example, users can easily integrate the playground into their own [docker compose](https://docs.docker.com/compose/) containing other components.
+
+#### Status
+The containerized docker deployment is available. Deployment on automotive hardware is currently not but is part of the project backlog.
+
+### Host based Docker
+
+The playground provides docker compose files to deploy the playground using docker images. The deployment contains three main services, for Apache IoTDB, VISSR and Redis.
+
+Please see the playground docker readme.md in the source tree for details.
+
+The service definitions are based on the upstream compose files from the IoTDB and VISSR projects.
+
+### Automotive hardware
+
+The project will provide information as hardware deployment progresses.
diff --git a/docs-gen/content/overview/cdsp-logical-concept.md b/docs-gen/content/overview/cdsp-logical-concept.md
@@ -15,7 +15,7 @@ Of course it is perfectly normal that in _using_ the playground to develop an id
 ### Problem
 OEMs have presented various open questions and requirements in tackling growing software complexity. One representative list appears below.
 
-Key questions for a End-to-End Data Architecture:
+"Key questions for a End-to-End Data Architecture:
 - How data can be shared between all touchpoints?
 - How different domains of data share same tech
 stack?
@@ -30,9 +30,9 @@ and privacy?
 - How to handle multiple sync endpoints?
 - How to handle unidirectional data streams?
 - How (new) knowledge ...
-- ... can be shared with others?
+- ... can be shared with others?"
 
-Source: [_"Building Bridges with a common Data Middleware"_, BMW AG, COVESA Autumn 2023 AMM](https://wiki.covesa.global/download/attachments/78840403/COVESA_DataMiddleware-PoC-Status_v2.pdf?version=1&modificationDate=1698737955726&api=v2)
+Source: [_"Building Bridges with a common Data Middleware"_, OEM, COVESA Autumn 2023 AMM](https://wiki.covesa.global/download/attachments/78840403/COVESA_DataMiddleware-PoC-Status_v2.pdf?version=1&modificationDate=1698737955726&api=v2)
 
 At the same time there has been a realization that some problems require open collaboration.
 

diff --git a/docs/404.html b/docs/404.html
@@ -9,15 +9,15 @@
   <title>404 Page not found</title>
 
 
-    <link href="/cdsp/css/nucleus.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/fontawesome-all.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/hybrid.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/featherlight.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/perfect-scrollbar.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/theme.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/hugo-theme.css?1711477459" rel="stylesheet">
+    <link href="/cdsp/css/nucleus.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/fontawesome-all.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/hybrid.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/featherlight.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/perfect-scrollbar.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/theme.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/hugo-theme.css?1712104441" rel="stylesheet">
 
-      <link href="/cdsp/css/theme-blue.css?1711477459" rel="stylesheet">
+      <link href="/cdsp/css/theme-blue.css?1712104441" rel="stylesheet">
 
 <style>
     :root #header + #content > #left > #rlblock_left {

diff --git a/docs/Apache-IoTDB-feature-summary.drawio.svg b/docs/Apache-IoTDB-feature-summary.drawio.svg
diff --git a/docs/categories/index.html b/docs/categories/index.html
@@ -12,21 +12,21 @@
     <title>Categories :: Central Data Service Playground</title>
 
 
-    <link href="/cdsp/css/nucleus.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/fontawesome-all.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/hybrid.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/featherlight.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/perfect-scrollbar.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/auto-complete.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/atom-one-dark-reasonable.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/theme.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/hugo-theme.css?1711477459" rel="stylesheet">
+    <link href="/cdsp/css/nucleus.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/fontawesome-all.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/hybrid.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/featherlight.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/perfect-scrollbar.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/auto-complete.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/atom-one-dark-reasonable.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/theme.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/hugo-theme.css?1712104441" rel="stylesheet">
 
-    <link href="/cdsp/css/theme-blue.css?1711477459" rel="stylesheet">
+    <link href="/cdsp/css/theme-blue.css?1712104441" rel="stylesheet">
 
 
 
-    <script src="/cdsp/js/jquery-3.3.1.min.js?1711477459"></script>
+    <script src="/cdsp/js/jquery-3.3.1.min.js?1712104441"></script>
 
     <style>
       :root #header + #content > #left > #rlblock_left{
@@ -59,14 +59,14 @@
     <span data-search-clear=""><i class="fas fa-times"></i></span>
 </div>
 
-<script type="text/javascript" src="/cdsp/js/lunr.min.js?1711477459"></script>
-<script type="text/javascript" src="/cdsp/js/auto-complete.js?1711477459"></script>
+<script type="text/javascript" src="/cdsp/js/lunr.min.js?1712104441"></script>
+<script type="text/javascript" src="/cdsp/js/auto-complete.js?1712104441"></script>
 <script type="text/javascript">
 
         var baseurl = "https:\/\/covesa.github.io\/cdsp\/";
 
 </script>
-<script type="text/javascript" src="/cdsp/js/search.js?1711477459"></script>
+<script type="text/javascript" src="/cdsp/js/search.js?1712104441"></script>
 
 
   </div>
@@ -467,19 +467,19 @@ <h1>
     <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
       <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
     </div>
-    <script src="/cdsp/js/clipboard.min.js?1711477459"></script>
-    <script src="/cdsp/js/perfect-scrollbar.min.js?1711477459"></script>
-    <script src="/cdsp/js/perfect-scrollbar.jquery.min.js?1711477459"></script>
-    <script src="/cdsp/js/jquery.sticky.js?1711477459"></script>
-    <script src="/cdsp/js/featherlight.min.js?1711477459"></script>
-    <script src="/cdsp/js/highlight.pack.js?1711477459"></script>
+    <script src="/cdsp/js/clipboard.min.js?1712104441"></script>
+    <script src="/cdsp/js/perfect-scrollbar.min.js?1712104441"></script>
+    <script src="/cdsp/js/perfect-scrollbar.jquery.min.js?1712104441"></script>
+    <script src="/cdsp/js/jquery.sticky.js?1712104441"></script>
+    <script src="/cdsp/js/featherlight.min.js?1712104441"></script>
+    <script src="/cdsp/js/highlight.pack.js?1712104441"></script>
     <script>hljs.initHighlightingOnLoad();</script>
-    <script src="/cdsp/js/modernizr.custom-3.6.0.js?1711477459"></script>
-    <script src="/cdsp/js/learn.js?1711477459"></script>
-    <script src="/cdsp/js/hugo-learn.js?1711477459"></script>
+    <script src="/cdsp/js/modernizr.custom-3.6.0.js?1712104441"></script>
+    <script src="/cdsp/js/learn.js?1712104441"></script>
+    <script src="/cdsp/js/hugo-learn.js?1712104441"></script>
 
 
-            <script src="/cdsp/mermaid/mermaid.js?1711477459"></script>
+            <script src="/cdsp/mermaid/mermaid.js?1712104441"></script>
 
         <script>
             mermaid.initialize({ startOnLoad: true });

diff --git a/docs/examples/index.html b/docs/examples/index.html
@@ -12,21 +12,21 @@
     <title>Playground examples :: Central Data Service Playground</title>
 
 
-    <link href="/cdsp/css/nucleus.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/fontawesome-all.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/hybrid.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/featherlight.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/perfect-scrollbar.min.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/auto-complete.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/atom-one-dark-reasonable.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/theme.css?1711477459" rel="stylesheet">
-    <link href="/cdsp/css/hugo-theme.css?1711477459" rel="stylesheet">
+    <link href="/cdsp/css/nucleus.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/fontawesome-all.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/hybrid.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/featherlight.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/perfect-scrollbar.min.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/auto-complete.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/atom-one-dark-reasonable.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/theme.css?1712104441" rel="stylesheet">
+    <link href="/cdsp/css/hugo-theme.css?1712104441" rel="stylesheet">
 
-    <link href="/cdsp/css/theme-blue.css?1711477459" rel="stylesheet">
+    <link href="/cdsp/css/theme-blue.css?1712104441" rel="stylesheet">
 
 
 
-    <script src="/cdsp/js/jquery-3.3.1.min.js?1711477459"></script>
+    <script src="/cdsp/js/jquery-3.3.1.min.js?1712104441"></script>
 
     <style>
       :root #header + #content > #left > #rlblock_left{
@@ -59,14 +59,14 @@
     <span data-search-clear=""><i class="fas fa-times"></i></span>
 </div>
 
-<script type="text/javascript" src="/cdsp/js/lunr.min.js?1711477459"></script>
-<script type="text/javascript" src="/cdsp/js/auto-complete.js?1711477459"></script>
+<script type="text/javascript" src="/cdsp/js/lunr.min.js?1712104441"></script>
+<script type="text/javascript" src="/cdsp/js/auto-complete.js?1712104441"></script>
 <script type="text/javascript">
 
         var baseurl = "https:\/\/covesa.github.io\/cdsp\/";
 
 </script>
-<script type="text/javascript" src="/cdsp/js/search.js?1711477459"></script>
+<script type="text/javascript" src="/cdsp/js/search.js?1712104441"></script>
 
 
   </div>
@@ -512,19 +512,19 @@ <h2 id="other-examples">Other examples</h2>
     <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
       <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
     </div>
-    <script src="/cdsp/js/clipboard.min.js?1711477459"></script>
-    <script src="/cdsp/js/perfect-scrollbar.min.js?1711477459"></script>
-    <script src="/cdsp/js/perfect-scrollbar.jquery.min.js?1711477459"></script>
-    <script src="/cdsp/js/jquery.sticky.js?1711477459"></script>
-    <script src="/cdsp/js/featherlight.min.js?1711477459"></script>
-    <script src="/cdsp/js/highlight.pack.js?1711477459"></script>
+    <script src="/cdsp/js/clipboard.min.js?1712104441"></script>
+    <script src="/cdsp/js/perfect-scrollbar.min.js?1712104441"></script>
+    <script src="/cdsp/js/perfect-scrollbar.jquery.min.js?1712104441"></script>
+    <script src="/cdsp/js/jquery.sticky.js?1712104441"></script>
+    <script src="/cdsp/js/featherlight.min.js?1712104441"></script>
+    <script src="/cdsp/js/highlight.pack.js?1712104441"></script>
     <script>hljs.initHighlightingOnLoad();</script>
-    <script src="/cdsp/js/modernizr.custom-3.6.0.js?1711477459"></script>
-    <script src="/cdsp/js/learn.js?1711477459"></script>
-    <script src="/cdsp/js/hugo-learn.js?1711477459"></script>
+    <script src="/cdsp/js/modernizr.custom-3.6.0.js?1712104441"></script>
+    <script src="/cdsp/js/learn.js?1712104441"></script>
+    <script src="/cdsp/js/hugo-learn.js?1712104441"></script>
 
 
-            <script src="/cdsp/mermaid/mermaid.js?1711477459"></script>
+            <script src="/cdsp/mermaid/mermaid.js?1712104441"></script>
 
         <script>
             mermaid.initialize({ startOnLoad: true });