This section guides you through the steps of updating a device offline.
Enable Offline Update support, i.e. add
aktualizr. For example:
cat meta-subscriber-overrides.git/recipes-sota/aktualizr/aktualizr_%.bbappend PACKAGECONFIG:append = " aklite-offline"
Enable App Preloading if you would like to update
Compose Appsalong with rootfs (aka ostree).
Ensure that TUF keys are taken offline. If they are not, then do it.
Build an LmP image and flash it onto a target device or update the device with the image via OTA.
Obtaining Offline Update Content¶
Once the prerequisites are met, download the offline update content from the FoundriesFactory to some medium, e.g., a USB drive, which can be attached to a target device. The offline update content consists of:
- TUF metadata;
- OSTree repo containing a device’s rootfs;
- Compose Apps.
Use the command
fioctl targets offline-update <target-name> <dst> --tag <tag> [--prod] to download the update content.
<target-name>- denotes the Target to update a device to
<dst>- defines a path to download the update content to
<tag>- specifies the Target tag and the tag that the device is on
--prod- indicates that this is an update for a production device and
<target-name>refers to Production Target (see the note below)
fioctl waves init/complete commands to generate Production Targets.
Ensure that the target device is a Production device, see Manufacturing Process for Device Registration for more details.
In order to download all artifacts,
fioctl requires token with scopes:
Performing the Offline Update¶
Before doing the offline update, make the offline update content accessible on a device, e.g., attach and mount the USB drive.
aklite-offline CLI utility to perform an offline update:If a device needs
aklite-offline install [--config <config dir or file>] --src-dir <path to offline update content>.
Run one of the post installation actions depending on the
- trigger reboot to perform a rollback if the update failed;
- reboot device and invoke
aklite-offline run [--config <config dir or file>]to finalize an ostree installation and start Apps if both ostree/rootfs and Apps are updated;
- restart the Docker Engine (e.g.
systemctl restart docker) and invoke
aklite-offline run [--config <config dir or file>]if just Apps are updated.
The CLI utility supports two commands:
aklite-offline install [--config <config file/dir>] --src-dir <update-content-dir>
aklite-offline run [--config <config file/dir>]
``--config`` - Path to a directory that contains one of more ``*.toml`` configuration snippets or a path to a ``*.toml`` file. It may be omitted at all so the command collects config from the snippets found in the default directories/files, as ``aktualizr-lite`` does: /usr/lib/sota/conf.d /var/sota/sota.toml /etc/sota/conf.d/ ``--src-dir`` - Path to a directory that contains update content downloaded by ``fioctl targets offline-update`` command.
Post Install Actions¶
The command sets the following exit codes (
echo $?) that instruct which of the post install actions you should perform:
- 100 - Reboot is required to complete installation. After reboot
aklite-offline runmust be invoked.
- 101 - Restart of dockerd service is required , e.g.
systemctl restart docker. After the restart
aklite-offline runmust be invoked.
- 0 - OSTree/rootfs installation and Apps start was successful, update completed. Only
aklite-offline runcan return this code.
aklite-offline run returns 100 , then an update has not been successful and rollback has happened. In this case you should trigger reboot followed by another
aklite-offline run to complete the rollback.
The minimum required configuration is:
[provision] primary_ecu_hardware_id = <>
The command can digest the default device config consisting of:
*tomlfiles added into LmP during bitbaking (usually just
If a device needs to support offline and online updating, then the configuration needs to be shared with
Normally, each LmP image includes a configuration file
/usr/lib/sota/conf.d/40-hardware-id.toml which defines a hardware ID.
Therefore, by default, an LmP image includes the minimum required configuration, hence NO device registration is required for
aklite-offline to work.
If you register a device and
sota.toml is generated, then the offline update command can either work alone or alone with
In the later case, you must stop the
aktualizr-lite systemd service before running the offline update command.