Introduction

The update report serves as a comprehensive record of a successfully completed system update process, carried out by applying a recipe. Typically, this report is transmitted from the system's gateway to the Install API, serving as a notification of the completed update. The update report is utilized to monitor the overall system update status, as well as the update status of the individual modules. For each module updates, the corresponding deployment actions within Bosch IoT Rollouts are generated, leveraging the Action state machine. This functionality enables module responsibles to easily trace the update history of the system's constituent modules.

Understanding system actions

For each system update process, i.e. the assignment of a recipe to system, a system action is created. Each system action is defined by the following properties:

• ID: SOUP generated ID for reference in the UI and API

• Status: Current status of the system action state machine

• Last reported at: Timestamp of the last update report for this system action

• System: The system where the recipe is installed

• Recipe: The recipe that get's installed

• Gateway: Module that sent the update report

• Module actions: Reference to the corresponding actions in IoT Rollouts.

• Status log: List of status updates for this system action, when they were reported, the action status, a status code, and log messages.

System action statuses

SOUP uses a stateful update process, providing systems with opportunities to provide feedback at various stages. This feedback is crucial for SOUP to accurately track the update progress and determine the final outcome. Systems must provide a final status (success or error) for SOUP to complete the system update action. Below is the list of the possible system action statuses and the corresponding state machine.