Skip to content

Commit

Permalink
ug: Update the custom sota client doc
Browse files Browse the repository at this point in the history
Extend the custom sota client doc with info on new modes it supports.

Signed-off-by: Mike Sul <mike.sul@foundries.io>
  • Loading branch information
mike-sul committed Feb 12, 2024
1 parent a38630d commit 2dbf9d7
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions source/user-guide/custom-sota-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,21 @@ Producing a factory-specific SOTA client can be done by:

.. _custom-sota-client:
https://github.com/foundriesio/meta-lmp/tree/main/meta-lmp-base/recipes-sota/custom-sota-client

Custom SOTA Client Work Modes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
By default, the the example `SOTA client`_ works as a daemon updating a device to the latest version once it becomes available.
In addition to the default daemon mode, users can run it as a CLI utility and perform specific steps of the overall update process separately.

.. prompt:: bash

/build-custom/custom-sota-client --help
Usage:
custom-sota-client [cmd] [options]
Supported commands: check install run pull daemon
Default command is "daemon"

* ``check`` - updates the device's TUF repo with the latest factory's TUF metadata or with the TUF metadata specified in the offline update bundle, and checks if there is a newer than currently installed target.
* ``pull`` - pulls the delta between the currently installed and the specified one.
* ``install`` - installs the previously pulled target; yields an error if the specified target has not been pulled before.
* ``run`` - finalizes the installed target; confirms an update after reboot on a new rootfs version and/or starts the updated apps.

0 comments on commit 2dbf9d7

Please sign in to comment.