889d1492fb
* Migrated target management queries to IDs inetsead of full entities Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Added missing comment. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * refactored target,DS,cont,deploy,rg mangement. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Adde versioning documentation. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Rollout, Dist and Software mgmt refactored Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Readded line that was remove by incident. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fixed broken tests. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Query management refactored Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix bug of auto assign DS delete Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Switch to collection Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fixed compile error Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Small glitches Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fixed test after merge Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>
69 lines
4.6 KiB
Markdown
69 lines
4.6 KiB
Markdown
<img src=hawkbit_logo.png width=533 height=246 />
|
|
|
|
# Eclipse hawkBit™ - Update Server
|
|
|
|
Eclipse [hawkBit](https://projects.eclipse.org/projects/iot.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: [](https://circleci.com/gh/eclipse/hawkbit)
|
|
[](https://www.codacy.com/app/kai-zimmermann/hawkbit?utm_source=github.com&utm_medium=referral&utm_content=eclipse/hawkbit&utm_campaign=Badge_Grade) [](https://sonar.eu-gb.mybluemix.net) [](https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent)
|
|
|
|
# Documentation
|
|
|
|
see [hawkBit Documentation](https://www.eclipse.org/hawkbit/documentation/overview/introduction.html)
|
|
|
|
# Contact us
|
|
|
|
* Want to chat with the team behind hawkBit? [](https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
* Having issues with hawkBit? Open a [GitHub issue](https://github.com/eclipse/hawkbit/issues).
|
|
* You can also check out our [Project Homepage](https://projects.eclipse.org/projects/iot.hawkbit) for further contact options.
|
|
|
|
# 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.
|
|
|
|
https://hawkbit.eu-gb.mybluemix.net/UI/
|
|
|
|
# Compile, Run and Getting Started
|
|
|
|
We are not providing an off the shelf installation ready hawkBit update server. However, we recommend to check out the [Example Application](examples/hawkbit-example-app) for a runtime ready Spring Boot based update server that is empowered by hawkBit. In addition we have [guide](https://github.com/eclipse/hawkbit/wiki/Run-hawkBit) for setting up a complete landscape.
|
|
|
|
# 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](https://github.com/eclipse/hawkbit/issues/197) ).
|
|
|
|
However, the external APIs (i.e. [Management API](https://github.com/eclipse/hawkbit/tree/master/hawkbit-mgmt-api), [DDI API](https://github.com/eclipse/hawkbit/tree/master/hawkbit-ddi-api), [DDI Artifact Download API](https://github.com/eclipse/hawkbit/tree/master/hawkbit-ddi-dl-api) and [DMF API](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf-api) are on major version 'v1' and will be kept stable.
|
|
|
|
# hawkBit (Spring boot) starters
|
|
|
|
Next to the [Example Application](examples/hawkbit-example-app) we are also providing a set of [Spring Boot Starters](hawkbit-starters) to quick start your own [Spring Boot](https://projects.spring.io/spring-boot/) based application.
|
|
|
|
#### Clone and build hawkBit
|
|
```
|
|
$ git clone https://github.com/eclipse/hawkbit.git
|
|
$ cd hawkbit
|
|
$ mvn clean install
|
|
```
|
|
#### Start hawkBit example app
|
|
[Example Application](examples/hawkbit-example-app)
|
|
```
|
|
$ java -jar ./examples/hawkbit-example-app/target/hawkbit-example-app-#version#.jar
|
|
```
|
|
#### Start hawkBit device simulator
|
|
[Device Simulator](examples/hawkbit-device-simulator)
|
|
```
|
|
$ java -jar ./examples/hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
|
|
```
|
|
#### Generate Getting Started data
|
|
[Example Management API Client](examples/hawkbit-example-mgmt-simulator)
|
|
```
|
|
$ java -jar ./examples/hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#.jar
|
|
```
|
|
|
|
# Releases and Roadmap
|
|
|
|
* We are currently working on the first formal release under the Eclipse banner: 0.1 (see [Release 0.1 branch](https://github.com/eclipse/hawkbit/tree/release-train-0.1)).
|
|
* The master branch contains future development towards 0.2. We are currently focusing on:
|
|
* Rollout Management for large scale rollouts.
|
|
* Clustering capabilities for the update server.
|
|
* Upgrade of Spring Boot and Vaadin dependencies.
|
|
* And of course tons of usability improvements and bug fixes. |