Delta update support

tutorial

If you are using Mender Professional or Mender Enterprise, you have access to robust delta updates. In this section we describe how to enable support for delta updates on your devices, by installing the mender-binary-delta Update Module with your Yocto Project build.

Once your devices support installing delta updates, see Create a Delta update Artifact for a tutorial on how to create a delta update from two system updates.

Prerequisites

In order to use delta update, you must be using a read-only root filesystem. For details on how to enable this, see the Read only root filesystem section.

Download mender-binary-delta

If you are using hosted Mender, download the mender-binary-delta archive with the following command:

HOSTED_MENDER_EMAIL="myusername@example.com"
curl -u $HOSTED_MENDER_EMAIL -O https://download.mender.io/hosted/content/mender-binary-delta/1.1.0/mender-binary-delta-1.1.0.tar.xz

Replace the value of HOSTED_MENDER_EMAIL with the email address you used to sign up on Hosted Mender, then enter your Hosted Mender password when prompted to proceed. NOTE: if you signed up using your Google or GitHub login, use the email address linked to that account and enter x as the password.

On the other hand, if you are using on-premise Mender Enterprise, download using the following command:

MENDER_ENTERPRISE_EMAIL="myusername@example.com"
curl -u $MENDER_ENTERPRISE_EMAIL -O https://download.mender.io/content/mender-binary-delta/1.1.0/mender-binary-delta-1.1.0.tar.xz

Unpack mender-binary-delta

The archive mender-binary-delta-1.1.0.tar.xz contains the binaries needed to generate and apply deltas.

Change directory to $HOME:

cd ${HOME}

Unpack the mender-binary-delta-1.1.0.tar.xz in your home directory:

tar xvf mender-binary-delta-1.1.0.tar.xz

Integrate mender-binary-delta into the Yocto environment

Add meta-mender-commerical layer to your Yocto environment:

bitbake-layers add-layer ../sources/meta-mender/meta-mender-commercial

Add the following your local.conf to include mender-binary-delta in your build:

cat <<EOF >> conf/local.conf
# Customizations for Mender delta-update support

IMAGE_INSTALL_append = " mender-binary-delta"
LICENSE_FLAGS_WHITELIST_append = " commercial_mender-binary-delta"
FILESEXTRAPATHS_prepend_pn-mender-binary-delta := "${HOME}/mender-binary-delta-1.1.0/:"

EOF

The trailing : in FILESEXTRAPATHS_prepend_pn-mender-binary-delta is intentional and important to have in place.

Next steps

For information on how to create delta update Artifacts, see Create a Delta update Artifact.

For more information about delta updates, including how to deploy them, as well as troubleshooting, see the Mender Hub page about mender-binary-delta.

Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to submit changes.