Skip to content

Commit

Permalink
Robust download properties added to reference guide (#144)
Browse files Browse the repository at this point in the history
[#96] Add robust download properties to software update reference guide

- Added descriptions of the properties
- Updated the template

Signed-off-by: Velitchko Valkov <[email protected]>
Co-authored-by: Evgeni Grigorov <[email protected]>
  • Loading branch information
velitchko-valkov and e-grigorov authored Oct 3, 2022
1 parent 3a573b3 commit 2a04ccd
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions web/site/content/docs/references/software-update-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ To control all aspects of the software update behavior.
| artifactType | string | archive | Type of the artifact that is to be processed: archive or plain |
| install | string[] | | Absolute path to the install script/command and an optional sequence of additional flags/parameters |
| storageLocation | string | ./ | Path to the storage directory where the working files are stored |
| **Download** | | | |
| downloadRetryCount | int| 0 | Number of retries, in case of a failed download |
| downloadRetryInterval | string | 5s | Interval between retries, in case of a failed download as a sequence of decimal numbers, each with optional fraction and a unit suffix, such as: 300ms, 1.5h, 10m30s, etc., time units are: ns, us (or µs), ms, s, m, h |
| **Local connectivity** | | | |
| broker | string | tcp://localhost:1883 | Address of the MQTT server/broker that the software update will connect for the local communication, the format is: `scheme://host:port` |
| username | string | | Username that is a part of the credentials |
Expand Down Expand Up @@ -52,6 +55,8 @@ The following template illustrates all possible properties with their default va
"artifactType": "archive",
"install": [],
"storageLocation": "./",
"downloadRetryCount": 0,
"downloadRetryInterval": "5s",
"broker": "tcp://localhost:1883",
"username": "",
"password": "",
Expand Down

0 comments on commit 2a04ccd

Please sign in to comment.