apertis-update-manager-api manual


Image Types:
Image Deployment:


Test the apertis-update-manager automatic update. The automated version of this test: https://qa.apertis.org/aum-api.html


  • A static update bundle file of the same architecture, variant and version as the testing image
  • A Fat32 USB flash drive, preloaded with the update bundle at the root of the disk
  • The latest static update file can be downloaded at the same location than the target image. It has the same basename, and a '.delta' extension
  • The static update file should be copied to the flash drive using the name 'static-update.bundle'.
  • A PC must be connected to DUT serial port

Execution Steps

  1. Check the initial deployment
  2. $ sudo ostree admin status

  3. Prepare the copy of commit and deploy to allow the upgrade to the same version
  4. Command below shows you an initial commit ID, for instance
  5. $ export BOOTID=$(sudo ostree admin status | sed -n -e 's/^\* apertis \([0-9a-f]*\)\.[0-9]$/\1/p'); echo $BOOTID

  6. Get the Collection ID and ref
  7. $ export CID=$(sudo ostree refs -c | head -n 1 | tr -d '(),' | cut -f 1 -d ' '); echo COLLECTION_ID=$CID

    $ export REF=$(sudo ostree refs -c | head -n 1 | tr -d '(),' | cut -f 2 -d ' '); echo REF=$REF

  8. Create the list of files to skip and enshure there are some files in these directories
  9. $ ls -1d /usr/share/locale /usr/share/man /usr/share/zoneinfo > /tmp/skip

    $ du -sh /usr/share/locale /usr/share/man /usr/share/zoneinfo

  10. Create the commit with changed timestamp and skipped list from above to allow upgrade with recent update file
  11. $ export NEWID=$(sudo ostree commit --orphan --tree=ref=$BOOTID --add-metadata-string=ostree.collection-binding=$CID --bind-ref=$REF --timestamp="1 year ago" --skip-list=/tmp/skip); echo "New commit: $NEWID"

  12. Deploy the prepared commit
  13. $ sudo ostree admin upgrade --allow-downgrade --deploy-only --override-commit=$NEWID --reboot

  14. Wait until the system is booted again and check the deployment
  15. $ sudo ostree admin status

  16. The booted commit (started with '*') must have ID which we prepare and the initial commit ID should be marked as '(rollback)'
  17. Check booted deployment have no file objects which we skip
  18. $ du -sh /usr/share/locale /usr/share/man /usr/share/zoneinfo

  19. Remove the initial deployment
  20. $ sudo ostree admin undeploy 1

  21. Reboot the system
  22. Check the current deployment
  23. $ sudo ostree admin status

  24. Start the user interface agent with mode preventing automatic system reboot after update
  25. $ sudo updatectl --register-upgrade-handler &

  26. Plug the USB flash drive into the device
  27. The update starts automatically
  28. After the update, the device does *not* reboot automatically
  29. Check that the user interface agent reports the pending update
  30. ** Message: Upgrade status: Checking

    ** Message: An upgrade is pending

  31. Remove the USB flash drive
  32. Check if there is pending deployment and reboot the DUT
  33. $ sudo ostree admin status

    $ sudo reboot

  34. Check the current deployment has been updated and that the rollback entry points to the prepared deployment
  35. $ sudo ostree admin status

  36. Start the user interface agent
  37. $ sudo updatectl &

  38. Plug the USB flash drive with the same update file into the device
  39. Check that the user interface agent reports the system is up to update
  40. ** Message: Upgrade status: Checking

    ** Message: System is up to date


CLI utility `updatectl` is able to interact with Apertis update manager

The update was properly applied