diff --git a/web/site/content/docs/getting-started/hono.md b/web/site/content/docs/getting-started/hono.md index 55df6677..1cf300e6 100644 --- a/web/site/content/docs/getting-started/hono.md +++ b/web/site/content/docs/getting-started/hono.md @@ -77,13 +77,13 @@ authentication data to establish the remote connection. Update it with the follo ```json { - "provisioningFile": "/etc/suite-connector/provisioning.json", + "caCert": "/etc/suite-connector/iothub.crt", "logFile": "/var/log/suite-connector/suite-connector.log", - "address":"mqtts://hono.eclipseprojects.io:8883", - "tenantId":"demo", - "deviceId":"demo:device", - "authId":"demo_device", - "password":"secret" + "address": "mqtts://hono.eclipseprojects.io:8883", + "tenantId": "demo", + "deviceId": "demo:device", + "authId": "demo_device", + "password": "secret" } ``` {{% tip %}} diff --git a/web/site/content/docs/getting-started/install.md b/web/site/content/docs/getting-started/install.md index 90cce3f5..957c2cea 100644 --- a/web/site/content/docs/getting-started/install.md +++ b/web/site/content/docs/getting-started/install.md @@ -21,8 +21,8 @@ at the Download and install it via executing the following (adjusted to your package name): ```shell -wget https://github.com/eclipse-kanto/kanto/releases/download/v0.1.0-M3/kanto_0.1.0-M3_linux_x86_64.deb && \ -sudo apt install ./kanto_0.1.0-M3_linux_x86_64.deb +wget https://github.com/eclipse-kanto/kanto/releases/download/v1.0.0/kanto_1.0.0_linux_x86_64.deb && \ +sudo apt install ./kanto_1.0.0_linux_x86_64.deb ``` ### Verify diff --git a/web/site/content/docs/references/connectivity/aws-connector-config.md b/web/site/content/docs/references/connectivity/aws-connector-config.md index b869eaf5..41c15a27 100644 --- a/web/site/content/docs/references/connectivity/aws-connector-config.md +++ b/web/site/content/docs/references/connectivity/aws-connector-config.md @@ -8,7 +8,7 @@ weight: 1 ### Properties -To control all aspects of the suite connector behavior. +To control all aspects of the aws connector behavior. | Property | Type | Default | Description | | - | - | - | - | @@ -29,7 +29,7 @@ To control all aspects of the suite connector behavior. | tpmKeyPub | string | | File path to the public part of the TPM 2.0 key | | tpmKey | string | | File path to the private part of the TPM 2.0 key | | **Local connectivity** | | | | -| localAddress | string | tcp://localhost:1883 | Address of the MQTT server/broker that the suite connector will connect for the local communication, the format is: `scheme://host:port` | +| localAddress | string | tcp://localhost:1883 | Address of the MQTT server/broker that the aws connector will connect for the local communication, the format is: `scheme://host:port` | | localUsername | string | | Username that is a part of the credentials | | localPassword | string | | Password that is a part of the credentials | | **Local connectivity - TLS** | | | | @@ -37,7 +37,7 @@ To control all aspects of the suite connector behavior. | localCert | string | | PEM encoded certificate file to authenticate to the MQTT server/broker | | localKey | string | | PEM encoded unencrypted private key file to authenticate to the MQTT server/broker | | **Logging** | | | | -| logFile | string | log/suite-connector.log | Path to the file where log messages are written | +| logFile | string | logs/aws-connector.log | Path to the file where log messages are written | | logLevel | string | INFO | All log messages at this or a higher level will be logged, the log levels in descending order are: ERROR, WARN, INFO, DEBUG and TRACE | | logFileCount | int | 5 | Log file maximum rotations count | | logFileMaxAge | int | 28 | Log file rotations maximum age in days, use 0 to not remove old log files | @@ -72,9 +72,9 @@ Be aware that some combinations may be incompatible "topicFilter": "", "payloadFilters": [], "address": "", - "alpn" : [], "tenantId": "default-tenant-id", "clientId": "", + "alpn" : [], "caCert": "aws.crt", "cert": "", "key": "", diff --git a/web/site/content/docs/references/connectivity/azure-connector-config.md b/web/site/content/docs/references/connectivity/azure-connector-config.md new file mode 100644 index 00000000..32212233 --- /dev/null +++ b/web/site/content/docs/references/connectivity/azure-connector-config.md @@ -0,0 +1,91 @@ +--- +title: "Azure Connector configuration" +type: docs +description: > + Customize the remote connectivity. +weight: 2 +--- + +### Properties + +To control all aspects of the azure connector behavior. + +| Property | Type | Default | Description | +| - | - | - | - | +| tenantId | string | defaultTenant | Tenant unique identifier that the device belongs to | +| connectionString | string ​| | The connection string for connectivity to Azure IoT Hub, the format is: `"HostName=newHostName.azure-devices.net;DeviceId=deviceId;SharedAccessKey=accessKey"` | +| sasTokenValidity | string | 1h | The validity period for the generated SAS token for device authentication. Positive integer number followed by a unit suffix, such as '300m', '1h', etc., time units are: m, h, d | +| idScope | string | | ID scope for Azure Device Provisioning service | +| **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 | +| **Remote connectivity - TLS over TPM** | | | | +| tpmDevice | string | | Path to the device file or the unix socket to access the TPM 2.0 | +| tpmHandle | int | | TPM 2.0 storage root key handle, the type is unsigned 64-bit integer | +| tpmKeyPub | string | | File path to the public part of the TPM 2.0 key | +| tpmKey | string | | File path to the private part of the TPM 2.0 key | +| **Local connectivity** | | | | +| localAddress | string | tcp://localhost:1883 | Address of the MQTT server/broker that the azure connector will connect for the local communication, the format is: `scheme://host:port` | +| localUsername | string | | Username that is a part of the credentials | +| localPassword | string | | Password that is a part of the credentials | +| **Local connectivity - TLS** | | | | +| localCACert | string | | PEM encoded CA certificates file | +| localCert | string | | PEM encoded certificate file to authenticate to the MQTT server/broker | +| localKey | string | | PEM encoded unencrypted private key file to authenticate to the MQTT server/broker | +| **Logging** | | | | +| logFile | string | logs/azure-connector.log | Path to the file where log messages are written | +| logLevel | string | INFO | All log messages at this or a higher level will be logged, the log levels in descending order are: ERROR, WARN, INFO, DEBUG and TRACE | +| logFileCount | int | 5 | Log file maximum rotations count | +| logFileMaxAge | int | 28 | Log file rotations maximum age in days, use 0 to not remove old log files | +| logFileSize | int | 2 | Log file size in MB before it gets rotated | + +### Example + +The minimal required configuration to connect. + +```json +{ + "connectionString": "HostName=hostName.azure-devices.net;DeviceId=deviceId;SharedAccessKey=cGFzc3AvcKQ=", + "caCert": "/etc/azure-connector/iothub.crt", + "logFile": "/var/log/azure-connector/azure-connector.log" +} +``` + +### Template + +The configuration can be further adjusted according to the use case. +The following template illustrates all possible properties with their default values. + +{{% warn %}} +Be aware that some combinations may be incompatible +{{% /warn %}} + +```json +{ + "tenantId": "defaultTenant", + "connectionString": "", + "sasTokenValidity": "1h", + "idScope": "", + "alpn" : [], + "caCert": "iothub.crt", + "cert": "", + "key": "", + "tpmDevice": "", + "tpmHandle": 0, + "tpmKeyPub": "", + "tpmKey": "", + "localAddress": "tcp://localhost:1883", + "localUsername": "", + "localPassword": "", + "localCACert": "", + "localCert": "", + "localKey": "", + "logFile": "logs/azure-connector.log", + "logLevel": "INFO", + "logFileCount": 5, + "logFileMaxAge": 28, + "logFileSize": 2 +} +``` diff --git a/web/site/content/docs/references/connectivity/suite-connector-config.md b/web/site/content/docs/references/connectivity/suite-connector-config.md index b82543ed..23c9faca 100644 --- a/web/site/content/docs/references/connectivity/suite-connector-config.md +++ b/web/site/content/docs/references/connectivity/suite-connector-config.md @@ -3,7 +3,7 @@ title: "Suite connector configuration" type: docs description: > Customize the remote connectivity. -weight: 1 +weight: 3 --- ### Properties @@ -16,12 +16,12 @@ To control all aspects of the suite connector behavior. | 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` | | deviceId | string | | Device unique identifier | | authId | string | | Authentication unique identifier that is a part of the credentials | -| generic | bool | | Force use of modified topics for cloud access | | tenantId | string | | Tenant unique identifier that the device belongs to | | username | string | | MQTT username that is a part of the credentials. This parameter takes precedence over authId and tenantId | | password | string | | Password that is a part of the credentials | | clientId | string | | MQTT client unique identifier | | policyId | string | | Policy unique identifier of the digital twin | +| generic | bool | | Force use of modified topics for cloud access | | **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 | @@ -56,6 +56,7 @@ The minimal required configuration to connect the publicly available ```json { "address": "hono.eclipseprojects.io:1883", + "caCert": "/etc/suite-connector/iothub.crt", "tenantId": "org.eclipse.kanto", "deviceId": "org.eclipse.kanto:exampleDevice", "authId": "org.eclipse.kanto_example", @@ -75,15 +76,15 @@ Be aware that some combinations may be incompatible ```json { - "provisioningFile": "provisioning.json", "address": "mqtts://mqtt.bosch-iot-hub.com:8883", "deviceId": "", "authId": "", "tenantId": "", - "password": "", "username": "", + "password": "", "clientId": "", "policyId": "", + "generic": false, "alpn" : [], "caCert": "iothub.crt", "cert": "", @@ -96,6 +97,9 @@ Be aware that some combinations may be incompatible "localAddress": "tcp://localhost:1883", "localUsername": "", "localPassword": "", + "localCACert": "", + "localCert": "", + "localKey": "", "logFile": "log/suite-connector.log", "logLevel": "INFO", "logFileCount": 5, diff --git a/web/site/content/docs/references/local-digital-twins-config.md b/web/site/content/docs/references/local-digital-twins-config.md index 8df09cb8..e6cf1706 100644 --- a/web/site/content/docs/references/local-digital-twins-config.md +++ b/web/site/content/docs/references/local-digital-twins-config.md @@ -53,6 +53,7 @@ The minimal required configuration to enable the local digital twins and their s ```json { "address": "hono.eclipseprojects.io:1883", + "caCert": "/etc/local-digital-twins/iothub.crt", "tenantId": "org.eclipse.kanto", "deviceId": "org.eclipse.kanto:exampleDevice", "authId": "org.eclipse.kanto_example", @@ -74,7 +75,6 @@ Be aware that some combinations may be incompatible ```json { "thingsDb": "things.db", - "provisioningFile": "provisioning.json", "address": "mqtts://mqtt.bosch-iot-hub.com:8883", "deviceId": "", "authId": "",