Skip to content

Commit

Permalink
replace c8y-configuration-plugin with tedge-configuration-plugin
Browse files Browse the repository at this point in the history
Signed-off-by: Reuben Miller <[email protected]>
  • Loading branch information
reubenmiller committed Oct 28, 2023
1 parent 212cdfa commit 7259158
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 23 deletions.
22 changes: 11 additions & 11 deletions docs/src/operate/c8y/config_management_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ With `thin-edge.io`, you can manage config files on a device by using the [Cumul
If you are new to the Cumulocity **Configuration Management** feature,
we recommend you to read [the Cumulocity user guide](https://cumulocity.com/guides/users-guide/device-management/#managing-configurations) along with this how-to guide.

The configuration management functionality is provided by the `c8y-configuration-plugin` package which is installed by default. If it is not installed then please install the components again following the [install guide](../../install/index.md).
The configuration management functionality is provided by the `tedge-configuration-plugin` package which is installed by default. If it is not installed then please install the components again following the [install guide](../../install/index.md).

## Getting started

Before starting anything, make sure [your device is connected to Cumulocity](../../start/connect-c8y.md).

**Step 1**
Open the file `/etc/tedge/c8y/c8y-configuration-plugin.toml` and add entries for the configuration files that you'd like to manage from Cumulocity cloud in the following format:
Open the file `/etc/tedge/plugins/tedge-configuration-plugin.toml` and add entries for the configuration files that you'd like to manage from Cumulocity cloud in the following format:

```toml title="file: /etc/tedge/c8y/c8y-configuration-plugin.toml"
```toml title="file: /etc/tedge/plugins/tedge-configuration-plugin.toml"
files = [
{ path = '/etc/tedge/tedge.toml', type = 'tedge.toml'},
{ path = '/etc/tedge/mosquitto-conf/c8y-bridge.conf', type = 'c8y-bridge.conf' },
Expand All @@ -37,36 +37,36 @@ files = [
For more details on this configuration file format, refer to the [reference guide](../../references/agent/tedge-configuration-management.md#configuration).

:::note
You can also configure the `c8y-configuration-plugin.toml` from the cloud later.
You can also configure the `tedge-configuration-plugin.toml` from the cloud later.
:::

**Step 2**
Start the configuration plugin process and enable it on boot by `systemctl` (recommended).

```sh
sudo systemctl enable c8y-configuration-plugin
sudo systemctl start c8y-configuration-plugin
sudo systemctl enable tedge-configuration-plugin
sudo systemctl start tedge-configuration-plugin
```

Alternatively, you can run the process directly.

```sh
sudo c8y-configuration-plugin
sudo tedge-configuration-plugin
```

**Step 3**
Navigate to your Cumulocity Device Management and the desired device. Open its **Configuration** tab.
You can find `c8y-configuration-plugin` and more are listed as supported configuration types, as declared in the plugin configuration file in step 1.
You can find `tedge-configuration-plugin` and more are listed as supported configuration types, as declared in the plugin configuration file in step 1.

![Cumulocity Configuration Management Upload](../../images/c8y-config-plugin-upload.png)

This is the configuration file of `c8y-configuration-plugin`, where you can add file entries that you want to manage with Cumulocity.
This is the configuration file of `tedge-configuration-plugin`, where you can add file entries that you want to manage with Cumulocity.

## Update c8y-configuration-plugin from Cumulocity
## Update tedge-configuration-plugin from Cumulocity

To update any configuration file, create a local copy of that config file and then upload that file to the [Cumulocity configuration repository](https://cumulocity.com/guides/users-guide/device-management/#to-add-a-configuration-snapshot) with the appropriate configuration type.

The `c8y-configuration-plugin.toml` file can also be updated from the cloud in a similar manner to add/remove further configuration file entries. The updated TOML file has to be uploaded with the configuration type: **c8y-configuration-plugin**.
The `tedge-configuration-plugin.toml` file can also be updated from the cloud in a similar manner to add/remove further configuration file entries. The updated TOML file has to be uploaded with the configuration type: **tedge-configuration-plugin**.

Then, go back to the **Configuration** tab of your desired device in Cumulocity.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/operate/configuration/update_config_paths.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following table captures the paths that can be changed, with their default l

The following daemons also need to be re-started after `data.path` is updated:

* `c8y-configuration-plugin`
* `tedge-configuration-plugin`
* `c8y-firmware-plugin`

## Example: Set a custom temporary directory path
Expand Down
2 changes: 1 addition & 1 deletion docs/src/operate/troubleshooting/monitor_tedge_health.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The following endpoints are currently supported:
* `tedge/health/tedge-mapper-aws`
* `tedge/health/tedge-mapper-collectd`
* `tedge/health/tedge-log-plugin`
* `tedge/health/c8y-configuration-plugin`
* `tedge/health/tedge-configuration-plugin`

All future tedge services will also follow the same topic naming scheme convention.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/operate/troubleshooting/thin_edge_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ tedge-mapper = "trace"
tedge-agent = "info"
tedge-watchdog = "debug"
tedge-log-plugin = "warn"
c8y-configuration-plugin = "error"
tedge-configuration-plugin = "error"
```

:::note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ and to configuration update commands on the `<root>/<identifier>/cmd/config_upda

## Configuration

The `c8y-configuration-plugin` configuration is stored by default under `/etc/tedge/plugins/tedge-configuration-plugin.toml`
The `tedge-configuration-plugin` configuration is stored by default under `/etc/tedge/plugins/tedge-configuration-plugin.toml`

This [TOML](https://toml.io/en/) file defines the list of files to be managed by the plugin.
Each configuration file is defined by a record with:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/references/domain-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The figure below illustrates the child-device concept.
## Plugins

**thin-edge** realizes **Device Management** based on **plugins**.
* a **plugin** can be an (external) executable (e.g. as the `c8y-configuration-plugin` for _configuration management_)
* a **plugin** can be an (external) executable (e.g. as the `tedge-configuration-plugin` for _configuration management_)
or part of a thin-edge built-in software component (e.g. _software management_ in `tedge-agent`)
* to realize **Device Management** functionality, a **plugin** accesses _resources_ and _services_ of the device, as e.g.
* _software management_ uses the device's _package manager_
Expand Down
12 changes: 6 additions & 6 deletions docs/src/start/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ This functionality is directly installed with the initial script. However, it is

As an example you can copy the following content to add some new configuration files which can be retrieved or applied to the device:

```toml title="file: /etc/tedge/c8y/c8y-configuration-plugin.toml"
```toml title="file: /etc/tedge/plugins/tedge-configuration-plugin.toml"
files = [
{ path = '/etc/tedge/tedge.toml' },
{ path = '/etc/tedge/mosquitto-conf/c8y-bridge.conf', type = 'c8y-bridge.conf' },
Expand All @@ -405,11 +405,11 @@ Where:
If the configuration plugin service has not ready started, then you can configure the service to start automatically on boot, and start it now using (if you are using `systemd` on your device):

```sh
sudo systemctl enable c8y-configuration-plugin
sudo systemctl start c8y-configuration-plugin
sudo systemctl enable tedge-configuration-plugin
sudo systemctl start tedge-configuration-plugin
```

Then navigate to Cumulocity IoT Device Management and the desired device. Open its Configuration tab. You can find c8y-configuration-plugin and more are listed as supported configuration types, as declared in the plugin configuration file. Here you can save the configuration files into the repository or download them.
Then navigate to Cumulocity IoT Device Management and the desired device. Open its Configuration tab. You can find tedge-configuration-plugin and more are listed as supported configuration types, as declared in the plugin configuration file. Here you can save the configuration files into the repository or download them.


### Change configuration files via Cumulocity IoT.
Expand Down Expand Up @@ -450,7 +450,7 @@ To change the collectd metrics of the device, which are displayed in Cumulocity

1. Add a new entry to the `files` section of the plugin's configuration file

```toml title="file: /etc/tedge/c8y/c8y-configuration-plugin.toml"
```toml title="file: /etc/tedge/plugins/tedge-configuration-plugin.toml"
files = [
# ...
{path = '/etc/collectd/collectd.conf', type = 'collectd.conf'},
Expand Down Expand Up @@ -510,7 +510,7 @@ To see the content of the log files in Cumulocity IoT, take the following steps:

![Request Log file](./images/RequestLogfile.png)

If `tedge-log-plugin.toml` is added to the `c8y-configuration-plugin.toml` it is possible to do the administration from there.
If `tedge-log-plugin.toml` is added to the `tedge-configuration-plugin.toml` it is possible to do the administration from there.

<!-- TODO: Check if restarting the tedge-log-plugin is required each time the log file is edited -->

Expand Down
2 changes: 1 addition & 1 deletion docs/src/understand/tedge-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In the current version of thin-edge, the agent features are not implemented by a
but by a set of executables:

- `tedge-agent`
- `c8y-configuration-plugin`
- `tedge-configuration-plugin`
- `c8y-firmware-plugin`
- `tedge-log-plugin`
- `c8y-remote-access-plugin`
Expand Down

0 comments on commit 7259158

Please sign in to comment.