Yocto Project

reference

Mender Orchestrator is only available in the Mender Enterprise plan. See the Mender plans page for an overview of all Mender plans and features.

Mender Orchestrator requires DeviceTier to be set to "system" for proper operation.

This guide walks you through installing Mender Orchestrator on devices using the Yocto Project build system.

See Yocto chapter for general information.

Prerequisites

Before integrating Mender Orchestrator into your Yocto build, ensure you have a properly configured Yocto build environment with meta-mender layers and the Mender Orchestrator sources downloaded through the links below.

Mender Orchestrator requires the master recipe of the Mender Client. Support for Mender Orchestrator will be released in the next feature release. See the Yocto Project documentation for information on using bleeding edge versions.

Download

Set your credentials:

HOSTED_MENDER_EMAIL=<your.email@example.com>

Download the source archive:

curl --fail -u $HOSTED_MENDER_EMAIL -o ${HOME}/mender-orchestrator-0.4.0.tar.xz https://downloads.customer.mender.io/content/hosted/mender-orchestrator/yocto/0.4.0/mender-orchestrator-0.4.0.tar.xz

Demo layer (evaluation)

For evaluation and testing purposes, you can use the demo layer before proceeding to production setup:

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

The meta-mender-demo layer provides a mock environment with a corresponding Topology for testing and demonstration purposes.

The demo configuration is inappropriate for production devices.

Integration

Add the meta-mender-commercial layer to your build:

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

Accept the commercial license by adding to your local.conf:

LICENSE_FLAGS_ACCEPTED:append = " commercial_mender-yocto-layer-license"

Point the mender-orchestrator recipe to the downloaded tarball:

SRC_URI:pn-mender-orchestrator = "file://${HOME}/mender-orchestrator-0.4.0.tar.xz"

Include Mender Orchestrator in your image:

IMAGE_INSTALL:append = " mender-orchestrator"

Set the DeviceTier to "system":

MENDER_DEVICE_TIER = "system"

We also provide mender-orchestrator-support, an open-source repository containing Interfaces, Update Modules and Inventory scripts when using Mender Orchestrator together with the Mender Client. To include this in your image, add:

IMAGE_INSTALL:append = " mender-orchestrator-support"

Your local.conf should now contain:

LICENSE_FLAGS_ACCEPTED:append = " commercial_mender-yocto-layer-license"
SRC_URI:pn-mender-orchestrator = "file://${HOME}/mender-orchestrator-0.4.0.tar.xz"
IMAGE_INSTALL:append = " mender-orchestrator mender-orchestrator-support"
MENDER_DEVICE_TIER = "system"

Production installation

For production deployments, provision a Topology that defines the Components of your System.

To include your Topology file in the Yocto build, add this to your local.conf:

FILESEXTRAPATHS:prepend := "/path/to/local-directory-with-topology.yaml:"
SRC_URI:pn-mender-orchestrator:append = " file://topology.yaml"

Replace /path/to/local-directory-with-topology.yaml with the actual path to the directory containing your topology.yaml file.

We welcome contributions to improve this documentation. To submit a change, use the Edit link at the top of the page or email us at .