Updating Database Model (Quality Model, Adapatation Plan) (#7)

* Data models for Metrics. * Fixing the type of the primary key of the Quality Model * JSON files with the formats of the messages * Updating diagrams of the data models (metrics)
nmsa · Oct 26, 2018 · 925fd92 · 925fd92
1 parent dc4aa3f
commit 925fd92
Show file tree

Hide file tree

Showing 28 changed files with 74 additions and 4 deletions.
diff --git a/architecture/TMA-Framework.asta b/architecture/TMA-Framework.asta
diff --git a/architecture/diagrams/TMA-A/TMA-A_Architecture.jpg b/architecture/diagrams/TMA-A/TMA-A_Architecture.jpg
diff --git a/architecture/diagrams/TMA-A/TMA-A_Architecture.png b/architecture/diagrams/TMA-A/TMA-A_Architecture.png
diff --git a/architecture/diagrams/TMA-E/TMA-E_Actuation.jpg b/architecture/diagrams/TMA-E/TMA-E_Actuation.jpg
diff --git a/architecture/diagrams/TMA-E/TMA-E_Actuation.png b/architecture/diagrams/TMA-E/TMA-E_Actuation.png
diff --git a/architecture/diagrams/TMA-E/TMA-E_Actuator_ClassDiagram.jpg b/architecture/diagrams/TMA-E/TMA-E_Actuator_ClassDiagram.jpg
diff --git a/architecture/diagrams/TMA-E/TMA-E_Actuator_ClassDiagram.png b/architecture/diagrams/TMA-E/TMA-E_Actuator_ClassDiagram.png
diff --git a/architecture/diagrams/TMA-E/TMA-E_Registration.jpg b/architecture/diagrams/TMA-E/TMA-E_Registration.jpg
diff --git a/architecture/diagrams/TMA-E/TMA-E_Registration.png b/architecture/diagrams/TMA-E/TMA-E_Registration.png
diff --git a/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Actuators.png b/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Actuators.png
diff --git a/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Measurements.png b/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Measurements.png
diff --git a/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Metrics.jpg b/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Metrics.jpg
diff --git a/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Metrics.png b/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Metrics.png
diff --git a/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Planning.jpg b/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Planning.jpg
diff --git a/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Planning.png b/architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Planning.png
diff --git a/architecture/diagrams/TMA-M/TMA-M_sequence.jpg b/architecture/diagrams/TMA-M/TMA-M_sequence.jpg
diff --git a/architecture/diagrams/TMA-M/TMA-M_sequence.png b/architecture/diagrams/TMA-M/TMA-M_sequence.png
diff --git a/architecture/diagrams/TMA-Platform_Architecture.png b/architecture/diagrams/TMA-Platform_Architecture.png
diff --git a/architecture/diagrams/TMA-Platform_Detailed_Architecture.png b/architecture/diagrams/TMA-Platform_Detailed_Architecture.png
diff --git a/documents/README.md b/documents/README.md
@@ -0,0 +1,27 @@
+#  Trustworthiness Monitoring &amp; Assessment Framework
+
+The communication between the components from the `MAPE-K` is done mainly by the `FaultTolerantQueue`, according to the [figure below](../architecture/diagrams/TMA-Platform_Detailed_Architecture.jpg).
+
+*![High level architecture of TMA Framework](../architecture/diagrams/TMA-Platform_Detailed_Architecture.jpg) Architecture and interfaces of the trustworthiness platform.*
+
+The [`TMA_Analyze`](#tma_analyze) component is responsible for continuously listening to the `TMA_Knowledge` microservice, calculate the trustworthiness scores and, store them on the database. An item is added to the `planning` queue from the `FaultTolerantQueue` in order to the [`TMA_Planning`](#tma_planning) starts checking the rules. The format of the message is a [JSON](interface/atmosphere_tma-p_schema.json) according to the image below:
+
+*![JSON Format read by TMA_Planning](interface/atmosphere_tma-p_schema.png) Format of the JSON message to be read by the TMA_Planning component*
+
+The `metricId` indicates that a new value for the corresponding metric was calculated and stored in the database, in the moment stored on `timestamp`.
+
+The [`TMA_Planning`](#tma_planning) microservice is responsible for executing the verification rules that will produce a set of adaptations that will be consolidated in an "adaptation plan" to achieve the required goals, or to recover the desired levels of trustworthiness. This is done by continuously polling the messages from the `planning` queue. If an adaptation is needed, an "adaptation plan" is stored in the database with the set of actions. 
+
+*![Conceptual Data Model used by the Planning component](../architecture/diagrams/TMA-K_DataModel/TMAF-K_ConceptualDataModel_Planning.jpg) Conceptual Data Model used by the Planning component.*
+
+An adaptation plan is stored in the `Plan` table, and it is always related to the `MetricData` that dispatched the adapation. The set of actions and the order of execution is stored in the `ActionPlan` table, and it is related to an `Action`, which will be performed by the correspondent `Actuator`. In case the actions need parameters, their values are stored in the `ConfigurationData` table.
+
+The communication of [`TMA_Planning`](#tma_planning) is done by the `execute` queue, which will receive a [JSON](interface/atmosphere_tma-e_schema.json) message with the plan identifier.
+
+*![JSON Format read by TMA_Execute](interface/atmosphere_tma-e_schema.png) Format of the JSON message to be read by the TMA_Execute component*
+
+Finally, the [`TMA_Execute`](#tma_execute) microservice runs the adaptation plan using the deployed actuators on the target layers. This component is continuously polling the messages from the `execute` queue. When a plan is added, the list of actions is obtained from the [`TMA_Knowledge`](#tma_knowledge), with the order of execution and the parameters values.
+
+(nmsa: CHECK IF THIS CONTENT SHOULD REPLACE THE SECTION FROM THE MAIN PAGE)
+
+(REVIEW THE LINKS TO THE SUB-MODULES)
diff --git a/documents/interface/atmosphere_tma-e_schema.json b/documents/interface/atmosphere_tma-e_schema.json
@@ -0,0 +1,18 @@
+{
+    "title": "tma-e_schema_0_1",
+    "$id": "http://atmosphere-eubrazil.eu/tma-e_schema_v0.1.json",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+        "planId": {
+            "$id": "/properties/planId",
+            "type": "integer",
+            "default": -1,
+            "minimum": 0
+        }
+    },
+    "required": [
+        "planId"
+    ]
+}
+
diff --git a/documents/interface/atmosphere_tma-e_schema.png b/documents/interface/atmosphere_tma-e_schema.png
diff --git a/documents/interface/atmosphere_tma-p_schema.json b/documents/interface/atmosphere_tma-p_schema.json
@@ -0,0 +1,25 @@
+{
+    "title": "tma-ac_schema_0_1",
+
+    "$id": "http://atmosphere-eubrazil.eu/tma-_aschema_v0.1.json",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+        "metricId": {
+            "$id": "/properties/metricId",
+            "type": "integer",
+            "default": -1,
+            "minimum": 0
+        },
+        "timestamp": {
+            "$id": "/properties/timestamp",
+            "type": "integer",
+            "default": -1,
+            "minimum": 0
+        }
+    },
+    "required": [
+        "metricId",
+        "timestamp"
+    ]
+}
diff --git a/documents/interface/atmosphere_tma-p_schema.png b/documents/interface/atmosphere_tma-p_schema.png
diff --git a/tma-framework-a b/tma-framework-a
diff --git a/tma-framework-e b/tma-framework-e
diff --git a/tma-framework-k b/tma-framework-k
diff --git a/tma-framework-m b/tma-framework-m