lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Sandbox uri and user includes DEMO hint (#692)

Browse Source 
* New sandbox name und users.

* Fix controllerId in DDI docs.

* Optimise README set new creds

* Revert accidental checkin

* Fix typo.

* Cleanup text.

* Merge
This commit is contained in:
Kai Zimmermann
2018-06-06 16:52:34 +02:00
committed by Dominic Schabel
parent 5c4075290e
commit d8ad9f6ef0
8 changed files with 35 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -73,7 +73,7 @@ Examples for hawkBit components:
@Stories("Distribution Set Type Resource")
```
In addition all test method's name describes in **camel case** what the test is all about and has a long description auth Allures **@Description** annotation.
In addition all test method's name describes in **camel case** what the test is all about and has in addition a long description in Allures **@Description** annotation.
## Legal considerations for your contribution
@@ -89,9 +89,7 @@ Contributor Agreement (ECA) on file.
For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit
"Sign-off" your commits:
Every commit you make in your patch or pull request MUST be "signed off".
HowTo "Sign-off" your commits:
You do this by adding the `-s` flag when you make the commit(s), e.g.

23
README.md
View File

@@ -26,9 +26,9 @@ Next to the hawkBit core hosted here the project maintains as well [examples](ht
# 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.
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.eu-gb.mybluemix.net/UI/
https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/UI/
In addition the following vendors offer free trial accounts for their hawkBit compatible products:
@@ -44,7 +44,6 @@ There are clients outside of the Eclipse IoT eco system as well, e.g.:
* [rauc-hawkbit](https://github.com/rauc/rauc-hawkbit) which is a python-based hawkBit client application and library for the [RAUC](https://github.com/rauc/rauc) update framework.
# Runtime dependencies and support
## Java Runtime Environment: 1.8
@@ -52,12 +51,12 @@ There are clients outside of the Eclipse IoT eco system as well, e.g.:
## SQL database
| Database | H2 | MySQL/MariaDB | MS SQL Server | IBM DB2 |
|---|---|---|---|---|
| DDLs maintained by project | X | X | X | X |
| Test dependencies defined | X | X | X | - |
|---|:---:|:---:|:---:|:---:|
| DDLs maintained by project | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Test dependencies defined | :white_check_mark: | :white_check_mark: | :white_check_mark: | |
| Versions tested | 1.4 | MySQL 5.6/5.7, AWS Aurora | MS SQL Server 2017 | DB2 Server v11.1 |
| Docker image with driver provided | X | X (Tag: "-mysql") | X | - |
| JDBC driver | [H2 1.4](https://github.com/h2database/h2database) | [MariaDB Connector/J 2.0](https://github.com/MariaDB/mariadb-connector-j) | [MSSQL-JDBC 6.4](https://github.com/Microsoft/mssql-jdbc) | - |
| Docker image with driver provided | :white_check_mark: | :white_check_mark: (Tag: "-mysql") | :white_check_mark: | |
| JDBC driver | [H2 1.4](https://github.com/h2database/h2database) | [MariaDB Connector/J 2.0](https://github.com/MariaDB/mariadb-connector-j) | [MSSQL-JDBC 6.4](https://github.com/Microsoft/mssql-jdbc) | |
| Status | Test, Dev, Trial | Production grade | Production grade | Test, Dev |
## (Optional) RabbitMQ: 3.6,3.7
@@ -86,7 +85,7 @@ Next to the [Update Server](hawkbit-runtime/hawkbit-update-server) we are also p
## Build and start hawkBit [Update Server](hawkbit-runtime/hawkbit-update-server)
```
```bash
$ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit
$ mvn clean install
@@ -95,19 +94,19 @@ $ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server
## Start hawkBit [Device Simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator) (optional)
```
```bash
$ git clone https://github.com/eclipse/hawkbit-examples.git
$ cd hawkbit-examples
$ mvn clean install
```
```
```bash
$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
```
## Generate getting started data with the [Management API example](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator) (optional)
```
```bash
$ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#-exec.jar
```

2
deployHawkBitSandbox.sh
View File

@@ -17,7 +17,7 @@ cf stop hawkbit-simulator
cd hawkbit-runtime/hawkbit-update-server/target/
cf push
cd ../../../../hawkbit-examples/
java -jar hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-0.2.0-SNAPSHOT-exec.jar --hawkbit.url=https://hawkbit.eu-gb.mybluemix.net
java -jar hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-0.2.0-SNAPSHOT-exec.jar --hawkbit.url=https://hawkbit-demo-sandbox.eu-gb.mybluemix.net --hawkbit.username=demo --hawkbit.password=demo
cd hawkbit-device-simulator/target/
cf push
cd ../../..

4
docs/src/main/resources/documentation/overview/getting-started.md
View File

@@ -7,9 +7,9 @@ title: Getting Started
# 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.
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.
[hawkbit-sandbox](https://hawkbit.eu-gb.mybluemix.net/UI/)
[hawkbit-sandbox](https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/UI/)
# Compile, Run and Getting Started

16
hawkbit-rest/hawkbit-rest-docs/src/main/asciidoc/rootcontroller-api-guide.adoc
View File

@@ -11,7 +11,7 @@
toc::[]
== GET /{tenant}/controller/v1/{targetid}
== GET /{tenant}/controller/v1/{controllerid}
=== Implementation notes
@@ -65,7 +65,7 @@ include::../errors/429.adoc[]
|===
== GET /{tenant}/controller/v1/{targetid}/cancelAction/{actionId}
== GET /{tenant}/controller/v1/{controllerid}/cancelAction/{actionId}
=== Implementation notes
@@ -110,7 +110,7 @@ include::../errors/429.adoc[]
== POST /{tenant}/controller/v1/{targetid}/cancelAction/{actionId}/feedback
== POST /{tenant}/controller/v1/{controllerid}/cancelAction/{actionId}/feedback
=== Implementation notes
@@ -151,7 +151,7 @@ include::../errors/415.adoc[]
include::../errors/429.adoc[]
|===
== PUT /{tenant}/controller/v1/{targetid}/configData
== PUT /{tenant}/controller/v1/{controllerid}/configData
=== Implementation notes
@@ -193,7 +193,7 @@ include::../errors/429.adoc[]
|===
== GET /{tenant}/controller/v1/{targetid}/deploymentBase/{actionId}
== GET /{tenant}/controller/v1/{controllerid}/deploymentBase/{actionId}
=== Implementation notes
@@ -260,7 +260,7 @@ include::../errors/429.adoc[]
== POST /{tenant}/controller/v1/{targetid}/deploymentBase/{actionId}/feedback
== POST /{tenant}/controller/v1/{controllerid}/deploymentBase/{actionId}/feedback
=== Implementation notes
@@ -302,7 +302,7 @@ include::../errors/415.adoc[]
include::../errors/429.adoc[]
|===
////
== GET /{tenant}/controller/v1/{targetid}/softwaremodules
== GET /{tenant}/controller/v1/{controllerid}/softwaremodules
=== Implementation notes
@@ -346,7 +346,7 @@ include::../errors/429.adoc[]
|===
////
== GET /{tenant}/controller/v1/{targetid}/softwaremodules/{softwareModuleId}/artifacts
== GET /{tenant}/controller/v1/{controllerid}/softwaremodules/{softwareModuleId}/artifacts
=== Implementation notes

6
hawkbit-runtime/hawkbit-update-server/README.md
View File

@@ -2,9 +2,9 @@
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)
- try out Management UI https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/UI (username: admin, passwd: admin)
- try out Management API https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/rest/v1/targets (don't forget basic auth header; username: admin, passwd: admin)
- try out DDI API https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/DEFAULT/controller/v1/MYTESTDEVICE (authentication disabled)
## On your own workstation
### Run

2
hawkbit-runtime/hawkbit-update-server/cf/manifest.yml
View File

@@ -9,7 +9,7 @@
---
applications:
- name: hawkbit
- name: hawkbit-demo-sandbox
memory: 2048M
disk_quota: 2048M
instances: 1

8
hawkbit-runtime/hawkbit-update-server/src/main/resources/application-cloudsandbox.properties
View File

@@ -20,7 +20,7 @@ spring.http.multipart.max-request-size=-1
hawkbit.artifact.url.protocols.download-http.rel=download-http
hawkbit.artifact.url.protocols.download-http.protocol=https
hawkbit.artifact.url.protocols.download-http.supports=DMF,DDI
hawkbit.artifact.url.protocols.download-http.hostname=hawkbit.eu-gb.mybluemix.net
hawkbit.artifact.url.protocols.download-http.hostname=hawkbit-demo-sandbox.eu-gb.mybluemix.net
hawkbit.artifact.url.protocols.download-http.ref={protocol}://{hostname}/{tenant}/controller/v1/{controllerId}/softwaremodules/{softwareModuleId}/artifacts/{artifactFileName}
hawkbit.artifact.url.protocols.md5sum-http.rel=md5sum-http
hawkbit.artifact.url.protocols.md5sum-http.protocol=${hawkbit.artifact.url.protocols.download-http.protocol}
@@ -28,3 +28,9 @@ hawkbit.artifact.url.protocols.md5sum-http.supports=DDI
hawkbit.artifact.url.protocols.md5sum-http.hostname=${hawkbit.artifact.url.protocols.download-http.hostname}
hawkbit.artifact.url.protocols.md5sum-http.ref=${hawkbit.artifact.url.protocols.download-http.ref}.MD5SUM
## Configuration for building download URLs - END
security.user.name=demo
security.user.password=demo
hawkbit.server.ui.demo.password=${security.user.name}
hawkbit.server.ui.demo.user=${security.user.name}