Preparations for release 0.2.0 (#461)

* Promote update server to runtime Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Current status Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * More CQs Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Complete CQs Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Updatesd documentation Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Enable test modules Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Re add examples and extensions Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fixes and roadmap extended Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add release issue link Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add works with CQ. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Documented CQs for #459 Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix shell script Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix CQ table and runtime parent. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix repo entries. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Cleaned up docs. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>
2017-03-30 08:46:31 +02:00
parent c8db41ff85
commit 6d2a108549
53 changed files with 540 additions and 335 deletions
--- a/hawkbit-runtime/hawkbit-update-server/README.md
+++ b/hawkbit-runtime/hawkbit-update-server/README.md
@@ -0,0 +1,75 @@
+# hawkBit Update Server
+The hawkBit Update Server is a standalone spring-boot application with an embedded servlet container .
+
+## Try out the update server in our hawkBit sandbox on Bluemix
+- try out Management UI https://hawkbit.eu-gb.mybluemix.net/UI (username: admin, passwd: admin)
+- try out Management API https://hawkbit.eu-gb.mybluemix.net/rest/v1/targets (don't forget basic auth header; username: admin, passwd: admin)
+- try out DDI API https://hawkbit.eu-gb.mybluemix.net/DEFAULT/controller/v1/MYTESTDEVICE (authentication disabled)
+
+## On your own workstation
+### Run
+```
+java -jar hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-*-SNAPSHOT.jar
+```
+
+_(Note: you have to add the JDBC driver also to your class path if you intend to use another database than H2.)_
+
+Or:
+
+```
+run org.eclipse.hawkbit.app.Start
+```
+
+### Usage
+The Management UI can be accessed via http://localhost:8080/UI
+The Management API can be accessed via http://localhost:8080/rest/v1
+
+## Deploy example app to Cloud Foundry
+
+- Go to ```target``` subfolder.
+- Select one of the two manifests
+ - **manifest-simple.yml** for a standalone hawkBit installation with embedded H2.
+ - **manifest.yml**  for a standalone hawkBit installation with embedded H2 and RabbitMQ service binding for DMF integration (note: this manifest is used for the sandbox above).
+- Run ```cf push``` against you cloud foundry environment.
+
+# Enable Clustering (experimental)
+
+Clustering in hawkBit is based on _Spring Cloud Bus_. It is not enabled in the example app by default.
+
+Add to your `application.properties` :
+
+```
+spring.cloud.bus.enabled=true
+```
+
+Add to your `pom.xml` :
+
+```
+<dependency>
+	<groupId>org.springframework.cloud</groupId>
+	<artifactId>spring-cloud-stream-binder-rabbit</artifactId>
+</dependency>
+```
+
+Optional as well is the addition of [Protostuff](https://github.com/protostuff/protostuff) based message payload serialization for improved performance.
+
+
+Add to your `application.properties` :
+
+```
+spring.cloud.stream.bindings.springCloudBusInput.content-type=application/binary+protostuff
+spring.cloud.stream.bindings.springCloudBusOutput.content-type=application/binary+protostuff
+```
+
+Add to your `pom.xml` :
+
+```
+<dependency>
+	<groupId>io.protostuff</groupId>
+	<artifactId>protostuff-core</artifactId>
+</dependency>
+<dependency>
+	<groupId>io.protostuff</groupId>
+	<artifactId>protostuff-runtime</artifactId>
+</dependency>
+```