Added migration guide from YAML to JSON (#40)

* Added short migration guide from YAML to JSON * Fix review findings #1 * Fix review findings #2
eclipse-leda · Jul 10, 2023 · 81d23b4 · 81d23b4
1 parent 4b3ed59
commit 81d23b4
Show file tree

Hide file tree

Showing 2 changed files with 128 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -108,6 +108,7 @@ MQTT communication is done over 5 MQTT topics:
 | selfupdate/desiredstatefeedback | OUT | This message is being sent by SUA to share the current progress of the triggered update process. This is the *OUT* counterpart of *selfupdate/desiredstate* input message. |
 
 Detailed description of Update Agent API can be found here: [link](docs/bfb.md).
+Migration guide for users from old YAML payloads to new JSON format can be found here: [link](docs/migration_guide.md).
 
 # Checkout
 SUA links to some 3rd party libraries, which are fetched as submodules, therefore the cloning shall be performed with recursive option:

diff --git a/docs/migration_guide.md b/docs/migration_guide.md
@@ -0,0 +1,127 @@
+# Migration guide from YAML payloads to JSON (bfb) protocol
+
+## Background
+The communication protocol between SUA and backend was extended to support vehicle orchestration for large quantities of devices. Key differences are:
+* Transition from YAML to JSON
+* Fine-grained API (command-based approach instead of single-shot self-update)
+* Extension of statuses (for detailed reflection of success, progress or failure)
+Some fields are not relevant anymore meanwhile new were introduced. Below is a brief comparison between messages in YAML and in JSON format.
+
+### Transition guide for current state message
+From the current state message in YAML payload there is only one field 'bundleVersion' which is relevant. The corresponding field in JSON variant is 'version' in 'softwareNodes' for the device image. *NOTE*: The actual name could differ depending on the distro configuration.
+```
+apiVersion: sdv.eclipse.org/v1
+kind: SelfUpdateBundle
+metadata: 
+    name: "self-update-bundle-example"
+spec: 
+    bundleVersion: 1.0
+```
+
+```
+{
+    "timestamp": 42,
+    "payload": {
+        "softwareNodes": [
+            {
+                "id": "self-update-agent",
+                "version": "build-42",
+                "name": "OTA NG Self Update Agent",
+                "type": "APPLICATION"
+            },
+            {
+                "id": "self-update:leda-deviceimage",
+                "version": "1.0",
+                "name": "Official Leda device image",
+                "type": "IMAGE"
+            }
+        ],
+        "hardwareNodes": [],
+        "associations": [
+            {
+                "sourceId": "self-update-agent",
+                "targetId": "self-update:leda-deviceimage"
+            }
+        ]
+    }
+}
+```
+
+### Transition guide for desired state message
+For the desired state message there are two relevant fields 'bundleDownloadUrl' and 'bundleVersion' for take-over. The corresponding values are 'version' under the 'components' and 'value' inside the object with 'key'='image'. *NOTE*: There could be multiple entries inside 'components' array and 'config' section. Your implementation has to search for 'os-image' and 'image' values respectively.
+```
+apiVersion: "sdv.eclipse.org/v1"
+kind: SelfUpdateBundle
+metadata:
+    name: self-update-bundle-example
+spec:
+    bundleDownloadUrl: http://url
+    bundleName: arm64-bundle
+    bundleTarget: base
+    bundleVersion: 1.0
+```
+```
+{
+    "activityId": "random-uuid-as-string",
+    "timestamp": 123456789,
+    "payload": {
+        "domains": [
+            {
+                "id": "self-update",
+                "components": [
+                    {
+                        "id": "os-image",
+                        "version": "1.1",
+                        "config": [
+                            {
+                                "key": "image",
+                                "value": "http://example.com/downloads/os-image-1.1.bin"
+                            }
+                        ]
+                    }
+                ]
+            }
+        ]
+    }
+}
+```
+
+### Transition guide for state feedback
+Below there is an example for state feedback ('techCode' is optional and available only in case of failure). For transition to JSON format all three fields from 'state' section are important (except 'techCode') and their corresponding places in JSON are 'status' and 'message' in sections 'payload' and 'actions', and 'progress' in section 'actions'. The detailed list of the available payload status and action status can be found in [link](docs/bfb.md) because for vehicle orchestration more sub-states were introduced for a fine-grained report of the self-update progress.
+```
+apiVersion: sdv.eclipse.org/v1
+kind: SelfUpdateBundle
+metadata:
+    name: "self-update-bundle-example"
+spec:
+    bundleDownloadUrl: "http://url"
+    bundleName: "arm64-bundle"
+    bundleTarget: base
+    bundleVersion: 1.0
+state:
+    message: Downloaded 10.0 MiB...
+    name: downloading
+    progress: 100
+    techCode: 42
+```
+```
+{
+    "activityId": "id",
+    "timestamp": 42,
+    "payload": {
+        "status": "ACTIVATION_SUCCESS",
+        "message": "Self-update agent has activated the new OS image.",
+        "actions": [
+            {
+                "component": {
+                    "id": "self-update:os-image",
+                    "version": "1.0"
+                },
+                "status": "UPDATED",
+                "progress": 0,
+                "message": "Self-update agent has activated the new OS image."
+            }
+        ]
+    }
+}
+```