global19-atlassian-net / hawkbit

Eclipse hawkBit™

Eclipse hawkBit™ - Update Server

Eclipse hawkBit is an domain independent back end solution for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.

Build:

Docker:

Documentation

see hawkBit Documentation

Contact us

• Having questions about hawkBit? Check Stack Overflow
• Want to chat with the team behind hawkBit?
• Having issues with hawkBit? Open a GitHub issue.
• You can also check out our Project Homepage for further contact options.

Examples and Extensions

Next to the hawkBit core hosted here the project maintains as well examples and extension repositories.

hawkBit sandbox

We offer a sandbox installation that is free for everyone to try out hawkBit. However, keep in mind that the sandbox database will be reset from time to time. It is also not possible to upload any artifacts into the sandbox. But you can use it to try out the Management UI, Management API and DDI API. Keep in mind as well that you are not permitted to store any kind of personal data in the sandbox.

https://hawkbit.eclipse.org

In addition the following vendors offer free trial accounts for their hawkBit compatible products:

• Bosch IoT Rollouts
• Kynetics Update Factory

Device Integration

hawkBit does not provide off the shelf clients for devices as part of the project. The long term goal is to provide an Eclipse hono integration which will provide connectivity through various IoT protocols and as a result allows a wide range of clients to connect to hawkBit. However, the hawkBit Direct Device Integration (API) API is HTTP/JSon based which should allow any update client to integrate quite easily.

There are clients outside of the Eclipse IoT eco system as well, e.g.:

• SWupdate which is a Linux Update agent with focus on a efficient and safe way to update embedded systems.
• rauc-hawkbit which is a python-based hawkBit client application and library for the RAUC update framework.
• hawkbit-rs provides a couple of Rust crates to help implement and test hawkBit clients.

Runtime dependencies and support

Java Runtime Environment: 1.8,11

SQL database

Database	H2	MySQL/MariaDB	MS SQL Server	PostgreSQL	IBM DB2
DDLs maintained by project	✅	✅	✅	✅	✅
Test dependencies defined	✅	✅	✅	✅
Versions tested	1.4	MySQL 5.6/5.7, AWS Aurora	MS SQL Server 2017/2019	PostgreSQL 12/13	DB2 Server v11.1
Docker image with driver provided	✅	✅ (Tag: "-mysql")	✅	✅
JDBC driver	H2 1.4.200	MariaDB Connector/J 2.6.2	MSSQL-JDBC 7.4.1.jre8	PostgreSQL JDBC Driver 42.2.14
Status	Test, Dev	Production grade	Production grade	Test, Dev	Test, Dev

(Optional) RabbitMQ: 3.6,3.7,3.8

Getting Started

We are providing a Spring Boot based reference Update Server including embedded H2 DB for test and evaluation purposes. Run with docker:

docker run -d -p 8080:8080 hawkbit/hawkbit-update-server

Open the update server in your browser:

localhost:8080

See below for how to build and run the update server on your own. In addition we have a guide for setting up a complete landscape.

hawkBit (Spring boot) starters

Next to the Update Server we are also providing a set of Spring Boot Starters to quick start your own Spring Boot based application.

Clone, build and run hawkBit

Build and start hawkBit Update Server

git clone https://github.com/eclipse/hawkbit.git
cd hawkbit
mvn clean install
java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#.jar

Start hawkBit Device Simulator (optional)

git clone https://github.com/eclipse/hawkbit-examples.git
cd hawkbit-examples
mvn clean install

java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar

Generate getting started data with the Management API example (optional)

java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#-exec.jar

Status and API stability

hawkBit is currently in '0.X' semantic version. That is due to the need that there is still content in hawkBit that is in need for refactoring. That includes the maven module structure, Spring Boot Properties, Spring Boot auto configuration as well as internal Java APIs (e.g. the repository API ).

However, the device facing DDI API is on major version 'v1' and will be kept stable.

Server facing and DMF API are Management API are on v1 as well. However, we cannot fully guarantee the same stability during hawkBit's 0.X development but we will try as best we can.