Update README generation

fluidos-project · Mar 18, 2024 · 21dcbc6 · 21dcbc6
2 parents 7fcecb2 + 6c5a4ea
commit 21dcbc6
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 8 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,88 @@
+
+# Flavor
+![0](../models/examples/svg/flavor.svg)
+- **FlavorID**. The unique identifier for a flavor ['string']
+- **ProviderID**. The unique identifier for a provider ['string']
+- **Location**:
+ - **Latitude**. Latitude of the location ['string']
+ - **Longitude**. Longitude of the location ['string']
+ - **Altitude**. Altitude of the location expressed in meters ['string']
+ - **AdditionalNotes**. Additional notes about the location ['string']
+- **NetworkPropertyType**. Type of network property ensured by the privider (e.g., 5G, Wifi, Ethernet) ['string']
+- **FlavorType**. A reference to a specific flavor type schema using JSON references ($ref) to external files like 'k8slice.json', 'vm.json', etc. This allows defining details specific to each flavor type.
+- **Price**:
+ - **Amount**. Amount of the price. ['string']
+ - **Currency**. Currency of the price. ['string']
+ - **Period**. Period of the price. ['string']
+- **Owner**:
+ - **Domain**. Domain of the node. ['string']
+ - **NodeID**. ID of the node. ['string']
+ - **IP**. IP of the node. ['string']
+ - **AdditionalInformation**:
+ - **LiqoID**. Liqo ID of the node. ['string']
+- **OptionalFields**:
+ - **Availability**. Availability flag of the Flavor. ['boolean']
+ - **WorkerID**. ID of the worker that provides the Flavor. ['string']
+# FlavorType
+The FlavorType describes the actual flavor that is adverised.
+## k8slice
+![1](../models/examples/svg/flavor-types/k8slice.svg)
+- **Characteristics**:
+ - **CPU**. The number of CPU cores ['integer']
+ - **Pods**. The number of pods ['integer']
+ - **Memory**. The amount of memory ['integer']
+ - **GPU**. The amount of GPU ['integer']
+ - **Storage**. The amount of storage ['integer']
+ - **SecurityStandards**. Security standards supported by the Flavor (e.g., GDPR). ['array']
+ - **Latency**. The latency of the Flavor. ['integer']
+- **Policy**:
+ - **Aggregatable**:
+ - **MinCount**. Minimum required number of instances of the Flavor. ['integer']
+ - **MaxCount**. Maximum required number of instances of the Flavor. ['integer']
+ - **Partitionable**:
+ - **CpuMin**. Minimum required number of CPU cores of the Flavor. ['integer']
+ - **MemoryMin**. Minimum required amount of RAM of the Flavor. ['integer']
+ - **CpuStep**. Incremental value of CPU cores of the Flavor. ['integer']
+ - **MemoryStep**. Incremental value of RAM of the Flavor. ['integer']
+## service
+![2](../models/examples/svg/flavor-types/service.svg)
+- **Characteristics**:
+ - **Name**. Name of the flavor. ['string']
+ - **Description**. Description of the flavor. ['string']
+ - **Tags**. Tags associated with the flavor. ['array']
+ - **Plan**. Plan of the flavor. ['string']
+ - **Latency**. The latency of the Flavor. ['integer']
+ - **SecurityStandards**. Security standards supported by the Flavor (e.g., GDPR). ['array']
+- **ServiceType**. ServiceType to describe the specific characteristics of the advertised flavor.
+## vm
+![3](../models/examples/svg/flavor-types/vm.svg)
+- **Characteristics**:
+ - **Architecture**. Architecture of the Flavor. ['string']
+ - **CPU**. Number of CPU cores of the Flavor. ['integer']
+ - **Memory**. Amount of RAM of the Flavor. ['integer']
+ - **GPU**. Number of GPU cores of the Flavor. ['integer']
+ - **Storage**. The amount of storage ['integer']
+ - **SecurityStandards**. Security standards supported by the Flavor (e.g., GDPR). ['array']
+ - **Latency**. The latency of the Flavor. ['integer']
+- **Policy**:
+ - **Aggregatable**:
+ - **MinCount**. Minimum required number of instances of the Flavor. ['integer']
+ - **MaxCount**. Maximum required number of instances of the Flavor. ['integer']
+## sensor
+![4](../models/examples/svg/flavor-types/sensor.svg)
+- **Characteristics**:
+ - **SensorType**. The type of sensor ['string']
+ - **SensorModel**. The model of sensor ['string']
+ - **SensorManufacturer**. The manufacturer of sensor ['string']
+ - **SensorMarket**. The market of sensor ['string']
+ - **SamplingRate**. The sampling rate of the sensor in milliseconds ['integer']
+ - **Accuracy**. The accuracy reported for the measurements (unit percentage) ['integer']
+ - **Consumption**. The power consumption of the reported sensor (unit mW) ['integer']
+ - **Interface**. Not clear what that means. ['string']
+ - **SecurityStandards**. Security standards supported by the Flavor (e.g., GDPR). ['array']
+ - **Latency**. The latency of the Flavor. ['integer']
+ - **additionalProperties**:
+ - **MeasurementUnit**. The unit of measure for the measurements ['string']
+ - **ConsumptionUnit**. The unit of measure for the sensor power consumption ['string']
+ - **SamplingRateUnit**. The unit of measure for the sampling rate ['string']
+ - **AccessProtocol**. Not sure what that means ['string']
diff --git a/models/schemas/puml/flavor-types/k8slice.txt b/models/schemas/puml/flavor-types/k8slice.txt
@@ -30,9 +30,9 @@
  },
  "SecurityStandards": {
  "type": "array",
+ "description": "Security standards supported by the Flavor (e.g., GDPR).",
  "items": {
- "type": "string",
- "description": "Security standards supported by the Flavor (e.g., GDPR)."
+ "type": "string"
  }
  },
  "Latency": {

diff --git a/models/schemas/puml/flavor-types/sensor.txt b/models/schemas/puml/flavor-types/sensor.txt
@@ -41,9 +41,9 @@
  },
  "SecurityStandards": {
  "type": "array",
+ "description": "Security standards supported by the Flavor (e.g., GDPR).",
  "items": {
- "type": "string",
- "description": "Security standards supported by the Flavor (e.g., GDPR)."
+ "type": "string"
  }
  },
  "Latency": {

diff --git a/models/schemas/puml/flavor-types/service.txt b/models/schemas/puml/flavor-types/service.txt
@@ -18,10 +18,10 @@
  },
  "Tags": {
  "type": "array",
+ "description": "Tags associated with the flavor.",
  "items": {
  "type": "string"
- },
- "description": "Tags associated with the flavor."
+ }
  },
  "Plan": {
  "type": "string",
@@ -30,10 +30,18 @@
  "Latency": {
  "type": "integer",
  "description": "The latency of the Flavor."
+ },
+ "SecurityStandards": {
+ "type": "array",
+ "description": "Security standards supported by the Flavor (e.g., GDPR).",
+ "items": {
+ "type": "string"
+ }
  }
  }
  },
  "ServiceType": {
+ "description": "ServiceType to describe the specific characteristics of the advertised flavor.",
  "oneOf": [
  {
  "$ref": "service-types/db.json"

diff --git a/models/schemas/puml/flavor-types/vm.txt b/models/schemas/puml/flavor-types/vm.txt
@@ -30,9 +30,9 @@
  },
  "SecurityStandards": {
  "type": "array",
+ "description": "Security standards supported by the Flavor (e.g., GDPR).",
  "items": {
- "type": "string",
- "description": "Security standards supported by the Flavor (e.g., GDPR)."
+ "type": "string"
  }
  },
  "Latency": {

diff --git a/models/schemas/puml/flavor.txt b/models/schemas/puml/flavor.txt
@@ -38,6 +38,7 @@
  "description": "Type of network property ensured by the privider (e.g., 5G, Wifi, Ethernet)"
  },
  "FlavorType": {
+ "description": "A reference to a specific flavor type schema using JSON references ($ref) to external files like 'k8slice.json', 'vm.json', etc. This allows defining details specific to each flavor type.",
  "oneOf": [
  {
  "$ref": "flavor-types/k8slice.json"