[ Topic template ]

NOTE! This has the same content which is presented when you press the “+ New Topic” button, but we store this here for traceability. All updates to this topic must be pushed to “Yocto Project” -> “Edit” -> “Topic Template” as well. That is the raw markdown content. END NOTE

The official Mender documentation explains how Mender works. This is simply a board-specific complement to the official documentation.

Board description

TODO: Short description of board

TODO: Upload board picture here.

URL: TODO: vendor URL with board specs
Wiki: TODO: wiki URL (if available)

Test results

The Yocto Project releases in the table below have been tested by the Mender community. Please update it if you have tested this integration on other Yocto Project releases:

TODO: Update table below with Yocto Project versions tested & result. Sample data:

Yocto Project Build Runtime
thud (2.6) :test_workaround: 1 :test_works:
sumo (2.5) :test_works: :test_fails: 2

1. Build issue due to systemd-network…workaround steps…
2. Board does not boot, freezes after U-Boot prompt with the following message…

Build Means that the Yocto Project build using this Mender integration completes without errors and outputs images.
Runtime Means that Mender has been verified to work on the board. For U-Boot-based boards, the integration checklist has been verified.

Getting started

Prerequisites

  • A supported Linux distribution and dependencies installed on your workstation/laptop as described in the Yocto Mega Manual
    • NOTE. Instructions depend on which Yocto version you intend to use.
  • Google repo tool installed and in your PATH.

Configuring the build

Setup Yocto environment

Set the Yocto Project branch you are building for:

# set to your branch, make sure it is supported (see table above)
export BRANCH="sumo"

Create a directory for your mender-<TARGET> setup to live in and clone the
meta information.

mkdir mender-<TARGET> && cd mender-<TARGET>

Initialize repo manifest:

repo init -u https://github.com/mendersoftware/meta-mender-community \
           -m meta-mender-<TARGET>/scripts/manifest-<TARGET>.xml \
           -b ${BRANCH}

Fetch layers in manifest:

repo sync

Setup build environment

Initialize the build environment:

source setup-environment <TARGET>

Configure Mender server URL (optional)

This section is not required for a successful build but images that are generated by default are only suitable for usage with the Mender client in Standalone deployments, due to lack of server configuration.

You can edit the conf/local.conf file to provide your Mender server configuration, ensuring the generated images and Mender Artifacts are connecting to the Mender server that you are using. There should already be a commented section in the generated conf/local.conf file and you can simply uncomment the relevant configuration options and assign appropriate values to them.

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 = "<copy token here>"

Build for Mender demo server:

# https://docs.mender.io/getting-started/create-a-test-environment
#
# Update IP address to match the machine running the Mender demo server
MENDER_DEMO_HOST_IP_ADDRESS = "192.168.0.100"

Building the image

You can now proceed with building an image:

MACHINE=<YOUR-MACHINE> bitbake core-image-base

Replace core-image-base with your desired image target.

Using the build output

After a successful build, the images and build artifacts are placed in tmp/deploy/images/<YOUR-MACHINE>/. TODO: update MACHINE name and give full path to disk image and Artifact.

The disk image (with TODO: select right one .sdimg/.uefiimg / .biosimg suffix) is used to provision the device storage for devices without Mender running already. Please proceed to the official documentation on 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, which have .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.

References

TODO: Add any relevant references such as repository README.md files, etc.

Known issues

  • Known issue #1
  • Known issue #2

If this post was useful to you, please press like, or leave a thank you note to the contributor who put valuable time into this and made it available to you. It will be much appreciated!

1 Like