Self Update Tutorial

This chapter describes the steps necessary to perform a local (without cloud) self update of the operating system.

Self Update Architecture

Self-Update using RAUC Update Bundles

On host: Update bundle sdv-rauc-bundle-qemux86-64.raucb is in current folder

Note: In the development environment, the update RAUC Update Bundle is located in the BitBake machine-specific output folder Example location is tmp/deploy/images/qemux86-64
On host: Start a dummy web server for serving the update file
```
python3 -m http.server --bind 192.168.7.1
```

On host: open two new terminals - one for monitoring and one for triggering the self-update

Terminal 1: To view the progress, watch the MQTT topics selfupdate/desiredstate and selfupdate/desiredstatefeedback:
```
mosquitto_sub -h 192.168.7.2 -p 1883 -t "selfupdate/#"
```

Terminal 2: Trigger the actual self update process by publishing an MQTT message to selfupdate/desiredstate:

mosquitto_pub -h 192.168.7.2 -p 1883 -t "selfupdate/desiredstate" -f start-update-example.json
mosquitto_pub -h 192.168.7.2 -p 1883 -t "selfupdate/desiredstate/command" -f download-command.json
mosquitto_pub -h 192.168.7.2 -p 1883 -t "selfupdate/desiredstate/command" -f update-command.json
mosquitto_pub -h 192.168.7.2 -p 1883 -t "selfupdate/desiredstate/command" -f activate-command.json
mosquitto_pub -h 192.168.7.2 -p 1883 -t "selfupdate/desiredstate/command" -f cleanup-command.json

Files:

start-update-example.json

download-command.json

update-command.json

activate-command.json

cleanup-command.json

Switch to a terminal in the guest
On guest: After the self update process completed, check the status:
```
rauc status --detailed
```

Self-Update Trigger Message

start-update-example.json file:

{
    "activityId": "random-uuid-as-string",
    "timestamp": 123456789,
    "payload": {
        "domains": [
            {
                "id": "self-update",
                "components": [
                    {
                        "id": "os-image",
                        "version": "${VERSION_ID}",
                        "config": [
                            {
                                "key": "image",
                                "value": "http://leda-bundle-server/sdv-rauc-bundle-minimal-qemux86-64.raucb"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Example Message Flows

Current State

Initial response message on startup from self update agent in topic selfupdate/currentstate, or upon request by sending message to selfupdate/currentstate/get

 {
       "activityId": "1234567890",
       "timestamp": 1687510087
 }

Response by Self Update Agent on topic selfupdate/currentstate

 {
       "activityId": "1234567890",
       "timestamp": 1687787461,
       "payload": {
             "softwareNodes": [
             {
                   "id": "self-update-agent",
                   "version": "build-152",
                   "name": "OTA NG Self Update Agent",
                   "type": "APPLICATION"
             },
             {
                   "id": "self-update:leda-deviceimage",
                   "version": "v0.0.10-194-g3d48cb8",
                   "name": "Official Leda device image",
                   "type": "IMAGE"
             }
             ],
             "hardwareNodes": [],
             "associations": [
             {
                   "sourceId": "self-update-agent",
                   "targetId": "self-update:leda-deviceimage"
             }
             ]
       }
 }