summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDidier Wenzek <didier.wenzek@free.fr>2022-04-26 18:48:40 +0100
committerDidier Wenzek <didier.wenzek@free.fr>2022-04-27 09:47:13 +0100
commit88a09cd5386d8fc2d0aaf9d9ffcd1b4cbc4442ad (patch)
tree35dea2c500287ec979dd1db2633329eaee344f43 /docs
parent04b4472e5073566f81ad392f47e21388768424d5 (diff)
Specify config update notification
Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
Diffstat (limited to 'docs')
-rw-r--r--docs/src/references/c8y-configuration-management.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/src/references/c8y-configuration-management.md b/docs/src/references/c8y-configuration-management.md
index 21703a53..e051d171 100644
--- a/docs/src/references/c8y-configuration-management.md
+++ b/docs/src/references/c8y-configuration-management.md
@@ -19,6 +19,7 @@ Thin-edge provides an operation plugin to
__these files are stored in a temporary directory first__.
They are atomically moved to their target path, only after a fully successful download.
The aim is to avoid breaking the system with half downloaded files.
+* When a downloaded file is copied to its target, the unix user, group and mod are preserved.
* Once a snapshot has been downloaded from Cumulocity to the device,
__the plugin publishes a notification message on the local thin-edge MQTT bus__.
The device software has to subscribe to these messages if any action is required,
@@ -136,11 +137,18 @@ The `c8y_configuration_plugin` reports progress and errors on its `stderr`.
* All changes to the list of managed file is logged, one line per change.
* All errors are reported with the operation context (upload or download? which file?).
+## Notifications
+
+When a configuration file is successfully downloaded from the cloud,
+the `c8y_configuration_plugin` service notifies this update over MQTT.
+
+* Each message provides the path to the freshly updated file as in `{ "changedFile": "/etc/tedge/tedge.toml" }`.
+* The messages are published on `tedge/configuration_change`.
+
## Internals
Points that still need to be addressed:
-* Which topic and message payload to notify successfully changed configuration.
* The user running `c8y_configuration_plugin` must have read and write access
to all the files listed by the configuration `/etc/tedge/c8y/c8y-configuration-plugin.toml`.
* When a download file is copied to its target, the unix user, group and mod must be preserved.