[ Buildroot 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 Buildroot releases in the table below have been tested by the Mender community. Please update it if you have tested this integration on other releases.

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

Buildroot Build Runtime
2019.02 :test_workaround: 1 :test_works:
2018.11.3 :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 Buildroot 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 Buildroot Manual
    • NOTE. Instructions depend on which Buildroot version you intend to use.

Configuring the build

Setup Buildroot environment

Set the Buildroot tag you are building for:

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

Clone this repository:

git clone https://github.com/mendersoftware/buildroot-mender -b ${BR2_TAG}

Change directory to buildroot-mender:

cd buildroot-mender

Fetch submodules:

git submodule init --update

Setup build environment

Generate configuration file (Mender configs merged with upstream config):

./buildroot-external-mender/board/freescale/<target>/gen-defconfig.sh 

Configure Buildroot:

make mender_<target>_defconfig

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 buildroot-external-mender/board/common/rootfs_overlay/etc/mender/mender.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.

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 TenantToken

Example buildroot-external-mender/board/common/rootfs_overlay/etc/mender/mender.conf:

{
  "InventoryPollIntervalSeconds": 5,
  "UpdatePollIntervalSeconds": 5,
  "RetryPollIntervalSeconds": 10,
  "ServerURL": "https://hosted.mender.io",
  "TenantToken": "<paste tenant token here>"
}

Build for Mender demo server

This is if you have followed the Getting started documentation where you launch a Mender server locally and to configure your enviroment to connect to this local server you need to provide the IP address of the server on the local network.

By default the demo enviroment will connect to docker.mender.io and s3.docker.mender.io and we need to make sure that these are resolved to the local IP address of the running server by adding the following entry to /etc/hosts

echo "192.168.0.100" >> buildroot-external-mender/board/common/rootfs_overlay/etc/hosts

No changes are required to the mender.conf file in this case it will be already setup to connecto to docker.mender.io.

Building the image

You can now proceed with building an image:

make

Using the build output

After a successful build, the images and build artifacts are placed in buildroot/output/images

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!