About the Update Modules category

#1

This is the online resource for out-of-the-box and community-supported Update Modules.

Update Modules are customizable, easy to write modules that define how the Mender client installs an update to a device. You can use an Update Module to install any type of software package, and they can be written in any language.

You can read more about how Update Modules work in our official documentation.

How to contribute

If you have created an Update Module and you would like to share it with the community, here are some guidelines on how to proceed.

Please note that there is no hard criteria for sharing a module, and even if your Update Module is very specialized for your use-case it could be a source of inspiration for someone if they can not re-use it as-is.

We host a repository for community contributed Update Modules, which you can use to publish your own module. The repository is mender-update-modules.

We also host a Yocto layer if you would like to add a recipe for your Update Module, making it easy to integrate with existing Yocto enviroment. The repository is meta-mender-update-modules

To bind it all together we have the Mender Hub - Update Modules section, which should provide an good overview of available modules and details on how one can use them.

General workflow when contributiing an Update Module:

  1. Create pull-request to mender-update-modules
    • Reference commit of an module contribution can be found here
    • Reference module can be found here
  2. Create a new post in Mender Hub - Update Modules
  3. If you are using Yocto create an pull-request to meta-mender-update-modules
    • Reference module recipes can be found here

Please note that these are only guidelines and should not stop you from sharing even if you do not follow all the mentioned steps. The community is there to help you out.

It is also perfectly fine if you host your Update Module code elsewhere, and it is not a hard requriement to use mender-update-modules repository, but it does make it easier to browse available modules if they are in one single location.

Making edits

All Update Modules topics are wiki posts, so that they can be kept up to date - please edit or suggest changes.

As we encourage open collaboration, anyone is allowed to suggest edits to existing posts. If you are not quite ready to make edits, please feel free to leave a comment instead so maintainers can follow up on your issue.

Creating new topics

You should create a new topic when you have written a new Update Module that is not already covered by a topic. Otherwise, it’s more appropriate to add notes inline to the existing topic or comment in the replies.

When creating a new topic in this category, there is a template to start with. Please use this template, it will help to make sure the information for each Update Module is easy to follow!

Notifications

If you are the owner of a topic, you should receive notifications when an edit is suggested or made. You can click this button below the post to change the level of notifications:

28

We’re here to help

As with anything on the Mender Hub forum, if you have any problems let one of the mods know and we can help you out!

1 Like
unpinned #2
pinned #3