[ Topic template ] for contributing Update Modules

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 “Update Modules” -> “Edit” -> “Topic Template” as well. That is the raw markdown content.

Description

TODO: Add a high level description of the Update Module functionality

Example use-cases:

  • TODO: add example use-cases here

Specification

TODO: List the specs of the Update Module in below table

Specification
Module name < name >
Supports rollback < yes/no >
Requires reboot < yes/no >
Artifact generation script < yes/no >
Full system updater < yes/no >
Source code < link >

TODO: Consider removing below warning if you deem your Update Module to not fit the description.

Please be aware that Mender Update modules are meant to update parts of the system and if not configured properly they could potentially delete parts or the complete system. Always inspect the code carefully and only test modules on a systems that you can recover easily.

It is not recommended to install a Mender Artifact on your workstation

Prepare the device

This section describes how to setup your target device, i.e. the device to be updated. This will also be referred to as the device environment.

All commands outlined in this section should be run in the device environment.

Prerequisites

This update module has the following prerequisites for the device environment:

This Update Module has the following prerequisites for the development environment:

Install the Update Module

Download the latest version of this Update Module by running:

TODO: Insert install command here

Prepare the development environment on your workstation

This section describes how to set up your development environment on your workstation.

All commands outlined in this section should be run in the development environment.

Prerequisites

This Update Modules has the following prerequisites for the development environment:

Create Mender Artifacts

TODO: Add instructions on how to generate Artifacts, using mender-artifact tool or a provided script

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.

Artifact technical details

If necessary, any technical details of the Artifact contents that might be of interest for users