summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorinitard <solo@softwareag.com>2022-07-23 17:14:37 +0100
committerinitard <alex.solomes@softwareag.com>2022-07-29 13:12:28 +0100
commitb5b97198e2b039fd70ddf67a246ca3e351a50c23 (patch)
tree45c99be91bfe781f4ee338e5bce834943775509a
parent72b8bf44c15df2ca890f8dc40cbc9111ba8bc9e2 (diff)
updating c8y-configuration-management reference doc
Signed-off-by: initard <solo@softwareag.com>
-rw-r--r--docs/src/references/c8y-configuration-management.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/src/references/c8y-configuration-management.md b/docs/src/references/c8y-configuration-management.md
index cab49bb4..938bae86 100644
--- a/docs/src/references/c8y-configuration-management.md
+++ b/docs/src/references/c8y-configuration-management.md
@@ -120,19 +120,19 @@ USAGE:
OPTIONS:
--config-dir <CONFIG_DIR> [default: /etc/tedge]
- --config-file <CONFIG_FILE> [default: $CONFIG_DIR/c8y/c8y-configuration-plugin.toml]
--debug Turn-on the debug log level
-h, --help Print help information
-i, --init Create supported operation files
-V, --version Print version information
On start, `c8y_configuration_plugin` notifies the cloud tenant of the managed configuration files,
- listed in the `CONFIG_FILE`, sending this list with a `119` on `c8y/s/us`.
+ listed in `CONFIG_DIR/c8y/c8y-configuration-plugin.toml`, sending this list with a `119` on `c8y/s/us`.
`c8y_configuration_plugin` subscribes then to `c8y/s/ds` listening for configuration operation
requests (messages `524` and `526`).
notifying the Cumulocity tenant of their progress (messages `501`, `502` and `503`).
The thin-edge `CONFIG_DIR` is used to find where:
+ * to store the configuration file: `c8y/c8y-configuration-plugin.toml`
* to store temporary files on download: `tedge config get tmp.path`,
* to connect the MQTT bus: `tedge config get mqtt.port`.
```
@@ -162,4 +162,4 @@ Note that:
for instance `tedge/configuration_change//etc/tedge/mosquitto-conf/c8y-bridge.conf`.
* Since the type of configuration file is used as an MQTT topic name, the characters `#` and `+` cannot be used in a type name.
If such a character is used in a type name (or in the path of a configuration file without explicit type),
- then the whole plugin configuration `/etc/tedge/c8y/c8y-configuration-plugin.toml` is considered ill-formed. \ No newline at end of file
+ then the whole plugin configuration `/etc/tedge/c8y/c8y-configuration-plugin.toml` is considered ill-formed.