aheimberger/hawkbit-101

Material for hawkBit 101

hawkBit-101 Tutorial

This repository provides a hands-on tutorial to get familiar with Eclipse hawkBit™, in particular its APIs. Eclipse hawkBit™ is a domain-independent backend framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways that are connected to a IP-based networking infrastructure.

The tutorial was originally created for and held at EclipseCon Europe 2019 and is meant for a technical target audience which can include beginners as well as developers who already acquired some basic knowledge about hawkBit. To conduct the tutorial, it is recommended to walk the participants through the different steps using the slides that are available here.

The tutorial has four parts covering the most important workflows /use cases:

• Provisioning a device
• Creating an update
• Updating a single device
• Updating many devices

Setup Instructions

It is recommended to run the tutorial against the hawkBit setup which is available in this repository as a Docker stack. The Docker stack includes a hawkBit Update Server including the required infrastructure components (a MySQL database and a RabbitMQ message broker). In addition, it includes a device simulator which can be used to simulate a fleet of devices that are connected to the update server. Find the concrete setup instructions in the supporting slide deck on slide 9.

To execute the different API requests, the participants can either use the command line tool curl or a Postman client (ideally version 6 or higher). To support the participants in doing that (and rid them from typing too much), the slides offer small inline links to copy the commands into the clipboard. In addition, there is a Postman collection which can be imported into Postman as well as a text file listing all of the different curl commands.