Bosch IoT Rollouts Documentation

Static Rollout

Open Rollouts from the left navigation menu and click the + icon in the header. This action opens the Create Rollout wizard, which will guide you through several steps:

Targets and Distribution Set

The first step is to specify the Target selection and Distribution Set to deploy:

  • Basic properties

    • Rollout name – enter a unique name for this rollout.

    • Rollout description – optionally, enter a description for the rollout campaign.

  • Assignments

    • Target filter – choose an existing target filter or search for one by typing in the field. The number of targets matching the selected filter will be automatically displayed under the field.

      Prior to this step, you should have at least one target that matches the target filter to continue with the Static Rollout creation, otherwise if the filter doesn't match any targets - only Dynamic Rollout creation is available


    • Distribution set – select an existing distribution set to deploy, or search for it by name . Only complete distribution sets (containing all required software module types) can be selected. For instance, an OS with app(s) type distribution set must include an OS module and one or more App modules . The number of software modules in the chosen distribution set is displayed below the selection field.

Continue by clicking Next to proceed to the next step.

images/confluence/download/attachments/5886269241/52-version-1-modificationdate-1749796697000-api-v2.png

Group Definition

On the second dialog of the wizard, you define how the rollout will be grouped. There are two options for grouping: Static groups (the default) or Dynamic groups. For a Static Rollout, ensure Static groups is selected.

By default, Static groups is selected. When you create a static rollout, all existing targets that meet the filter criteria at the time of rollout creation are divided into a specified number of static deployment groups. Once the rollout is created, no new targets will be added to it (i.e. targets that register or meet the criteria later will not be included)

  • Number of groups - the number of deployment groups to split the targets into.

  • Trigger threshold - the percentage of targets in a group that must successfully complete the update before the next group begins execution.

  • Error threshold - the allowable failure rate (percentage or absolute number of targets) in a group before the entire rollout is emergency-stopped.

  • Action Confirmation - check the box if the end user of a device needs to be asked for consent before the update can be installed (requires enabling the User Consent mechanism)
    For details, see User consent flow.

After you configure these settings, the wizard will display a preview (in the blue highlighted area) of how the targets will be distributed across the specified number of groups.

images/confluence/download/attachments/5886269241/53-version-1-modificationdate-1749796995000-api-v2.png

Action Type and Start Option

Next, choose the Action Type and Start Option for the Dynamic Rollout:

  • Action Type: This setting controls how the device receives and applies the update . The options are the same as for static rollouts:

    • Forced – the device must install the update immediately.

    • Soft – the device can install the update at its convenience (e.g. with user approval or on a schedule).

    • Download only – the update is only downloaded to the device, not installed.

    • Time forced – the update starts as Soft, but will automatically switch to Forced at a specified time if not completed earlier.

    • Manual – the rollout will wait for a manual start trigger by a user.

    • Auto – the rollout will automatically start as soon as it’s created.

    • Scheduled – the rollout will start automatically at a predetermined date/time once it’s ready.

  • Start Option: This defines when the rollout execution begins.

images/confluence/download/attachments/5886269241/55-version-1-modificationdate-1749797102000-api-v2.png

Summary

In the final step, review all details of your new rollout. If everything is correct, click Create to finish creating the rollout (or click Back to make changes). Once created, the new rollout will appear in the Rollouts list.

If you chose a Manual start option, note that the rollout will not begin executing on its own. You or another user will need to start it from the Rollouts list (e.g. via the Start button in the rollout’s detail view).

After creating one or more rollouts, you can also use the Copy Rollout feature to base a new rollout on the configuration of an existing one.

Rollout Override Precedence

In cases where a device is targeted by multiple rollouts, a static rollout will override another rollout based on the start time of the previous rollout. In other words, if a static rollout is started after an earlier rollout (static or dynamic) targeting the same device, the new static rollout’s action will supersede the previous one. Any scheduled action from the earlier rollout for that device will be canceled when the later-started static rollout begins.