Skip to content

Commit

Permalink
Merge pull request #1929 from Bravo555/fix-config-typo
Browse files Browse the repository at this point in the history 
Fix typo in mqtt.client.auth.key set error message
  • Loading branch information
@didier-wenzek
didier-wenzek authored Apr 26, 2023
2 parents 71e2d39 + 2403f1c commit 79566a5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions crates/common/tedge_config/src/tedge_config_cli/tedge_config.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -520,14 +520,14 @@ impl ConfigSettingAccessor<MqttClientAuthKeySetting> for TEdgeConfig {
.client_auth
.as_ref()
.ok_or(ConfigSettingError::ConfigNotSet {
key: "mqtt.client.auth.certkey",
key: "mqtt.client.auth.keyfile",
})?
.key_file
.clone()
// TODO (Marcel): remove unnecessary Options once tedge_config is
// refactored
.ok_or(ConfigSettingError::ConfigNotSet {
key: "mqtt.client.auth.certkey",
key: "mqtt.client.auth.keyfile",
})
}

Expand Down
6 changes: 3 additions & 3 deletions docs/src/howto-guides/029_mqtt_local_broker_authentication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ keyfile PATH_TO_CLIENT_CA_CERTIFICATE
### Step 2: Configure thin-edge.io to use a client certificate and private key

```sh
tedge config set mqtt.client.auth.cert_file PATH_TO_CLIENT_CERTIFICATE
tedge config set mqtt.client.auth.key_file PATH_TO_CLIENT_PRIVATE_KEY
tedge config set mqtt.client.auth.certfile PATH_TO_CLIENT_CERTIFICATE
tedge config set mqtt.client.auth.keyfile PATH_TO_CLIENT_PRIVATE_KEY
```

Both `cert_file` and `key_file` are required to enable client authentication.
Both `certfile` and `keyfile` are required to enable client authentication.
Setting only one of them will result in an error about the second one not being
set.

Expand Down

1 comment on commit 79566a5

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass %
186 0 5 186 100

Passed Tests

