Bosch IoT Rollouts

Deployment view

Table of contents:

Purpose

Target status overview, target management and manual deployment.

Features explained

Feature overview

  • Monitor status of all Targets.

  • Manage Targets, Target metadata, Target tags and Target types.

  • Start a Deployment by drag and drop Target/s on a Distribution set.

  • List specific Targets by filtering on:

    • Assigned/installed Distribution set (drag and drop a set on the top of the target list).

    • Update status: Only view Targets that are in one of the given states.

    • Tag: Only view Targets with at least one of the given tags.

    • Name and description: Use search button on the top of the list.

    • Target type: open Type Filter section to show targets of a specific type.

  • List specific Distribution sets by filtering on:

    • Tag: Only view Distribution sets with at least one of the given tags.

    • Name and description: Use search button on the top of the list.

  • View Action history of the selected Target.

  • Create many targets at once by uploading a file containing their specifications (Bulk Upload).

  • Distribution set invalidation allows to mark broken updates and avoid the distribution of such

Target bulk upload

  • Expected file type : csv

  • Expected file format : Each line with two values (ControllerID,TargetName). ControllerID is mandatory.

  • Example:

Controller_id_1,targetName1
Controller_id_2,targetName2

Deployment: Action Types

  • Select Forced update to tell the device that the update has to be executed immediately.

  • Select Soft update to tell the device that the update can be executed any time, e.g. with user approval or in future regular update time plan.

  • Select Download Only to tell the device that the update has to be only downloaded, and not installed.

  • Select Time Forced update to configure a point in time where Rollouts switches from soft to forced.

images/confluence/download/attachments/1680491241/deploymentViewSoftForced.png

See Defined Action Types for a detailed overview of action types, as well as action state transitions.

Deployment: Maintenance window

  • Configure optional Maintenance Window, i.e. device gets informed immediately to start download but to execute deployment during configured window(s) only:

    • Schedule of window start trigger is configured in Cron Quartz notation, e.g. “0 0 1 * * ?” for window start 1AM every day.

    • Duration of the window in “HH:MM:SS” notation, e.g. “02:00:00” for two hours.

    • Time Zone of the window from GMT, e.g. “+02:00” for Central European Summer Time (CEST).

images/confluence/download/attachments/1680491241/deploymentViewMaintWindow.png

Note: the Maintenance window is only available for non Download Only assignments.

Distribution set invalidation

It is possible to mark broken updates and avoid the distribution of such by invalidating the corresponding distribution set in the Distributions list of the Deployment view (1).

Invalidating a distribution set removes all auto-assignments that reference this distribution set. Optionally, all rollouts that reference the distribution set can be stopped (3) and existing update actions are removed, either by a soft-cancel or a force quit (2). Invalidated distribution sets are displayed as strike-through in the UI and cannot be assigned to targets, neither through a rollout, auto-assignment nor a single assignment.

Invalidated distribution sets cannot be valid again, but remain invalid.

For further information on distribution set invalidation and mass-cancelling of actions, see Mass Cancel concept.

images/confluence/download/attachments/1680491241/distributionsetInvalidation.png

Note that the general management of distribution sets is part of the Distribution Management view, where the software distributions are managed, versioned and grouped. Whereas the invalidation of a distribution set is only possible in the Deployment Management view, as canceling an update action is seen as part of the deployment itself.

Tips and hints

  • To get more information, widgets can be maximized by clicking the button in the upper right corner. Maximize the Action history to view messages send by the target.

  • Cancel an Action by clicking the cross icon images/confluence/download/attachments/1680491241/close-small-gray.png .

  • When an Action is canceled, clicking the red cross icon images/confluence/download/attachments/1680491241/close-small.png allows to force quit it. The force quit function should be used very carefully. This function will only remove the action on the Bosch IoT Rollouts server and will not sent any information to the Target. When the Target continues sending new messages to Bosch IoT Rollouts this will cause an error. However this function could be very helpful, when the Action is blocked by a corrupted Target.

Permissions

You need the following permissions to see the Deployment view in…

  • read-only access mode: READ_TARGET, READ_REPOSITORY

  • full access mode: READ_TARGET, CREATE_TARGET, UPDATE_TARGET, DELETE_TARGET, READ_REPOSITORY, READ_TARGET_SEC_TOKEN

The cloud user has full access by default for all available service plans.

images/confluence/download/attachments/1680491241/deployment.png

See Authentication and authorization for further information about available roles and their included permissions.