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

Fix markdown formatting of some documentation tables (#1315)

Browse Source 
* Fix markdown formatting of release tables
* Fix markdown table formatting in documentation

Signed-off-by: Zygmunt Krynicki <me@zygoon.pl>
This commit is contained in:
Zygmunt Krynicki
2023-02-01 15:18:30 +01:00
committed by GitHub
parent 4bf0f878be
commit 498c9fa7e8
7 changed files with 339 additions and 346 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.3rd-party/0.2.0/Release_0_2_0.md vendored
View File

@@ -3,7 +3,7 @@
## Eclipse CQs - Provided/compile ## Eclipse CQs - Provided/compile
| Group ID | Artifact ID | Version | CQ | | Group ID | Artifact ID | Version | CQ |
|---|---|---|---| |--------------------------------------|--------------------------------|----------------|------------------------------------------------------------------|
| com.microsoft.sqlserver | mssql-jdbc | 6.4.0 | [CQ15896](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=15896) | | com.microsoft.sqlserver | mssql-jdbc | 6.4.0 | [CQ15896](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=15896) |
| com.cronutils | cron-utils | 5.0.5 | [CQ15762](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=15762) | | com.cronutils | cron-utils | 5.0.5 | [CQ15762](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=15762) |
| com.github.ben-manes.caffeine | caffeine | 2.3.5 | [CQ13563](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=13563) | | com.github.ben-manes.caffeine | caffeine | 2.3.5 | [CQ13563](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=13563) |
@@ -123,7 +123,7 @@
Works with CQ: [CQ13040](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=13040) Works with CQ: [CQ13040](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=13040)
| Group ID | Artifact ID | Version | | Group ID | Artifact ID | Version |
|---|---|---| |---------------------------------|----------------------------------|---------------|
| asm | asm | 3.3.1 | | asm | asm | 3.3.1 |
| cglib | cglib-nodep | 3.1 | | cglib | cglib-nodep | 3.1 |
| com.google.gwt.gwtmockito | gwtmockito | 1.1.6 | | com.google.gwt.gwtmockito | gwtmockito | 1.1.6 |

6
.3rd-party/0.3.0M6/Release_0_3_0M6.md vendored
View File

@@ -3,7 +3,7 @@
## Eclipse CQs - Provided/compile ## Eclipse CQs - Provided/compile
| Group ID | Artifact ID | Version | CQ | | Group ID | Artifact ID | Version | CQ |
| ------------------------------------ | -------------------------------------- | -------------- | ---------------------------------------------------------------- | |--------------------------------------|----------------------------------------|----------------|------------------------------------------------------------------|
| ch.qos.logback | logback-classic | 1.2.3 | [CQ17369](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=17369) | | ch.qos.logback | logback-classic | 1.2.3 | [CQ17369](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=17369) |
| ch.qos.logback | logback-core | 1.2.3 | [CQ17370](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=17370) | | ch.qos.logback | logback-core | 1.2.3 | [CQ17370](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=17370) |
| com.cronutils | cron-utils | 5.0.5 | [CQ15762](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=15762) | | com.cronutils | cron-utils | 5.0.5 | [CQ15762](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=15762) |
@@ -66,7 +66,7 @@
| org.ow2.asm | asm-commons | 6.2 | [CQ18183](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18183) | | org.ow2.asm | asm-commons | 6.2 | [CQ18183](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18183) |
| org.ow2.asm | asm | 6.2 | [CQ18183](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18183) | | org.ow2.asm | asm | 6.2 | [CQ18183](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18183) |
| org.ow2.asm | asm-tree | 6.2 | [CQ18183](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18183) | | org.ow2.asm | asm-tree | 6.2 | [CQ18183](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18183) |
| org.postgresql | postgresql | 42.2.5 | CQ17092 Piggybacked | org.postgresql | postgresql | 42.2.5 | CQ17092 Piggybacked |
| org.reactivestreams | reactive-streams | 1.0.2 | [CQ18184](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18184) | | org.reactivestreams | reactive-streams | 1.0.2 | [CQ18184](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18184) |
| org.slf4j | jul-to-slf4j | 1.7.25 | [CQ12937](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=12937) | | org.slf4j | jul-to-slf4j | 1.7.25 | [CQ12937](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=12937) |
| org.slf4j | slf4j-api | 1.7.25 | [CQ12940](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=12940) | | org.slf4j | slf4j-api | 1.7.25 | [CQ12940](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=12940) |
@@ -132,7 +132,7 @@
CQ: [CQ18804](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18804) CQ: [CQ18804](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=18804)
| Group ID | Artifact ID | Version | | Group ID | Artifact ID | Version |
| ------------------------------- | -------------------------------- | -------------------- | |---------------------------------|----------------------------------|----------------------|
| ant | ant | 1.6.5 | | ant | ant | 1.6.5 |
| colt | colt | 1.2.0 | | colt | colt | 1.2.0 |
| com.fasterxml.jackson.module | jackson-module-jaxb-annotations | 2.9.8 | | com.fasterxml.jackson.module | jackson-module-jaxb-annotations | 2.9.8 |

4
.3rd-party/Release_0_3_0.md vendored
View File

@@ -3,7 +3,7 @@
## Eclipse CQs - Provided/compile ## Eclipse CQs - Provided/compile
| Group ID | Artifact ID | Version | CQ | | Group ID | Artifact ID | Version | CQ |
| -------------------------------- | --------------------- | ------- | --------------------------------------------------------------------- | |----------------------------------|-----------------------|---------|-----------------------------------------------------------------------|
| com.github.gwtd3 | gwt-d3-api | 1.3.0 | [CQ22964](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=22964) | | com.github.gwtd3 | gwt-d3-api | 1.3.0 | [CQ22964](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=22964) |
| com.google.jsinterop | jsinterop-annotations | 1.0.2 | [CQ22981](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=22981) | | com.google.jsinterop | jsinterop-annotations | 1.0.2 | [CQ22981](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=22981) |
| com.vaadin | vaadin-themes | 8.12.3 | [CQ23069](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=23069) | | com.vaadin | vaadin-themes | 8.12.3 | [CQ23069](https://dev.eclipse.org/ipzilla/show_bug.cgi?id=23069) |
@@ -14,7 +14,7 @@
## Test and build dependencies ## Test and build dependencies
| Group ID | Artifact ID | Version | | Group ID | Artifact ID | Version |
| ---------------------------- | ----------------------- | ------------- | |------------------------------|-------------------------|---------------|
| javax.el | javax.el-api | 2.2.4 | | javax.el | javax.el-api | 2.2.4 |
| org.assertj | assertj-core | 3.16.1 | | org.assertj | assertj-core | 3.16.1 |
| org.awaitility | awaitility | 3.1.2 | | org.awaitility | awaitility | 3.1.2 |

277
docs/content/apis/dmf_api.md
View File

@@ -40,24 +40,23 @@ Note: the DMF protocol was intended to be compatible to other use cases by desig
Message to register and update a provisioning target. Message to register and update a provisioning target.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
-------------- | ------------------------------------------------ | ---------------------------- | ------------------------------------------------------------- |---------|------------------------------------------------|------------------------------|-----------|
type | Type of the message | Fixed string "THING_CREATED" | true | type | Type of the message | Fixed string "THING_CREATED" | true |
thingId | The ID of the registered provisioning target | String | true | thingId | The ID of the registered provisioning target | String | true |
tenant | The tenant this provisioning target belongs to | String | true | tenant | The tenant this provisioning target belongs to | String | true |
sender | Name of the message sender | String | false | sender | Name of the message sender | String | false |
| Message Properties | Description | Type | Mandatory |
Message Properties | Description | Type | Mandatory |--------------------|---------------------------------|--------|-----------|
------------------ | ---------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------- | content_type | The content type of the payload | String | true |
content_type | The content type of the payload | String | true | reply_to | Exchange to reply to | String | true |
reply_to | Exchange to reply to | String | true
Example headers and payload: Example headers and payload:
Header | MessageProperties | Header | MessageProperties |
----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |--------------------------------------------------------------------------------------|--------------------------------------------------------------------|
type=THING\_CREATED <br /> tenant=default <br /> thingId=abc <br /> sender=myClient | content\_type=application/json <br /> reply_to=myExchangeToReplyTo | type=THING\_CREATED <br /> tenant=default <br /> thingId=abc <br /> sender=myClient | content\_type=application/json <br /> reply_to=myExchangeToReplyTo |
Payload Template (optional): Payload Template (optional):
@@ -82,34 +81,32 @@ The "attributeUpdate" property provides the attributes of the thing, for details
Message to request the deletion of a provisioning target. Message to request the deletion of a provisioning target.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
-------------- | ------------------------------------------------ | ---------------------------- | ------------------------------------------------------------- |---------|------------------------------------------------|------------------------------|-----------|
type | Type of the message | Fixed string "THING_REMOVED" | true | type | Type of the message | Fixed string "THING_REMOVED" | true |
thingId | The ID of the registered provisioning target | String | true | thingId | The ID of the registered provisioning target | String | true |
tenant | The tenant this provisioning target belongs to | String | false | tenant | The tenant this provisioning target belongs to | String | false |
Message Properties | Description | Type | Mandatory | Message Properties | Description | Type | Mandatory |
------------------ | ---------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------- |--------------------|---------------------------------|--------|-----------|
content_type | The content type of the payload | String | true | content_type | The content type of the payload | String | true |
Example headers Example headers
Header | MessageProperties | Header | MessageProperties |
----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |--------------------------------------------------------------|--------------------------------|
type=THING\_REMOVED <br /> tenant=default <br /> thingId=abc | content\_type=application/json | type=THING\_REMOVED <br /> tenant=default <br /> thingId=abc | content\_type=application/json |
### UPDATE_ATTRIBUTES ### UPDATE_ATTRIBUTES
Message to update target attributes. This message can be send in response to a REQUEST_ATTRIBUTES_UPDATE event, sent by hawkBit. Message to update target attributes. This message can be send in response to a REQUEST_ATTRIBUTES_UPDATE event, sent by hawkBit.
| Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
|-----------------------------|----------------------------------|-------------------------------------|---------------- |---------|----------------------------------|----------------------------------|-----------|
| type | Type of the message | Fixed string "EVENT" | true | type | Type of the message | Fixed string "EVENT" | true |
| topic | Topic name identifying the event | Fixed string "UPDATE_ATTRIBUTES" | true | topic | Topic name identifying the event | Fixed string "UPDATE_ATTRIBUTES" | true |
| thingId | The ID of the registered thing | String | true | thingId | The ID of the registered thing | String | true |
| tenant | The tenant this thing belongs to | String | false | tenant | The tenant this thing belongs to | String | false |
| Message Properties | Description | Type | Mandatory | | Message Properties | Description | Type | Mandatory |
|-----------------------------|----------------------------------|--------|-----------| |-----------------------------|----------------------------------|--------|-----------|
@@ -118,8 +115,8 @@ Message to update target attributes. This message can be send in response to a R
Example header and payload: Example header and payload:
| Header | MessageProperties | | Header | MessageProperties |
|---------------------------------------|---------------------------------| |--------------------------------------------------------------------------------------|---------------------------------------|
| type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=UPDATE\_ATTRIBUTES | content\_type=application/json <br /> | type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=UPDATE\_ATTRIBUTES | content\_type=application/json <br /> |
Payload Template: Payload Template:
@@ -135,26 +132,25 @@ Payload Template:
The "mode" property specifies the update mode that should be applied. This property is optional. Possible [mode](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfUpdateMode.java) values: The "mode" property specifies the update mode that should be applied. This property is optional. Possible [mode](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfUpdateMode.java) values:
Value | Description | Value | Description |
--------------- | --------------------------------------- |---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
MERGE | The target attributes specified in the payload are merged into the existing attributes. This is the default mode that is applied if no "mode" property is specified in the payload. | MERGE | The target attributes specified in the payload are merged into the existing attributes. This is the default mode that is applied if no "mode" property is specified in the payload. |
REPLACE | The existing attributes are replaced with the target attributes specified in the payload. | REPLACE | The existing attributes are replaced with the target attributes specified in the payload. |
REMOVE | The target attributes specified in the payload are removed from the existing attributes. | REMOVE | The target attributes specified in the payload are removed from the existing attributes. |
### UPDATE_ACTION_STATUS ### UPDATE_ACTION_STATUS
Message to send an action status event to hawkBit. Message to send an action status event to hawkBit.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
------ | -------------------------------- | ----------------------------------- | ------------------------------------------------------------- |--------|----------------------------------|-------------------------------------|-----------|
type | Type of the message | Fixed string "EVENT" | true | type | Type of the message | Fixed string "EVENT" | true |
topic | Topic name identifying the event | Fixed string "UPDATE_ACTION_STATUS" | true | topic | Topic name identifying the event | Fixed string "UPDATE_ACTION_STATUS" | true |
tenant | The tenant this thing belongs to | String | false | tenant | The tenant this thing belongs to | String | false |
Message Properties | Description | Type | Mandatory | Message Properties | Description | Type | Mandatory |
------------------ | ------------------------------- | ------ | ------------------------------------------------------------- |--------------------|---------------------------------|--------|-----------|
content_type | The content type of the payload | String | true | content_type | The content type of the payload | String | true |
Payload Template (the Java representation is [ActionUpdateStatus](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionUpdateStatus.java)): Payload Template (the Java representation is [ActionUpdateStatus](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionUpdateStatus.java)):
@@ -169,23 +165,23 @@ Payload Template (the Java representation is [ActionUpdateStatus](https://github
Possible [actionStatus](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionStatus.java) values: Possible [actionStatus](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionStatus.java) values:
Value | Description | Value | Description |
--------------- | --------------------------------------- |-----------------|-----------------------------------------|
DOWNLOAD | Device is downloading | DOWNLOAD | Device is downloading |
DOWNLOADED | Device completed download | DOWNLOADED | Device completed download |
RETRIEVED | Device has retrieved the artifact | RETRIEVED | Device has retrieved the artifact |
RUNNING | Update is running | RUNNING | Update is running |
FINISHED | Update process finished successful | FINISHED | Update process finished successful |
ERROR | Error during update process | ERROR | Error during update process |
WARNING | Warning during update process | WARNING | Warning during update process |
CANCELED | Cancel update process successful | CANCELED | Cancel update process successful |
CANCEL_REJECTED | Cancel update process has been rejected | CANCEL_REJECTED | Cancel update process has been rejected |
Example header and payload: Example header and payload:
Header | MessageProperties | Header | MessageProperties |
----------------------------------------------------------------------- | ----------------------------- |-----------------------------------------------------------------------|-------------------------------|
type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json | type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json |
```json ```json
{ {
@@ -200,16 +196,14 @@ type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_
hawkBit allows DMF clients to check the availability of the DMF service. For this scenario DMF specifies a PING message that can be sent by the client: hawkBit allows DMF clients to check the availability of the DMF service. For this scenario DMF specifies a PING message that can be sent by the client:
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
------- | -------------------------------- | ------------------------------ | ------------------------------------------------------------- |--------|--------------------------------|---------------------|-----------|
type | Type of the message | Fixed string "PING" | true | type | Type of the message | Fixed string "PING" | true |
tenant | The tenant the PING belongs to | String | false | tenant | The tenant the PING belongs to | String | false |
Message Properties | Description | Type | Mandatory
------------------ | ------------------------------- | ------ | -------------------------------------------------------------
correlationId | CorrelationId that allows the client to map a PING request to PING_RESPONSE | String | true
| Message Properties | Description | Type | Mandatory |
|--------------------|-----------------------------------------------------------------------------|--------|-----------|
| correlationId | CorrelationId that allows the client to map a PING request to PING_RESPONSE | String | true |
## Messages sent by hawkBit (hawkBit -> Client) ## Messages sent by hawkBit (hawkBit -> Client)
@@ -217,16 +211,16 @@ correlationId | CorrelationId that allows the client to map a PING request to PI
Message to cancel an update task. Message to cancel an update task.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
------- | -------------------------------- | ------------------------------ | ------------------------------------------------------------- |---------|------------------------------------------------|--------------------------------|-----------|
type | Type of the message | Fixed string "Event" | true | type | Type of the message | Fixed string "Event" | true |
thingId | The ID of the registered provisioning target | String | true | thingId | The ID of the registered provisioning target | String | true |
topic | Topic name identifying the event | Fixed string "CANCEL_DOWNLOAD" | true | topic | Topic name identifying the event | Fixed string "CANCEL_DOWNLOAD" | true |
tenant | The tenant this provisioning target belongs to | String | false | tenant | The tenant this provisioning target belongs to | String | false |
Message Properties | Description | Type | Mandatory | Message Properties | Description | Type | Mandatory |
------------------ | ------------------------------- | ------ | ------------------------------------------------------------- |--------------------|---------------------------------|--------|-----------|
content_type | The content type of the payload | String | true | content_type | The content type of the payload | String | true |
Payload template: Payload template:
@@ -239,8 +233,8 @@ Payload template:
Example Headers and Payload: Example Headers and Payload:
| Header | MessageProperties | | Header | MessageProperties |
|---------------------------------------|---------------------------------| |------------------------------------------------------------------------------------|-------------------------------|
| type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=CANCEL\_DOWNLOAD | content_type=application/json | type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=CANCEL\_DOWNLOAD | content_type=application/json |
```json ```json
{ {
@@ -252,9 +246,9 @@ After sending this message, an action status event with either actionStatus=CANC
Example header and payload when cancellation is successful: Example header and payload when cancellation is successful:
Header | MessageProperties | Header | MessageProperties |
----------------------------------------------------------------------- | ----------------------------- |-----------------------------------------------------------------------|-------------------------------|
type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json | type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json |
```json ```json
{ {
@@ -267,9 +261,9 @@ type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_
Example header and payload when cancellation is rejected: Example header and payload when cancellation is rejected:
Header | MessageProperties | Header | MessageProperties |
----------------------------------------------------------------------- | ----------------------------- |-----------------------------------------------------------------------|-------------------------------|
type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json | type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_type=application/json |
```json ```json
{ {
@@ -285,16 +279,16 @@ type=EVENT <br /> tenant=default <br /> topic=UPDATE\_ACTION\_STATUS | content_
Message sent by hawkBit to initialize an update or download task. Note: in case of a maintenance window configured but not yet active the message will have the topic _DOWNLOAD_ instead of _DOWNLOAD_AND_INSTALL_. Message sent by hawkBit to initialize an update or download task. Note: in case of a maintenance window configured but not yet active the message will have the topic _DOWNLOAD_ instead of _DOWNLOAD_AND_INSTALL_.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
------- | -------------------------------- | ----------------------------------- | ------------------------------------------------------------- |---------|------------------------------------------------|---------------------------------------------------|-----------|
type | Type of the message | Fixed string "EVENT" | true | type | Type of the message | Fixed string "EVENT" | true |
thingId | The ID of the registered provisioning target | String | true | thingId | The ID of the registered provisioning target | String | true |
topic | Topic name identifying the event | Fixed string "DOWNLOAD_AND_INSTALL" or "DOWNLOAD" | true | topic | Topic name identifying the event | Fixed string "DOWNLOAD_AND_INSTALL" or "DOWNLOAD" | true |
tenant | The tenant this provisioning target belongs to | String | false | tenant | The tenant this provisioning target belongs to | String | false |
Message Properties | Description | Type | Mandatory | Message Properties | Description | Type | Mandatory |
------------------ | ------------------------------- | ------ | ------------------------------------------------------------- |--------------------|---------------------------------|--------|-----------|
content_type | The content type of the payload | String | true | content_type | The content type of the payload | String | true |
Payload Template (the Java representation is [DmfDownloadAndUpdateRequest](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfDownloadAndUpdateRequest.java)): Payload Template (the Java representation is [DmfDownloadAndUpdateRequest](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfDownloadAndUpdateRequest.java)):
@@ -332,9 +326,9 @@ Payload Template (the Java representation is [DmfDownloadAndUpdateRequest](https
Example header and payload: Example header and payload:
Header | MessageProperties | Header | MessageProperties |
------------------------------------------------------------------------------------------- | ----------------------------- |-------------------------------------------------------------------------------------------|-------------------------------|
type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=DOWNLOAD\_AND\_INSTALL | content_type=application/json | type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=DOWNLOAD\_AND\_INSTALL | content_type=application/json |
```json ```json
{ {
@@ -376,16 +370,16 @@ If `multi.assignments.enabled` is enabled, this message is sent instead of DOWNL
With weight, one can set the priority to the action. The higher the weight, the higher is the priority of an action. With weight, one can set the priority to the action. The higher the weight, the higher is the priority of an action.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
------- | -------------------------------- | ----------------------------------- | ------------------------------------------------------------- |---------|------------------------------------------------|-----------------------------|-----------|
type | Type of the message | Fixed string "EVENT" | true | type | Type of the message | Fixed string "EVENT" | true |
thingId | The ID of the registered provisioning target | String | true | thingId | The ID of the registered provisioning target | String | true |
topic | Topic name identifying the event | Fixed string "MULTI_ACTION" | true | topic | Topic name identifying the event | Fixed string "MULTI_ACTION" | true |
tenant | The tenant this provisioning target belongs to | String | false | tenant | The tenant this provisioning target belongs to | String | false |
Message Properties | Description | Type | Mandatory | Message Properties | Description | Type | Mandatory |
------------------ | ------------------------------- | ------ | ------------------------------------------------------------- |--------------------|---------------------------------|--------|-----------|
content_type | The content type of the payload | String | true | content_type | The content type of the payload | String | true |
Payload Template (the Java representation is [DmfMultiActionRequest](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfMultiActionRequest.java)): Payload Template (the Java representation is [DmfMultiActionRequest](https://github.com/eclipse/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfMultiActionRequest.java)):
@@ -460,9 +454,9 @@ Payload Template (the Java representation is [DmfMultiActionRequest](https://git
Example header and payload: Example header and payload:
Header | MessageProperties | Header | MessageProperties |
------------------------------------------------------------------------------------------- | ----------------------------- |----------------------------------------------------------------------------------|-------------------------------|
type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=MULTI\_ACTION | content_type=application/json | type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=MULTI\_ACTION | content_type=application/json |
```json ```json
[{ [{
@@ -538,57 +532,56 @@ type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=MULTI\_ACTION
Message sent by hawkBit when a target has been deleted. Message sent by hawkBit when a target has been deleted.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
-------------- | ------------------------------------------------ | ---------------------------- | ------------------------------------------------------------- |---------|------------------------------------------------|------------------------------|-----------|
type | Type of the message | Fixed string "THING_DELETED" | true | type | Type of the message | Fixed string "THING_DELETED" | true |
thingId | The ID of the registered provisioning target | String | true | thingId | The ID of the registered provisioning target | String | true |
tenant | The tenant this provisioning target belongs to | String | true | tenant | The tenant this provisioning target belongs to | String | true |
Example header: Example header:
Header | MessageProperties | Header | MessageProperties |
----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |--------------------------------------------------------------|-------------------|
type=THING\_DELETED <br /> tenant=default <br /> thingId=abc | | | type=THING\_DELETED <br /> tenant=default <br /> thingId=abc | |
### REQUEST_ATTRIBUTES_UPDATE ### REQUEST_ATTRIBUTES_UPDATE
Message sent by Eclipse hawkBit when a re-transmission of target attributes is requested. Message sent by Eclipse hawkBit when a re-transmission of target attributes is requested.
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
-------------- | ------------------------------------------------ | ---------------------------- | ------------------------------------------------------------- |---------|------------------------------------------------|------------------------------------------|-----------|
type | Type of the message | Fixed string "EVENT" | true | type | Type of the message | Fixed string "EVENT" | true |
thingId | The ID of the registered provisioning target | String | true | thingId | The ID of the registered provisioning target | String | true |
topic | Topic name identifying the event | Fixed string "REQUEST_ATTRIBUTES_UPDATE" | true | topic | Topic name identifying the event | Fixed string "REQUEST_ATTRIBUTES_UPDATE" | true |
tenant | The tenant this provisioning target belongs to | String | true | tenant | The tenant this provisioning target belongs to | String | true |
Example headers: Example headers:
Header | MessageProperties | Header | MessageProperties |
----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |----------------------------------------------------------------------------------------------|-------------------|
type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=REQUEST\_ATTRIBUTES\_UPDATE | | | type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=REQUEST\_ATTRIBUTES\_UPDATE | |
### PING_RESPONSE ### PING_RESPONSE
_hawkBit_ will respond to the PING message with a PING_RESPONSE type message that has the same correlationId as the original PING message: _hawkBit_ will respond to the PING message with a PING_RESPONSE type message that has the same correlationId as the original PING message:
Header | Description | Type | Mandatory | Header | Description | Type | Mandatory |
------- | -------------------------------- | ------------------------------ | ------------------------------------------------------------- |--------|--------------------------------|------------------------------|-----------|
type | Type of the message | Fixed string "PING_RESPONSE" | true | type | Type of the message | Fixed string "PING_RESPONSE" | true |
tenant | The tenant the PING belongs to | String | false | tenant | The tenant the PING belongs to | String | false |
| Message Properties | Description | Type | Mandatory |
Message Properties | Description | Type | Mandatory |--------------------|--------------------------------------------|--------|-----------|
------------------ | ------------------------------- | ------ | ------------------------------------------------------------- | correlationId | CorrelationId of the original PING request | String | true |
correlationId | CorrelationId of the original PING request | String | true | content_type | The content type of the payload | String | true |
content_type | The content type of the payload | String | true
The PING_RESPONSE also contains a timestamp (i.e. the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC) as plain text. It is not guaranteed that this timestamp is completely accurate. The PING_RESPONSE also contains a timestamp (i.e. the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC) as plain text. It is not guaranteed that this timestamp is completely accurate.
Header | MessageProperties | Header | MessageProperties |
------------------------------------------------------------------------------------------- | ----------------------------- |-------------------------------------------|-------------------------|
type=PING_RESPONSE <br /> tenant=default | content_type=text/plain | | type=PING_RESPONSE <br /> tenant=default | content_type=text/plain |
```text ```text
1505215891247 1505215891247

14
docs/content/concepts/authorization.md
View File

@@ -87,13 +87,13 @@ An example configuration is given below.
### Permission Matrix for example uses cases that need more than one permission ### Permission Matrix for example uses cases that need more than one permission
Use Case | Needed permissions | Use Case | Needed permissions |
-------------------------------------------------------------------------- | --------------------------------------------------------------------------- |----------------------------------------------------------------------------|----------------------------------------------------------------------------|
Search _targets_ by installed or assigned _distribution set_ | READ_REPOSITORY, READ_TARGET | Search _targets_ by installed or assigned _distribution set_ | READ_REPOSITORY, READ_TARGET |
Assign _DS_ to a _target_ | READ_REPOSITORY, UPDATE_TARGET | Assign _DS_ to a _target_ | READ_REPOSITORY, UPDATE_TARGET |
Assign DS to target through a _Rollout_, i.e. _Rollout_ creation and start | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT, CREATE_ROLLOUT, HANDLE_ROLLOUT | Assign DS to target through a _Rollout_, i.e. _Rollout_ creation and start | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT, CREATE_ROLLOUT, HANDLE_ROLLOUT |
Read _Rollout_ status including its _deployment groups_ | READ_REPOSITORY, READ_ROLLOUT | Read _Rollout_ status including its _deployment groups_ | READ_REPOSITORY, READ_ROLLOUT |
Checks _targets_ inside _Rollout deployment group_ | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT | Checks _targets_ inside _Rollout deployment group_ | READ_REPOSITORY, READ_TARGET, READ_ROLLOUT |
## Device Management Federation API ## Device Management Federation API

14
docs/content/concepts/targetstate.md
View File

@@ -9,13 +9,13 @@ A target has a current state which reflects the provisioning status of the devic
## Defined states ## Defined states
State | Description | State | Description |
---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
UNKNOWN | Set by default for a pre-commissioned target until first status update received from the target. Is the initial starting point for targets created by UI or management API. | UNKNOWN | Set by default for a pre-commissioned target until first status update received from the target. Is the initial starting point for targets created by UI or management API. |
IN_SYNC | Assigned _Distribution Set_ is installed. | IN_SYNC | Assigned _Distribution Set_ is installed. |
PENDING | Installation of assigned _Distribution Set_ is not yet confirmed. | PENDING | Installation of assigned _Distribution Set_ is not yet confirmed. |
ERROR | Installation of assigned _Distribution Set_ has failed. | ERROR | Installation of assigned _Distribution Set_ has failed. |
REGISTERED | Target registered at the update server but no _Distribution Set_ assigned. Is the initial starting point for plug-and-play devices. | REGISTERED | Target registered at the update server but no _Distribution Set_ assigned. Is the initial starting point for plug-and-play devices. |
## Transitions ## Transitions
![](../../images/architecture/targetStatusStates.png) ![](../../images/architecture/targetStatusStates.png)

22
docs/content/ui.md
View File

@@ -141,17 +141,17 @@ The basic syntax to filter is: `field<basic_operator>value <composite_operator>
### Examples ### Examples
Custom query | Description | Custom query | Description |
------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
updatestatus==error | Gives all targets in ‘error’ state. | updatestatus==error | Gives all targets in ‘error’ state. |
controllerId!=192.168.2.42 | Gives all targets that do not have the controllerId 192.168.2.42. | controllerId!=192.168.2.42 | Gives all targets that do not have the controllerId 192.168.2.42. |
name==\*CCU\* | Gives all targets which contain the term ‘CCU’ in there name. | name==\*CCU\* | Gives all targets which contain the term ‘CCU’ in there name. |
name==\*CCU\* or description==\*CCU\* | Gives all targets that either have the term ‘CCU’ in their name or their description. | name==\*CCU\* or description==\*CCU\* | Gives all targets that either have the term ‘CCU’ in their name or their description. |
name==\*SHC\* and description==\*SHC\* | Gives all targets that have the term SHC in their name and their description. | name==\*SHC\* and description==\*SHC\* | Gives all targets that have the term SHC in their name and their description. |
name==CCU* and updatestatus==pending | Gives all targets with their name starting with ‘CCU’ and which are in ‘pending’ state. | name==CCU* and updatestatus==pending | Gives all targets with their name starting with ‘CCU’ and which are in ‘pending’ state. |
(assignedds.name==‘ECU-DS’ and description==test) or updatestatus!=error | Gives all targets which are either assigned to ‘ECU-DS’ and have description equals to ‘test’ or which are not in error status. | (assignedds.name==‘ECU-DS’ and description==test) or updatestatus!=error | Gives all targets which are either assigned to ‘ECU-DS’ and have description equals to ‘test’ or which are not in error status. |
(updatestatus!=In\_sync or updatestatus!=error) and name==\*SHC1\* | Gives all targets that do not have the update status In\_sync or error and that contains the term SHC1 in their name. | (updatestatus!=In\_sync or updatestatus!=error) and name==\*SHC1\* | Gives all targets that do not have the update status In\_sync or error and that contains the term SHC1 in their name. |
(updatestatus!=error or updatestatus!=pending) and (name==\*CCU\* or description==\*CCU\*) | Gives all targets that either have the term ‘CCU’ in their name or their description and that either have the _update status_ not in state error or pending. | (updatestatus!=error or updatestatus!=pending) and (name==\*CCU\* or description==\*CCU\*) | Gives all targets that either have the term ‘CCU’ in their name or their description and that either have the _update status_ not in state error or pending. |
![Target Filter Management view](../images/ui/target_filter.png) ![Target Filter Management view](../images/ui/target_filter.png)