Name ⏱️ Duration Suite
Define Child device 1 ID 0.009 s C8Y Child Alarms Rpi
Normal case when the child device does not exist on c8y cloud 2.34 s C8Y Child Alarms Rpi
Normal case when the child device already exists 1.213 s C8Y Child Alarms Rpi
Reconciliation when the new alarm message arrives, restart the mapper 1.694 s C8Y Child Alarms Rpi
Reconciliation when the alarm that is cleared 5.333 s C8Y Child Alarms Rpi
Prerequisite Parent 76.814 s Child Conf Mgmt Plugin
Prerequisite Child 0.262 s Child Conf Mgmt Plugin
Child device bootstrapping 12.975 s Child Conf Mgmt Plugin
Snapshot from device 62.349 s Child Conf Mgmt Plugin
Child device config update 61.7 s Child Conf Mgmt Plugin
Configuration types should be detected on file change (without restarting service) 112.261 s Inotify Crate
Check lock file existence in default folder 1.267 s Lock File
Check PID number in lock file 1.513 s Lock File
Check PID number in lock file after restarting the services 4.414 s Lock File
Check starting same service twice 2.032 s Lock File
Switch off lock file creation 2.535 s Lock File
Set configuration when file exists 8.828 s Configuration Operation
Set configuration when file does not exist 5.315 s Configuration Operation
Set configuration with broken url 5.386 s Configuration Operation
Get configuration 6.52 s Configuration Operation
Get non existent configuration file 4.853 s Configuration Operation
Get non existent configuration type 4.771 s Configuration Operation
Update configuration plugin config via cloud 4.9190000000000005 s Configuration Operation
Modify configuration plugin config via local filesystem modify inplace 2.032 s Configuration Operation
Modify configuration plugin config via local filesystem overwrite 4.306 s Configuration Operation
Update configuration plugin config via local filesystem copy 5.313 s Configuration Operation
Update configuration plugin config via local filesystem move (different directory) 3.479 s Configuration Operation
Update configuration plugin config via local filesystem move (same directory) 3.642 s Configuration Operation
Successful firmware operation 71.297 s Firmware Operation
Install with empty firmware name 53.4 s Firmware Operation
Prerequisite Parent 18.73 s Firmware Operation Child Device
Prerequisite Child 8.14 s Firmware Operation Child Device
Child device firmware update 6.197 s Firmware Operation Child Device
Child device firmware update with cache 5.877 s Firmware Operation Child Device
Update Inventory data via inventory.json 1.455 s Inventory Update
Retrieve a JWT tokens 119.519 s Jwt Request
Main device registration 2.169 s Device Registration
Child device registration 2.769 s Device Registration
Supports restarting the device 127.075 s Restart Device
Update tedge version from previous using Cumulocity 81.661 s Tedge Self Update
Test if all c8y services are up 112.927 s Service Monitoring
Test if all c8y services are down 115.58 s Service Monitoring
Test if all c8y services are using configured service type 106.448 s Service Monitoring
Test if all c8y services using default service type when service type configured as empty 95.932 s Service Monitoring
Check health status of tedge-mapper-c8y service on broker stop start 34.358 s Service Monitoring
Check health status of tedge-mapper-c8y service on broker restart 37.848 s Service Monitoring
Check health status of child device service 27.307 s Service Monitoring
Successful shell command with output 3.5629999999999997 s Shell Operation
Check Successful shell command with literal double quotes output 3.351 s Shell Operation
Execute multiline shell command 3.375 s Shell Operation
Failed shell command 3.339 s Shell Operation
Software list should be populated during startup 41.648 s Software
Install software via Cumulocity 64.167 s Software
Software list should only show currently installed software and not candidates 41.71 s Software
Child devices support sending simple measurements 3.644 s Child Device Telemetry
Child devices support sending custom measurements 1.271 s Child Device Telemetry
Child devices support sending custom events 1.3719999999999999 s Child Device Telemetry
Child devices support sending custom events overriding the type 1.33 s Child Device Telemetry
Child devices support sending custom alarms #1699 1.322 s Child Device Telemetry
Child devices support sending inventory data via c8y topic 1.064 s Child Device Telemetry
Main device support sending inventory data via c8y topic 1.491 s Child Device Telemetry
Child device supports sending custom child device measurements directly to c8y 1.6219999999999999 s Child Device Telemetry
Main device supports sending custom child device measurements directly to c8y 1.818 s Child Device Telemetry
Check retained alarms 51.041 s Raise Alarms
Validate updated data path used by tedge-agent 0.835 s Data Path Config
Validate updated data path used by c8y-firmware-plugin 11.529 s Data Path Config
Stop tedge-agent service 0.337 s Log Path Config
Customize the log path 0.332 s Log Path Config
Initialize tedge-agent 0.332 s Log Path Config
Check created folders 0.168 s Log Path Config
Remove created custom folders 0.202 s Log Path Config
Install thin-edge via apt 43.786 s Install Apt
Install latest via script (from current branch) 27.032 s Install Tedge
Install specific version via script (from current branch) 24.887 s Install Tedge
Install latest tedge via script (from main branch) 26.293 s Install Tedge
Install then uninstall latest tedge via script (from main branch) 46.43 s Install Tedge
Support starting and stopping services 44.833 s Service-Control
Supports a reconnect 59.072 s Test-Commands
Supports disconnect then connect 40.915 s Test-Commands
Update unknown setting 39.077 s Test-Commands
Update known setting 38.196 s Test-Commands
Stop c8y-configuration-plugin 60.105 s Health C8Y-Configuration-Plugin
Update the service file 0.186 s Health C8Y-Configuration-Plugin
Reload systemd files 0.49 s Health C8Y-Configuration-Plugin
Start c8y-configuration-plugin 0.101 s Health C8Y-Configuration-Plugin
Start watchdog service 10.211 s Health C8Y-Configuration-Plugin
Check PID of c8y-configuration-plugin 0.139 s Health C8Y-Configuration-Plugin
Kill the PID 0.323 s Health C8Y-Configuration-Plugin
Recheck PID of c8y-configuration-plugin 6.526 s Health C8Y-Configuration-Plugin
Compare PID change 0.001 s Health C8Y-Configuration-Plugin
Stop watchdog service 0.135 s Health C8Y-Configuration-Plugin
Remove entry from service file 0.07 s Health C8Y-Configuration-Plugin
Stop c8y-log-plugin 60.138 s Health C8Y-Log-Plugin
Update the service file 0.135 s Health C8Y-Log-Plugin
Reload systemd files 0.428 s Health C8Y-Log-Plugin
Start c8y-log-plugin 0.127 s Health C8Y-Log-Plugin
Start watchdog service 10.115 s Health C8Y-Log-Plugin
Check PID of c8y-log-plugin 0.088 s Health C8Y-Log-Plugin
Kill the PID 0.179 s Health C8Y-Log-Plugin
Recheck PID of c8y-log-plugin 6.526 s Health C8Y-Log-Plugin
Compare PID change 0.001 s Health C8Y-Log-Plugin
Stop watchdog service 0.132 s Health C8Y-Log-Plugin
Remove entry from service file 0.091 s Health C8Y-Log-Plugin
Stop tedge-mapper 0.245 s Health Tedge Mapper C8Y
Update the service file 0.241 s Health Tedge Mapper C8Y
Reload systemd files 0.577 s Health Tedge Mapper C8Y
Start tedge-mapper 0.119 s Health Tedge Mapper C8Y
Start watchdog service 10.23 s Health Tedge Mapper C8Y
Check PID of tedge-mapper 0.055 s Health Tedge Mapper C8Y
Kill the PID 0.099 s Health Tedge Mapper C8Y
Recheck PID of tedge-mapper 6.382 s Health Tedge Mapper C8Y
Compare PID change 0.001 s Health Tedge Mapper C8Y
Stop watchdog service 0.178 s Health Tedge Mapper C8Y
Remove entry from service file 0.112 s Health Tedge Mapper C8Y
Stop tedge-agent 0.225 s Health Tedge-Agent
Update the service file 0.112 s Health Tedge-Agent
Reload systemd files 0.434 s Health Tedge-Agent
Start tedge-agent 0.137 s Health Tedge-Agent
Start watchdog service 10.199 s Health Tedge-Agent
Check PID of tedge-mapper 0.057 s Health Tedge-Agent
Kill the PID 0.148 s Health Tedge-Agent
Recheck PID of tedge-agent 6.36 s Health Tedge-Agent
Compare PID change 0.001 s Health Tedge-Agent
Stop watchdog service 0.18 s Health Tedge-Agent
Remove entry from service file 0.208 s Health Tedge-Agent
Stop tedge-mapper-az 0.141 s Health Tedge-Mapper-Az
Update the service file 0.189 s Health Tedge-Mapper-Az
Reload systemd files 0.615 s Health Tedge-Mapper-Az
Start tedge-mapper-az 0.26 s Health Tedge-Mapper-Az
Start watchdog service 10.21 s Health Tedge-Mapper-Az
Check PID of tedge-mapper-az 0.086 s Health Tedge-Mapper-Az
Kill the PID 0.18 s Health Tedge-Mapper-Az
Recheck PID of tedge-agent 6.509 s Health Tedge-Mapper-Az
Compare PID change 0.001 s Health Tedge-Mapper-Az
Stop watchdog service 0.201 s Health Tedge-Mapper-Az
Remove entry from service file 0.112 s Health Tedge-Mapper-Az
Stop tedge-mapper-collectd 0.085 s Health Tedge-Mapper-Collectd
Update the service file 0.06 s Health Tedge-Mapper-Collectd
Reload systemd files 0.201 s Health Tedge-Mapper-Collectd
Start tedge-mapper-collectd 0.073 s Health Tedge-Mapper-Collectd
Start watchdog service 10.093 s Health Tedge-Mapper-Collectd
Check PID of tedge-mapper-collectd 0.369 s Health Tedge-Mapper-Collectd
Kill the PID 0.296 s Health Tedge-Mapper-Collectd
Recheck PID of tedge-mapper-collectd 6.642 s Health Tedge-Mapper-Collectd
Compare PID change 0.001 s Health Tedge-Mapper-Collectd
Stop watchdog service 0.146 s Health Tedge-Mapper-Collectd
Remove entry from service file 0.189 s Health Tedge-Mapper-Collectd
tedge-collectd-mapper health status 5.54 s Health Tedge-Mapper-Collectd
c8y-log-plugin health status 5.58 s MQTT health endpoints
c8y-configuration-plugin health status 5.826 s MQTT health endpoints
Publish on a local insecure broker 0.298 s Basic Pub Sub
Publish on a local secure broker 2.247 s Basic Pub Sub
Publish on a local secure broker with client authentication 1.909 s Basic Pub Sub
Check remote mqtt broker #1773 4.947 s Remote Mqtt Broker
Wrong package name 0.132 s Improve Tedge Apt Plugin Error Messages
Wrong version 0.149 s Improve Tedge Apt Plugin Error Messages
Wrong type 0.277 s Improve Tedge Apt Plugin Error Messages
tedge_connect_test_positive 0.333 s Tedge Connect Test
tedge_connect_test_negative 1.062 s Tedge Connect Test
tedge_connect_test_sm_services 6.79 s Tedge Connect Test
tedge_disconnect_test_sm_services 0.288 s Tedge Connect Test
Install thin-edge.io 14.28 s Call Tedge
call tedge -V 0.133 s Call Tedge
call tedge -h 0.125 s Call Tedge
call tedge -h -V 0.163 s Call Tedge
call tedge help 0.116 s Call Tedge
tedge config list 0.059 s Call Tedge Config List
tedge config list --all 0.066 s Call Tedge Config List
set/unset device.type 0.266 s Call Tedge Config List
set/unset device.key.path 0.278 s Call Tedge Config List
set/unset device.cert.path 0.245 s Call Tedge Config List
set/unset c8y.root.cert.path 0.226 s Call Tedge Config List
set/unset c8y.smartrest.templates 0.24 s Call Tedge Config List
set/unset az.root.cert.path 0.257 s Call Tedge Config List
set/unset az.mapper.timestamp 0.381 s Call Tedge Config List
set/unset mqtt.bind_address 0.405 s Call Tedge Config List
set/unset mqtt.port 0.436 s Call Tedge Config List
set/unset tmp.path 0.5 s Call Tedge Config List
set/unset logs.path 0.263 s Call Tedge Config List
set/unset run.path 0.245 s Call Tedge Config List
Get Put Delete 3.373 s Http File Transfer Api
Set keys should return value on stdout 0.067 s Tedge Config Get
Unset keys should not return anything on stdout and warnings on stderr 0.12 s Tedge Config Get
Invalid keys should not return anything on stdout and warnings on stderr 0.113 s Tedge Config Get
Set configuration via environment variables 0.419 s Tedge Config Get
Set unknown configuration via environment variables 0.081 s Tedge Config Get

Please sign in to comment.