Skip to content

Commit

Permalink
[eclipse-kanto#292] Add missing TLS flags for the local communication (
Browse files Browse the repository at this point in the history
…eclipse-kanto#294)

Signed-off-by: Antonia Avramova <[email protected]>
  • Loading branch information
antonia-avramova authored Nov 23, 2023
1 parent 2d80576 commit 01cad85
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ To control all aspects of the suite connector behavior.
| provisioningFile | string ​| provisioning.json | Path to the provisioning file, if {{% relrefn "dmp" %}}Bosch IoT Device Management{{% /relrefn %}} is in use |
| **Remote connectivity** | | | |
| address | string | mqtts://mqtt.bosch-iot-hub.com:8883 | Address of the MQTT endpoint that the suite connector will connect for the remote communication, the format is: `scheme://host:port` |
| alpn | string[] | | TLS application layer protocol negotiation options space separated for cloud access |
| deviceId | string | | Device unique identifier |
| authId | string | | Authentication unique identifier that is a part of the credentials |
| tenantId | string | | Tenant unique identifier that the device belongs to |
Expand All @@ -24,6 +23,7 @@ To control all aspects of the suite connector behavior.
| clientId | string | | MQTT client unique identifier |
| policyId | string | | Policy unique identifier of the digital twin |
| **Remote connectivity - TLS** | | | |
| alpn | string[] | | TLS application layer protocol negotiation options space separated for cloud access |
| caCert | string | iothub.crt | PEM encoded CA certificates file |
| cert | string | | PEM encoded certificate file to authenticate to the MQTT endpoint |
| key | string | | PEM encoded unencrypted private key file to authenticate to the MQTT endpoint |
Expand Down Expand Up @@ -77,14 +77,14 @@ Be aware that some combinations may be incompatible
{
"provisioningFile": "provisioning.json",
"address": "mqtts://mqtt.bosch-iot-hub.com:8883",
"alpn" : [],
"deviceId": "",
"authId": "",
"tenantId": "",
"password": "",
"username": "",
"clientId": "",
"policyId": "",
"alpn" : [],
"caCert": "iothub.crt",
"cert": "",
"key": "",
Expand Down
7 changes: 7 additions & 0 deletions web/site/content/docs/references/software-update-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ To control all aspects of the software update behavior.
| 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 |
| password | string | | Password that is a part of the credentials |
| **Local connectivity - TLS** | | | |
| caCert | string | | PEM encoded CA certificates file |
| cert | string | | PEM encoded certificate file to authenticate to the MQTT server/broker |
| key | string | | PEM encoded unencrypted private key file to authenticate to the MQTT server/broker |
| **Logging** | | | |
| logFile | string | log/software-update.log | Path to the file where log messages are written |
| logLevel | string | INFO | All log messages at this or higher level will be logged, the log levels in descending order are: ERROR, WARN, INFO, DEBUG and TRACE |
Expand Down Expand Up @@ -67,6 +71,9 @@ The following template illustrates all possible properties with their default va
"broker": "tcp://localhost:1883",
"username": "",
"password": "",
"caCert": "",
"cert": "",
"key": "",
"logFile": "log/software-update.log",
"logLevel": "INFO",
"logFileCount": 5,
Expand Down
9 changes: 8 additions & 1 deletion web/site/content/docs/references/system-metrics-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ To control all aspects of the system metrics behavior.
| broker | string | tcp://localhost:1883 | Address of the MQTT server/broker that the system metrics will connect for the local communication, the format is: `scheme://host:port` |
| username | string | | Username that is a part of the credentials |
| password | string | | Password that is a part of the credentials |
| **Local connectivity - TLS** | | | |
| caCert | string | | PEM encoded CA certificates file |
| clientCert | string | | PEM encoded certificate file to authenticate to the MQTT server/broker |
| clientKey | string | | PEM encoded unencrypted private key file to authenticate to the MQTT server/broker |
| **Logging** | | | |
| logFile | string | log/system-metrics.log | Path to the file where log messages are written |
| logLevel | string | INFO | All log messages at this or higher level will be logged, the log levels in descending order are: ERROR, WARN, INFO, DEBUG and TRACE |
Expand All @@ -42,10 +46,13 @@ The following template illustrates all possible properties with their default va

```json
{
"frequency" : ""
"frequency" : "",
"broker": "tcp://localhost:1883",
"username": "",
"password": "",
"caCert": "",
"clientCert": "",
"cleintKey": "",
"logFile": "log/system-metrics.log",
"logLevel": "INFO",
"logFileCount": 5,
Expand Down

0 comments on commit 01cad85

Please sign in to comment.