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

Update getting started (#2094)

Browse Source 
- remove sandbox references (will be removed soon)
- fix static user management description
- remove device simulator - shall be used sdk

Signed-off-by: Avgustin Marinov <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
2024-11-21 12:45:42 +02:00
committed by GitHub
parent 3a28dab8f2
commit eb9d9c7b84
5 changed files with 24 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docker/README.md
View File

@@ -37,7 +37,7 @@ $ docker compose -f docker-compose-monolith-mysql.yml down
# Configuration
You can override application.properties by setting an environment variable SPRING_APPLICATION_JSON for hawkbit container.
```
```yaml
hawkbit:
image: "hawkbit/hawkbit-update-server:latest"
environment:
@@ -46,6 +46,11 @@ hawkbit:
"spring.rabbitmq.host": "rabbitmq",
"spring.rabbitmq.username": "guest",
"spring.rabbitmq.password": "guest",
# should remove default admin/admin user
"hawkbit.security.user.admin.tenant": "#{null}",
"hawkbit.security.user.admin.password": "#{null}",
"hawkbit.security.user.admin.roles": "#{null}",
# should add hawkbit/isAwesome! user
"hawkbit.security.user.hawkbit.tenant": "DEFAULT",
"hawkbit.security.user.hawkbit.password": "{noop}isAwesome!",
"hawkbit.security.user.hawkbit.roles": "TENANT_ADMIN"

2
hawkbit-ddi/hawkbit-ddi-server/README.md
View File

@@ -32,7 +32,7 @@ auto assignment checker and rollouts executor. To run multiple management server
of hawkbit to ensure that they wont run schedulers simultaneously or you shall configure all instances but one to do not
run schedulers!
## Optional Protostuff for Sprign cloud bus
## Optional Protostuff for Spring cloud bus
The micro-service instances are configured to communicate via Spring Cloud Bus. Optionally, you could
use [Protostuff](https://github.com/protostuff/protostuff) based message payload serialization for improved performance.

2
hawkbit-mgmt/hawkbit-mgmt-server/README.md
View File

@@ -32,7 +32,7 @@ auto assignment checker and rollouts executor. To run multiple management server
of hawkbit to ensure that they wont run schedulers simultaneously or you shall configure all instances but one to do not
run schedulers!
## Optional Protostuff for Sprign cloud bus
## Optional Protostuff for Spring cloud bus
The micro-service instances are configured to communicate via Spring Cloud Bus. Optionally, you could
use [Protostuff](https://github.com/protostuff/protostuff) based message payload serialization for improved performance.

55
site/content/gettingstarted.md
View File

@@ -3,30 +3,11 @@ title: Getting Started
weight: 20
---
## On Sandbox
We offer a sandbox installation that is free for everyone to try out hawkBit's [Management UI](/hawkbit/ui/),
[Management API](/hawkbit/apis/management_api/), and [Direct Device Integration API](/hawkbit/apis/ddi_api/): &nbsp;
**[<i class="fas fa-desktop">&nbsp;</i> https://hawkbit.eclipseprojects.io](https://hawkbit.eclipseprojects.io)**
{{% warning %}}
The sandbox is a shared installation that will be reset from time to time. Therefore, it is not allowed to upload
any personal data.
{{% /warning %}}
In addition, the following vendors offer free trial accounts for their Eclipse hawkBit compatible products:
* [Bosch IoT Rollouts](https://bosch-iot-suite.com/service/rollouts/) (
by [Bosch Digital](https://www.bosch-digital.com))
* [Kynetics Update Factory](https://www.kynetics.com/update-factory) (by [Kynetics LLC](https://www.kynetics.com/))
## From Docker Image
### Overview
HawkBit Update Server username/password -> admin/admin as default login credentials. They can be overridden by the
environment variables spring.security.user.name and spring.security.user.password which are defined in the corresponding
default [application.properties](hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties).
HawkBit Update Server default user has _admin/admin_ as default credentials. See below how the user can be changed.
It supports two configurations:
@@ -68,31 +49,27 @@ $ docker-compose -f docker-compose-micro-service-mysql.yml up -d
```sh
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
$ cd hawkbit
$ mvn clean install
$ mvn clean install -DskipTests
```
### 2: Start hawkBit [update server](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server) (Monolith)
```sh
$ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#-SNAPSHOT.jar
$ java -jar ./hawkbit-monolith/hawkbit-update-server/target/hawkbit-update-server-0-SNAPSHOT.jar
```
### 3: Build hawkBit examples
```sh
$ git clone https://github.com/eclipse-hawkbit/hawkbit-examples.git
$ cd hawkbit-examples
$ mvn clean install
### 3: Change credentials
As stated before the default user is _admin/admin_. It could be overridden by changing the [TenantAwareUserProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/TenantAwareUserProperties.java) configuration using Spring ways. For instance, using a properties file like:
```properties
# should remove the admin/admin user
hawkbit.security.user.admin.tenant=#{null}
hawkbit.security.user.admin.password=#{null}
hawkbit.security.user.admin.roles=#{null}
# should add a hawkbit/isAwesome! user
hawkbit.security.user.hawkbit.tenant=DEFAULT
hawkbit.security.user.hawkbit.password={noop}isAwesome!
hawkbit.security.user.hawkbit.roles=TENANT_ADMIN
```
which should remove the default _admin/admin_ user and add a hawkbit user _hawkbit_ with password _isAwesome!_ and a role _TENANT_ADMIN_.
### 4: Start hawkBit [Device Simulator](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-device-simulator)
```sh
$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
```
### 5: Generate Getting Started data with [Example Management API Client](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator)
```sh
$ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#.jar
```
You could create multiple users with specified roles.

4
site/content/sandbox.md
View File

@@ -1,4 +0,0 @@
---
title: Sandbox
redirectURL: https://hawkbit.eclipseprojects.io
---