tedge-configuration-plugin specification

[rina23q]

Proposed changes

Spec of tedge-configuration-plguin.

For later discussion

• Notification mechanism. State machine will do most probably. See the thread tedge-configuration-plugin specification #2097 (comment)
• File deletion. Mapper will do. See the thread tedge-configuration-plugin specification #2097 (comment)

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
• Documentation Update (if none of the other choices apply)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

#2098

Checklist

• I have read the CONTRIBUTING doc
• I have signed the CLA (in all commits with git commit -s)
• I ran cargo fmt as mentioned in CODING_GUIDELINES
• I used cargo clippy as mentioned in CODING_GUIDELINES
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

[github-actions]

Robot Results

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

Passed Tests

Name	⏱️ Duration	Suite
Define Child device 1 ID	0.005 s	C8Y Child Alarms Rpi
Normal case when the child device does not exist on c8y cloud	2.666 s	C8Y Child Alarms Rpi
Normal case when the child device already exists	0.805 s	C8Y Child Alarms Rpi
Reconciliation when the new alarm message arrives, restart the mapper	1.938 s	C8Y Child Alarms Rpi
Reconciliation when the alarm that is cleared	65.677 s	C8Y Child Alarms Rpi
Prerequisite Parent	14.125 s	Child Conf Mgmt Plugin
Prerequisite Child	0.228 s	Child Conf Mgmt Plugin
Child device bootstrapping	12.292 s	Child Conf Mgmt Plugin
Snapshot from device	62.723 s	Child Conf Mgmt Plugin
Child device config update	62.147 s	Child Conf Mgmt Plugin
Configuration types should be detected on file change (without restarting service)	56.095 s	Inotify Crate
Check lock file existence in default folder	1.667 s	Lock File
Check PID number in lock file	1.85 s	Lock File
Check PID number in lock file after restarting the services	62.441 s	Lock File
Check starting same service twice	1.127 s	Lock File
Switch off lock file creation	1.854 s	Lock File
Set configuration when file exists	14.043 s	Configuration Operation
Set configuration when file does not exist	5.455 s	Configuration Operation
Set configuration with broken url	4.777 s	Configuration Operation
Get configuration	5.398 s	Configuration Operation
Get non existent configuration file	4.868 s	Configuration Operation
Get non existent configuration type	4.541 s	Configuration Operation
Update configuration plugin config via cloud	5.162 s	Configuration Operation
Modify configuration plugin config via local filesystem modify inplace	2.911 s	Configuration Operation
Modify configuration plugin config via local filesystem overwrite	5.15 s	Configuration Operation
Update configuration plugin config via local filesystem copy	5.622 s	Configuration Operation
Update configuration plugin config via local filesystem move (different directory)	3.27 s	Configuration Operation
Update configuration plugin config via local filesystem move (same directory)	2.871 s	Configuration Operation
Update the custom operation dynamically	60.955 s	Dynamically Reload Operation
Custom operation successful	127.903 s	Custom Operation
Custom operation fails	79.452 s	Custom Operation
Successful firmware operation	132.71 s	Firmware Operation
Install with empty firmware name	57.594 s	Firmware Operation
Prerequisite Parent	15.722 s	Firmware Operation Child Device
Prerequisite Child	8.181 s	Firmware Operation Child Device
Child device firmware update	6.545 s	Firmware Operation Child Device
Child device firmware update with cache	6.15 s	Firmware Operation Child Device
Firmware plugin supports restart via service manager #1932	4.745 s	Firmware Operation Child Device Retry
Update Inventory data via inventory.json	1.452 s	Inventory Update
Inventory includes the agent fragment with version information	0.942 s	Inventory Update
Retrieve a JWT tokens	29.006 s	Jwt Request
Mapper recovers and processes output of ongoing software update request	15.755 s	Recover And Publish Software Update Message
Check running collectd	1.321 s	Monitor Device Collectd
Is collectd publishing MQTT messages?	3.031 s	Monitor Device Collectd
Check thin-edge monitoring	3.9859999999999998 s	Monitor Device Collectd
Check grouping of measurements	9.325 s	Monitor Device Collectd
Main device registration	2.243 s	Device Registration
Child device registration	3.076 s	Device Registration
Supports restarting the device	56.004 s	Restart Device
Update tedge version from previous using Cumulocity	101.023 s	Tedge Self Update
Test if all c8y services are up	120.734 s	Service Monitoring
Test if all c8y services are down	117.988 s	Service Monitoring
Test if all c8y services are using configured service type	289.339 s	Service Monitoring
Test if all c8y services using default service type when service type configured as empty	149.008 s	Service Monitoring
Check health status of tedge-mapper-c8y service on broker stop start	24.087 s	Service Monitoring
Check health status of tedge-mapper-c8y service on broker restart	24.701 s	Service Monitoring
Check health status of child device service	19.597 s	Service Monitoring
Successful shell command with output	4.005 s	Shell Operation
Check Successful shell command with literal double quotes output	3.732 s	Shell Operation
Execute multiline shell command	3.545 s	Shell Operation
Failed shell command	3.509 s	Shell Operation
Software list should be populated during startup	48.31 s	Software
Install software via Cumulocity	66.798 s	Software
tedge-agent should terminate on SIGINT while downloading file	56.226 s	Software
Software list should only show currently installed software and not candidates	34.911 s	Software
Create and publish the tedge agent supported operations on mapper restart	42.277 s	Mapper-Publishing-Agent-Supported-Ops
Agent gets the software list request once it comes up	38.935 s	Mapper-Publishing-Agent-Supported-Ops
Child devices support sending simple measurements	1.799 s	Child Device Telemetry
Child devices support sending custom measurements	1.694 s	Child Device Telemetry
Child devices support sending custom events	1.5590000000000002 s	Child Device Telemetry
Child devices support sending custom events overriding the type	1.65 s	Child Device Telemetry
Child devices support sending custom alarms #1699	1.845 s	Child Device Telemetry
Child devices support sending inventory data via c8y topic	1.887 s	Child Device Telemetry
Child device supports sending custom child device measurements directly to c8y	2.113 s	Child Device Telemetry
Check retained alarms	227.756 s	Raise Alarms
Thin-edge devices support sending simple measurements	1.662 s	Thin-Edge Device Telemetry
Thin-edge devices support sending simple measurements with custom type	1.689 s	Thin-Edge Device Telemetry
Thin-edge devices support sending custom measurements	1.414 s	Thin-Edge Device Telemetry
Thin-edge devices support sending custom events	1.264 s	Thin-Edge Device Telemetry
Thin-edge devices support sending custom events overriding the type	1.346 s	Thin-Edge Device Telemetry
Thin-edge devices support sending custom alarms #1699	3.6470000000000002 s	Thin-Edge Device Telemetry
Thin-edge device supports sending custom Thin-edge device measurements directly to c8y	1.67 s	Thin-Edge Device Telemetry
Thin-edge device support sending inventory data via c8y topic	1.841 s	Thin-Edge Device Telemetry
thin-edge components support a custom config-dir location via flags	27.483 s	Config Dir
Validate updated data path used by tedge-agent	2.57 s	Data Path Config
Validate updated data path used by c8y-firmware-plugin	10.867 s	Data Path Config
Validate updated data path used by tedge-agent	0.511 s	Log Path Config
Check existence of init directories	0.795 s	Tedge Init
Tedge init and check creation of folders	1.008 s	Tedge Init
Check ownership of the folders	0.928 s	Tedge Init
Change user/group and check the change	1.058 s	Tedge Init
Tedge init and check if default values are restored	0.987 s	Tedge Init
Install thin-edge via apt	64.286 s	Install Apt
Install latest via script (from current branch)	33.105 s	Install Tedge
Install specific version via script (from current branch)	32 s	Install Tedge
Install latest tedge via script (from main branch)	27.641 s	Install Tedge
Install then uninstall latest tedge via script (from main branch)	76.133 s	Install Tedge
Support starting and stopping services	45.007 s	Service-Control
Supports a reconnect	59.038 s	Test-Commands
Supports disconnect then connect	43.699 s	Test-Commands
Update unknown setting	38.146 s	Test-Commands
Update known setting	44.198 s	Test-Commands
It checks MQTT messages using a pattern	70.197 s	Test-Mqtt
Stop c8y-configuration-plugin	0.147 s	Health C8Y-Configuration-Plugin
Update the service file	0.126 s	Health C8Y-Configuration-Plugin
Reload systemd files	0.467 s	Health C8Y-Configuration-Plugin
Start c8y-configuration-plugin	0.144 s	Health C8Y-Configuration-Plugin
Start watchdog service	10.249 s	Health C8Y-Configuration-Plugin
Check PID of c8y-configuration-plugin	0.082 s	Health C8Y-Configuration-Plugin
Kill the PID	0.254 s	Health C8Y-Configuration-Plugin
Recheck PID of c8y-configuration-plugin	6.435 s	Health C8Y-Configuration-Plugin
Compare PID change	0.001 s	Health C8Y-Configuration-Plugin
Stop watchdog service	0.171 s	Health C8Y-Configuration-Plugin
Remove entry from service file	0.122 s	Health C8Y-Configuration-Plugin
Stop c8y-log-plugin	0.163 s	Health C8Y-Log-Plugin
Update the service file	0.151 s	Health C8Y-Log-Plugin
Reload systemd files	0.396 s	Health C8Y-Log-Plugin
Start c8y-log-plugin	0.158 s	Health C8Y-Log-Plugin
Start watchdog service	10.156 s	Health C8Y-Log-Plugin
Check PID of c8y-log-plugin	0.118 s	Health C8Y-Log-Plugin
Kill the PID	0.182 s	Health C8Y-Log-Plugin
Recheck PID of c8y-log-plugin	6.521 s	Health C8Y-Log-Plugin
Compare PID change	0.001 s	Health C8Y-Log-Plugin
Stop watchdog service	0.181 s	Health C8Y-Log-Plugin
Remove entry from service file	0.302 s	Health C8Y-Log-Plugin
Stop tedge-mapper	0.181 s	Health Tedge Mapper C8Y
Update the service file	0.119 s	Health Tedge Mapper C8Y
Reload systemd files	0.37 s	Health Tedge Mapper C8Y
Start tedge-mapper	0.1 s	Health Tedge Mapper C8Y
Start watchdog service	10.157 s	Health Tedge Mapper C8Y
Check PID of tedge-mapper	0.277 s	Health Tedge Mapper C8Y
Kill the PID	0.474 s	Health Tedge Mapper C8Y
Recheck PID of tedge-mapper	6.827 s	Health Tedge Mapper C8Y
Compare PID change	0.007 s	Health Tedge Mapper C8Y
Stop watchdog service	0.194 s	Health Tedge Mapper C8Y
Remove entry from service file	0.166 s	Health Tedge Mapper C8Y
Stop tedge-agent	0.134 s	Health Tedge-Agent
Update the service file	0.094 s	Health Tedge-Agent
Reload systemd files	0.533 s	Health Tedge-Agent
Start tedge-agent	0.178 s	Health Tedge-Agent
Start watchdog service	10.201 s	Health Tedge-Agent
Check PID of tedge-mapper	0.123 s	Health Tedge-Agent
Kill the PID	0.341 s	Health Tedge-Agent
Recheck PID of tedge-agent	7.049 s	Health Tedge-Agent
Compare PID change	0.001 s	Health Tedge-Agent
Stop watchdog service	0.332 s	Health Tedge-Agent
Remove entry from service file	0.244 s	Health Tedge-Agent
Stop tedge-mapper-az	0.207 s	Health Tedge-Mapper-Az
Update the service file	0.208 s	Health Tedge-Mapper-Az
Reload systemd files	0.723 s	Health Tedge-Mapper-Az
Start tedge-mapper-az	0.185 s	Health Tedge-Mapper-Az
Start watchdog service	10.229 s	Health Tedge-Mapper-Az
Check PID of tedge-mapper-az	0.066 s	Health Tedge-Mapper-Az
Kill the PID	0.168 s	Health Tedge-Mapper-Az
Recheck PID of tedge-agent	6.702 s	Health Tedge-Mapper-Az
Compare PID change	0.006 s	Health Tedge-Mapper-Az
Stop watchdog service	0.261 s	Health Tedge-Mapper-Az
Remove entry from service file	0.241 s	Health Tedge-Mapper-Az
Stop tedge-mapper-collectd	0.197 s	Health Tedge-Mapper-Collectd
Update the service file	0.121 s	Health Tedge-Mapper-Collectd
Reload systemd files	0.587 s	Health Tedge-Mapper-Collectd
Start tedge-mapper-collectd	0.23 s	Health Tedge-Mapper-Collectd
Start watchdog service	10.418 s	Health Tedge-Mapper-Collectd
Check PID of tedge-mapper-collectd	0.105 s	Health Tedge-Mapper-Collectd
Kill the PID	0.261 s	Health Tedge-Mapper-Collectd
Recheck PID of tedge-mapper-collectd	6.511 s	Health Tedge-Mapper-Collectd
Compare PID change	0.008 s	Health Tedge-Mapper-Collectd
Stop watchdog service	0.245 s	Health Tedge-Mapper-Collectd
Remove entry from service file	0.209 s	Health Tedge-Mapper-Collectd
tedge-collectd-mapper health status	6.324 s	Health Tedge-Mapper-Collectd
c8y-log-plugin health status	5.77 s	MQTT health endpoints
c8y-configuration-plugin health status	6.001 s	MQTT health endpoints
Publish on a local insecure broker	0.363 s	Basic Pub Sub
Publish on a local secure broker	2.333 s	Basic Pub Sub
Publish on a local secure broker with client authentication	1.734 s	Basic Pub Sub
Publish events to subscribed topic	0.398 s	Custom Sub Topics Tedge-Mapper-Aws
Publish measurements to unsubscribed topic	5.34 s	Custom Sub Topics Tedge-Mapper-Aws
Publish measurements to subscribed topic	0.24 s	Custom Sub Topics Tedge-Mapper-Az
Publish measurements to unsubscribed topic	5.442 s	Custom Sub Topics Tedge-Mapper-Az
Publish events to subscribed topic	0.361 s	Custom Sub Topics Tedge-Mapper-C8Y
Publish measurements to unsubscribed topic	5.362 s	Custom Sub Topics Tedge-Mapper-C8Y
Check remote mqtt broker #1773	3.738 s	Remote Mqtt Broker
Apply name filter	0.163 s	Filter Packages List Output
Apply maintainer filter	0.143 s	Filter Packages List Output
Apply both filters	0.141 s	Filter Packages List Output
No filters	0.126 s	Filter Packages List Output
Both filters but name filter as empty string	0.111 s	Filter Packages List Output
Both filters but maintainer filter as empty string	0.129 s	Filter Packages List Output
Both filters as empty string	0.186 s	Filter Packages List Output
Wrong package name	0.146 s	Improve Tedge Apt Plugin Error Messages
Wrong version	0.149 s	Improve Tedge Apt Plugin Error Messages
Wrong type	0.405 s	Improve Tedge Apt Plugin Error Messages
tedge_connect_test_positive	0.342 s	Tedge Connect Test
tedge_connect_test_negative	1.625 s	Tedge Connect Test
tedge_connect_test_sm_services	7.779 s	Tedge Connect Test
tedge_disconnect_test_sm_services	60.515 s	Tedge Connect Test
Install thin-edge.io	25.576999999999998 s	Call Tedge
call tedge -V	0.141 s	Call Tedge
call tedge -h	0.207 s	Call Tedge
call tedge -h -V	0.203 s	Call Tedge
call tedge help	0.183 s	Call Tedge
tedge config list	0.087 s	Call Tedge Config List
tedge config list --all	0.136 s	Call Tedge Config List
set/unset device.type	0.736 s	Call Tedge Config List
set/unset device.key_path	0.41 s	Call Tedge Config List
set/unset device.cert_path	0.541 s	Call Tedge Config List
set/unset c8y.root_cert_path	0.627 s	Call Tedge Config List
set/unset c8y.smartrest.templates	0.555 s	Call Tedge Config List
set/unset c8y.topics	0.493 s	Call Tedge Config List
set/unset az.root_cert_path	0.772 s	Call Tedge Config List
set/unset az.topics	0.473 s	Call Tedge Config List
set/unset aws.topics	0.493 s	Call Tedge Config List
set/unset aws.url	0.489 s	Call Tedge Config List
set/unset aws.root_cert_path	0.571 s	Call Tedge Config List
set/unset aws.mapper.timestamp	0.339 s	Call Tedge Config List
set/unset az.mapper.timestamp	0.35 s	Call Tedge Config List
set/unset mqtt.bind.address	0.624 s	Call Tedge Config List
set/unset mqtt.bind.port	0.36 s	Call Tedge Config List
set/unset http.bind.port	0.332 s	Call Tedge Config List
set/unset tmp.path	0.333 s	Call Tedge Config List
set/unset logs.path	0.288 s	Call Tedge Config List
set/unset run.path	0.312 s	Call Tedge Config List
set/unset firmware.child.update.timeout	0.481 s	Call Tedge Config List
set/unset c8y.url	0.318 s	Call Tedge Config List
set/unset az.url	0.274 s	Call Tedge Config List
set/unset mqtt.external.bind.port	0.304 s	Call Tedge Config List
mqtt.external.bind.address	0.399 s	Call Tedge Config List
mqtt.external.bind.interface	0.336 s	Call Tedge Config List
set/unset mqtt.external.ca_path	0.374 s	Call Tedge Config List
set/unset mqtt.external.cert_file	0.394 s	Call Tedge Config List
set/unset mqtt.external.key_file	0.436 s	Call Tedge Config List
set/unset software.plugin.default	0.335 s	Call Tedge Config List
Get Put Delete	1.8519999999999999 s	Http File Transfer Api
Set keys should return value on stdout	0.1 s	Tedge Config Get
Unset keys should not return anything on stdout and warnings on stderr	0.194 s	Tedge Config Get
Invalid keys should not return anything on stdout and warnings on stderr	0.199 s	Tedge Config Get
Set configuration via environment variables	0.7 s	Tedge Config Get
Set configuration via environment variables for topics	0.258 s	Tedge Config Get
Set unknown configuration via environment variables	0.062 s	Tedge Config Get