This document outlines the steps needed to build a Yocto Project image for a device. The build output will most notably include:
meta-mender is a set of layers that enable the creation of a Yocto Project image where the Mender client is part of the image. With Mender installed and configured on the image, you can deploy image updates and benefit from features like automatic roll-back, remote management, logging and reporting.
Inside meta-mender there are several layers. The most important one is meta-mender-core, which is required by all builds that use Mender. meta-mender-core takes care of:
Each one of these steps can be configured further, see the linked sections for more details.
The other layers in meta-mender provide support for specific boards.
For general information about getting started with Yocto Project, it is recommended to read the Yocto Project Quick Start guide.
Mender needs to integrate with your board, most notably with the boot process. Although the integration is automated for most boards, please see Board integration for general requirements and adjustment you might need to make before building.
Check out the board integrations at Mender Hub to see if your board is already integrated. If you encounter any issues and want to save time, you can use the Mender professional services to integrate your board.
Make sure that the clock is set correctly on your devices. Otherwise certificate verification will become unreliable and the Mender client can likely not connect to the Mender server. See certificate troubleshooting for more information.
We use the thud branch of the Yocto Project and thud branch of
meta-mender below. Building meta-mender on other releases of the Yocto Project will likely not work seamlessly.
meta-mender also has other branches like daisy that correspond to Yocto Project releases, but these branches are no longer maintained by Mender developers. We offer professional services to to implement and support other branches over time, please take a look at the Mender professional services offering.
A Yocto Project poky environment is required. If you already have
this in your build environment, please open a terminal, go to the
directory and skip to Adding the meta layers.
On the other hand, if you want to start from a clean Yocto Project environment, you need to clone the latest poky and go into the directory:
git clone -b thud git://git.yoctoproject.org/poky
Note that the Yocto Project also depends on some development tools to be in place.
We will now add the required meta layers to our build environment.
Please make sure you are standing in the directory where
i.e. the top level of the Yocto Project build tree, and run these commands:
git clone -b thud git://github.com/mendersoftware/meta-mender
Next, we initialize the build environment:
This creates a build directory with the default name,
build, and makes it the
current working directory.
We then need to add the Mender layers into our project:
bitbake-layers add-layer ../meta-mender/meta-mender-core
meta-mender-demo layer (below) is not appropriate if you are building for production devices. Please go to the section about building for production to see the difference between demo builds and production builds.
bitbake-layers add-layer ../meta-mender/meta-mender-demo
Mender board integration is mostly automated. Consequently, a board-specific Mender integration layer as described below is typically only necessary for improving performance or resolving any board-specific issues. If you are unsure if you need one, try to build without adding any board integration layer.
If needed, add any Mender integration layer specific to your board. For the three Mender reference boards use these layers (only add one of these):
bitbake-layers add-layer ../meta-mender/meta-mender-raspberrypi(depends on
bitbake-layers add-layer ../meta-mender/meta-mender-qemu
For board specific setup instructions please check out Mender Hub which contains our reference boards plus a large pool of community supported integrations
If you encounter any issues, please see Board integration for general requirements and adjustments you might need to enable your board to support Mender.
At this point, all the layers required for Mender should be part of your Yocto Project build environment.
The configuration in
conf/local.conf below will create a build that runs the Mender client in managed mode, as a
systemd service. It is also possible to run Mender standalone from the command-line or a custom script. See the section on customizations for steps to disable the
Add these lines to the start of your
# The name of the disk image and Artifact that will be built. # This is what the device will report that it is running, and different updates must have different names # because Mender will skip installation of an Artifact if it is already installed. MENDER_ARTIFACT_NAME = "release-1" INHERIT += "mender-full" # A MACHINE integrated with Mender. # raspberrypi3, beaglebone-yocto, vexpress-qemu and qemux86-64 are reference boards MACHINE = "<YOUR-MACHINE>" # The version of Mender to build. This needs to match an existing recipe in the meta-mender repository. # # Given your Yocto Project version, see which versions of Mender you can currently build here: # https://docs.mender.io/architecture/compatibility#mender-client-and-yocto-project-version # # Given a Mender client version, see the corresponding version of the mender-artifact utility: # https://docs.mender.io/architecture/compatibility#mender-clientserver-and-artifact-format # # Note that by default this will select the latest released version of the tools. # If you need an earlier version, please uncomment the following and set to the # required version. # # PREFERRED_VERSION_pn-mender = "1.1.%" # PREFERRED_VERSION_pn-mender-artifact = "2.0.%" # PREFERRED_VERSION_pn-mender-artifact-native = "2.0.%" # The following settings to enable systemd are needed for all Yocto # releases sumo and older. Newer releases have these settings conditionally # based on the MENDER_FEATURES settings and the inherit of mender-full above. DISTRO_FEATURES_append = " systemd" VIRTUAL-RUNTIME_init_manager = "systemd" DISTRO_FEATURES_BACKFILL_CONSIDERED = "sysvinit" VIRTUAL-RUNTIME_initscripts = "" ARTIFACTIMG_FSTYPE = "ext4" # Build for Hosted Mender # # To get your tenant token: # - log in to https://hosted.mender.io # - click your email at the top right and then "My organization" # - press the "COPY TO CLIPBOARD" # - assign content of clipboard to MENDER_TENANT_TOKEN # #MENDER_SERVER_URL = "https://hosted.mender.io" #MENDER_TENANT_TOKEN = "" # Build for Mender demo server # # https://docs.mender.io/getting-started/create-a-test-environment # # Uncomment below and update IP address to match the machine running the # Mender demo server #MENDER_DEMO_HOST_IP_ADDRESS = "192.168.0.100" # Build for Mender production setup (on-prem) # # https://docs.mender.io/artifacts/building-for-production # # Uncomment below and update the URL to match your configured domain # name and provide the path to the generated server.crt file. # # Note that a custom server.crt file is only necessary if you are using # self-signed certificates. # # NOTE! It is recommend that you provide below information in your custom # Yocto layer and this is only for demo purposes. See linked documentation # for additional information. #MENDER_SERVER_URL = "https://docker.mender.io" #FILESEXTRAPATHS_prepend_pn-mender := "<DIRECTORY-CONTAINING-server.crt>:" #SRC_URI_append_pn-mender = " file://server.crt"
The size of the disk image (
.sdimg) should match the total size of your storage so you do not leave unused space; see the variable MENDER_STORAGE_TOTAL_SIZE_MB for more information. Mender selects the file system type it builds into the disk image, which is used for initial flash provisioning, based on the
ARTIFACTIMG_FSTYPE variable. See the section on file system types for more information.
If you are building for Hosted Mender, make sure to set
MENDER_TENANT_TOKEN (see the comments above).
If you would like to use a read-only root file system, please see the section on configuring the image for read-only rootfs.
Once all the configuration steps are done, build an image with bitbake:
<YOUR-TARGET> with the desired target or image name, e.g.
The first time you build a Yocto Project image, the build process can take several hours. The successive builds will only take a few minutes, so please be patient this first time.
After a successful build, the images and build artifacts are placed in
There is one Mender disk image, which will have one of the following suffixes:
.uefiimgif the system boots using the UEFI standard (x86 with UEFI or ARM with U-Boot and UEFI emulation) and GRUB bootloader
.sdimgif the system is an ARM system and boots using U-Boot (without UEFI emulation)
.biosimgif the system is an x86 system and boots using the traditional BIOS and GRUB bootloader
Please consult the bootloader support section for information on which boot method is typically used in each build configuration.
This disk image is used to provision the device storage for devices without Mender running already. Please proceed to Provisioning a new device for steps to do this.
On the other hand, if you already have Mender running on your device and want to deploy a rootfs update
using this build, you should use the Mender Artifact files,
.mender suffix. You can either deploy this Artifact in managed mode with
the Mender server as described in Deploy to physical devices
or by using the Mender client only in Standalone deployments.
If you built for one of the virtual Mender reference boards (
vexpress-qemu), you can start up your newly built image with the script in
../meta-mender/meta-mender-qemu/scripts/mender-qemu and log in as root without password.