Migrate hawkBit documentation to GitHub Pages Initial
Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com>
This commit is contained in:
66
docs/features.md
Normal file
66
docs/features.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# Features
|
||||
|
||||
---
|
||||
|
||||
## Device and Software Repository
|
||||
|
||||
- Repository that holds the provisioning targets and assignable software distributions.
|
||||
- Targets can be logically grouped by **Target Types**.
|
||||
- Includes a full software update history for every device.
|
||||
- Supports pre-commission devices in the repository and plug and play (device is created when it authenticates for the first time).
|
||||
|
||||
---
|
||||
|
||||
## Update Management
|
||||
|
||||
- Directly deploy a defined software distribution to a device (via Management API).
|
||||
- Update handling is independent of device type, integration approach, or connectivity.
|
||||
- Optional user consent flow: download and install updates only after the respective end user has confirmed it.
|
||||
- Mass cancel distribution of an update by invalidating the distribution set.
|
||||
- Use action status codes for easier analysis.
|
||||
|
||||
---
|
||||
|
||||
## Artifact Content Delivery
|
||||
|
||||
- Partial downloads supported.
|
||||
- Download resume supported (RFC7233).
|
||||
- Content management by RESTful API and UI.
|
||||
- Authorization based on software assignment (a device can only download what was assigned to it).
|
||||
- Delta artifact hosting supported.
|
||||
- Artifact signature hosting supported.
|
||||
- Plug-point for artifact encryption (allows encryption of artifacts on upload).
|
||||
|
||||
---
|
||||
|
||||
## Rollout [Campaign] Management
|
||||
|
||||
- Secure handling of large volumes of devices at rollout creation time.
|
||||
- Flexible deployment group definition as part of a rollout.
|
||||
- Monitoring of rollout progress.
|
||||
- Emergency rollout shutdown in case of update failures.
|
||||
- Manually trigger the next rollout group.
|
||||
|
||||
---
|
||||
|
||||
## Interfaces
|
||||
|
||||
### Management API
|
||||
- RESTful API.
|
||||
- Create/Read/Update/Delete operations for provisioning targets (devices) and repository content (software).
|
||||
- Manage and monitor software update operations.
|
||||
- Online API documentation.
|
||||
- JSON payload with Hypermedia support.
|
||||
- Supports filtering, sorting, and paging.
|
||||
|
||||
### Direct Device Integration API
|
||||
- RESTful HTTP-based API for direct device integration.
|
||||
- JSON payload.
|
||||
- Traffic optimized (content-based ETag generation, not modified).
|
||||
- Feedback channel from device.
|
||||
- TLS encryption.
|
||||
|
||||
### Device Management Federation API
|
||||
- Indirect device integration through a device management service or application into hawkBit.
|
||||
- Optimized for high service-to-service throughput with AMQP messaging interface.
|
||||
- Separate AMQP vHost per tenant for maximum security.
|
||||
Reference in New Issue
Block a user