Skip to content

Commit

Permalink
Merge pull request #101 from reubenmiller/chore-backport-update-links…
Browse files Browse the repository at this point in the history
…-1.4.2

docs: backporting cumulocity documentation links to 1.4.2
  • Loading branch information
reubenmiller authored Jan 30, 2025
2 parents 2b0c1c9 + 1b508e8 commit 725a39b
Show file tree
Hide file tree
Showing 48 changed files with 230 additions and 227 deletions.
2 changes: 1 addition & 1 deletion versioned_docs/version-1.4.2/.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.4.2
1.4.2-82-gce649ba125 main
6 changes: 3 additions & 3 deletions versioned_docs/version-1.4.2/contribute/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ Current MSRV is `1.65`.
### Cross compilation toolchain (optional)

%%te%% can be compiled for target architecture on non-target device, this is called cross compilation.
Currently we support `Raspberry Pi 3B` for `armv7` architecture with Rust's cross compilation toolchain called [cargo cross](https://github.com/rust-embedded/cross).
Currently we support `Raspberry Pi 3B` for `armv7` architecture with Rust's cross compilation toolchain called [cargo cross](https://github.com/cross-rs/cross).

To install [cargo cross](https://github.com/rust-embedded/cross):
To install [cargo cross](https://github.com/cross-rs/cross):

```sh
cargo install cross
Expand Down Expand Up @@ -179,7 +179,7 @@ total 2948

## Cross compiling

To create binaries which can run on different platform than one you are currently on you can use [cargo cross](https://github.com/rust-embedded/cross):
To create binaries which can run on different platform than one you are currently on you can use [cargo cross](https://github.com/cross-rs/cross):

```sh
cross build --target armv7-unknown-linux-gnueabihf
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Feel free to clone the project if you want to make your own customizations, howe

### Pre-requisites

To run the project tasks, you will need to install a command line tool called [just](https://just.systems/man/en/chapter_5.html).
To run the project tasks, you will need to install a command line tool called [just](https://just.systems/man/en/packages.html).

You can install just using on of the following commands:

Expand All @@ -59,7 +59,7 @@ cargo install just
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | sudo bash -s -- --to /usr/bin
```

For other installation possibilities check out the [just documentation](https://just.systems/man/en/chapter_4.html).
For other installation possibilities check out the [just documentation](https://just.systems/man/en/packages.html).

### Cloning the project {#clone-project}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,13 @@ The project uses different Yocto layers to build an image which contains:
cd meta-tedge/kas
```

2. Install [just](https://just.systems/man/en/chapter_5.html) which is used to run different tasks provided by the project
2. Install [just](https://just.systems/man/en/packages.html) which is used to run different tasks provided by the project

```sh
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | sudo bash -s -- --to /usr/bin
```

Check out the [justfile website](https://just.systems/man/en/chapter_5.html) for more installation options.
Check out the [justfile website](https://just.systems/man/en/packages.html) for more installation options.

3. Install [kas](https://kas.readthedocs.io/en/latest/) which is used to managed bitbake projects

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Child Device Configuration Management
tags: [Cumulocity, Configuration, Legacy]
sidebar_position: 6
description: Legacy configuration management for child devices using Cumulocity IoT
description: Legacy configuration management for child devices using Cumulocity
---

# Enable configuration management on child devices
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: Child Device Firmware Management
tags: [Cumulocity, Firmware, Legacy]
sidebar_position: 9
description: Legacy child device firmware management using Cumulocity IoT
description: Legacy child device firmware management using Cumulocity
---

# Child-Device Firmware Management using Cumulocity (legacy API)

%%te%% provides a legacy operation plugin to
[manage device firmware using Cumulocity](https://cumulocity.com/guides/users-guide/device-management/#firmware-repo)
[manage device firmware using Cumulocity](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-firmware)
on child devices.

:::caution
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1.4.2/operate/c8y/apama.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Further details about this can be found in the %%te%% documentation at [Manage t

#### Set up the Debian repository from which the Apama packages will be installed

1. In the Cumulocity IoT tenant, open the **Device Management** app, go to the **Management** menu option and select the **Software repository**.
1. In the Cumulocity tenant, open the **Device Management** app, go to the **Management** menu option and select the **Software repository**.
2. Click **Add software** at the right of the top menu bar.
3. In the **ADD SOFTWARE** dialog enter the following details:
- **Software**: apama-repo
Expand Down Expand Up @@ -82,7 +82,7 @@ Follow the instructions [here](https://github.com/thin-edge/thin-edge.io_example
You can test if the project was successfully installed by running the following Apama command:

```sh
/opt/softwareag/Apama/bin/apama_env engine_inspect -m
/opt/cumulocity/Apama/bin/apama_env engine_inspect -m
```

```text title="Example Output"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ tags: [Operate, Cumulocity, Configuration]
description: Managing configuration on devices
---

With %%te%%, you can manage config files on a device by using the [Cumulocity configuration management feature](https://cumulocity.com/guides/users-guide/device-management/#managing-configurations) as a part of Device Management.
With %%te%%, you can manage config files on a device by using the [Cumulocity configuration management feature](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-configurations) as a part of Device Management.

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.
we recommend you to read [the Cumulocity user guide](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-configurations) along with this how-to guide.

The configuration management functionality is provided by the **tedge-agent** service which is installed by default.

Expand Down Expand Up @@ -52,7 +52,7 @@ This is the configuration file of `tedge-configuration-plugin`, where you can ad

## Update tedge-configuration-plugin configuration 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.
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/docs/device-management-application/managing-device-data/#to-add-a-configuration-snapshot) with the appropriate configuration type.

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**.

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1.4.2/operate/c8y/connect.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Connect
tags: [Operate, Cloud]
description: Connecting %%te%% to Cumulocity IoT
description: Connecting %%te%% to Cumulocity
---

import UserContext from '@site/src/components/UserContext';
Expand Down Expand Up @@ -59,7 +59,7 @@ in this case we are told to run `tedge config set c8y.url <value>`.
## Making the cloud trust the device

The next step is to have the device certificate trusted by Cumulocity. This is done by uploading the certificate of the signee.
You can upload the root certificate using the [Cumulocity UI](https://cumulocity.com/guides/users-guide/device-management/#trusted-certificates)
You can upload the root certificate using the [Cumulocity UI](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-trusted-certificates)
or with [`tedge cert upload`](../../references/cli/tedge-cert.md) command as described below.

:::note
Expand Down
10 changes: 5 additions & 5 deletions versioned_docs/version-1.4.2/operate/c8y/custom-fragments.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Custom Fragments
tags: [Operate, Cumulocity]
description: Publishing custom fragments/properties to Cumulocity IoT
description: Publishing custom fragments/properties to Cumulocity
---

%%te%% supports update custom fragments (also known as properties) on the device's digital twin representation in Cumulocity IoT.
%%te%% supports update custom fragments (also known as properties) on the device's digital twin representation in Cumulocity.

## Default fragments

By default, the device will send the following information to Cumulocity IoT. The information makes it easy to identify devices which are using %%te%% in your fleet.
By default, the device will send the following information to Cumulocity. The information makes it easy to identify devices which are using %%te%% in your fleet.

```json
{
Expand Down Expand Up @@ -53,7 +53,7 @@ tedge mqtt pub te/device/main///twin/os_Version '{
}'
```

The example above will result in the following fragment being added to the device's digital twin (e.g. *Managed Object*) in Cumulocity IoT.
The example above will result in the following fragment being added to the device's digital twin (e.g. *Managed Object*) in Cumulocity.

```json5
{
Expand Down Expand Up @@ -105,4 +105,4 @@ In the Cumulocity UI this will looks something like this:


For information on which fragments Cumulocity supports please see the
[Cumulocity API docs](https://cumulocity.com/guides/reference/device-management-library/).
[Cumulocity API docs](https://cumulocity.com/docs/device-integration/fragment-library/).
12 changes: 6 additions & 6 deletions versioned_docs/version-1.4.2/operate/c8y/device-availability.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ description: Monitoring the availability of devices

# Availability Monitoring

%%te%% fully supports the [Cumulocity IoT's device availability monitoring feature](https://cumulocity.com/docs/device-management-application/monitoring-and-controlling-devices/#availability)
%%te%% fully supports the [Cumulocity's device availability monitoring feature](https://cumulocity.com/docs/device-management-application/monitoring-and-controlling-devices/#availability)
allowing you to set the desired required interval for the devices
and also sending heartbeats to **Cumulocity IoT** periodically when a device is deemed available.
and also sending heartbeats to **Cumulocity** periodically when a device is deemed available.
%%te%% considers a device as available when the `tedge-agent` service on it is up and running,
monitored using its service health endpoint.
The health endpoint can be changed from the `tedge-agent` to any other entity's health endpoint as well.

## Set the required availability interval

As described in the [Cumulocity IoT's user documentation](https://cumulocity.com/docs/device-integration/fragment-library/#device-availability),
As described in the [Cumulocity's user documentation](https://cumulocity.com/docs/device-integration/fragment-library/#device-availability),
%%te%% main and child devices set their required interval during their first connection.
Availability monitoring is enabled by default with a default required interval of 1 hour.
The value to be updated using the `tedge config set` command as follows:
Expand All @@ -29,7 +29,7 @@ availability monitoring is disabled and the device is considered to be in mainte

## Change the health endpoint for heartbeat messages

Once the device connection to **Cumulocity IoT** is established,
Once the device connection to **Cumulocity** is established,
**tedge-mapper-c8y** will keep sending heartbeat messages (empty inventory update messages) on behalf of the main and child devices
to keep their availability active.
By default, the status of the **tedge-agent** service is used to determine whether the device is available or not.
Expand All @@ -48,7 +48,7 @@ tedge mqtt pub te/device/my-device// '{"@health":"device/my-device/service/foo",
```

If the status of the new endpoint is reported as `up`, the device is considered "available",
and a heartbeat signal is sent to Cumulocity IoT.
and a heartbeat signal is sent to Cumulocity.
If the status has any other value, the device is considered "unavailable",
and no heartbeat message are sent to Cumulocity until the status changes to `up` again.

Expand All @@ -61,4 +61,4 @@ To disable the feature, use the `tedge config set` command as follows and restar
sudo tedge config set c8y.availability.enable false
```

When disabled, the required availability interval and periodic heartbeat messages aren't sent to Cumulocity IoT.
When disabled, the required availability interval and periodic heartbeat messages aren't sent to Cumulocity.
4 changes: 2 additions & 2 deletions versioned_docs/version-1.4.2/operate/c8y/device-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ description: Managing device profiles on devices

## Management

%%te%% enables you to manage the firmware, software and configuration for a device in a single operation which makes it suitable for managing a large fleet of devices. The following sections detail how to create and assign a device profile to a device. Using Cumulocity IoT, you can either assign a device profile using a single operation (described on this page), or by using a [bulk operation](https://cumulocity.com/docs/device-management-application/monitoring-and-controlling-devices/#to-add-a-bulk-operation) to assign it to a fleet of devices.
%%te%% enables you to manage the firmware, software and configuration for a device in a single operation which makes it suitable for managing a large fleet of devices. The following sections detail how to create and assign a device profile to a device. Using Cumulocity, you can either assign a device profile using a single operation (described on this page), or by using a [bulk operation](https://cumulocity.com/docs/device-management-application/monitoring-and-controlling-devices/#to-add-a-bulk-operation) to assign it to a fleet of devices.

:::info
For more detailed information on the Cumulocity IoT **Device Management** features, please check out the [official documentation](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-device-profiles).
For more detailed information on the Cumulocity **Device Management** features, please check out the [official documentation](https://cumulocity.com/docs/device-management-application/managing-device-data/#managing-device-profiles).
:::

### To add a new device profile {#add-to-repo}
Expand Down
8 changes: 4 additions & 4 deletions versioned_docs/version-1.4.2/operate/c8y/health-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Monitoring the health of services on devices
---

The health of a %%te%% service or any other `service` that is running on the %%te%% device
or on the `child` device can be monitored from the **Cumulocity IoT** by sending the `health-status` message to **Cumulocity IoT**.
or on the `child` device can be monitored from the **Cumulocity** by sending the `health-status` message to **Cumulocity**.

## Publish health status

Expand All @@ -28,7 +28,7 @@ The health status message has to be sent as a *retain* message.

When an empty health status message is sent, e.g. `{}` or `''`, the `status` will be replaced with `unknown`.

## Conversion of the health status message to Cumulocity IoT service monitor message
## Conversion of the health status message to Cumulocity service monitor message

The `tedge-mapper-c8y` will translate any health status message that is received on `te/+/+/+/+/status/health` topic to
Cumulocity [Service creation](https://cumulocity.com/docs/smartrest/mqtt-static-templates/#102) SmartREST message and
Expand All @@ -52,7 +52,7 @@ tedge mqtt pub te/device/child1/service/service1/status/health '{"status":"up"}'

<div class="code-indent-right">

**Cumulocity IoT (output)**
**Cumulocity (output)**

```text title="Topic"
c8y/s/us/<device-id>:device:child1
Expand Down Expand Up @@ -90,4 +90,4 @@ sudo tedge config unset service.type

More info about the service monitoring can be found in the link below.

[Service monitoring Cumulocity IoT](https://cumulocity.com/docs/device-management-application/viewing-device-details/#services)
[Service monitoring Cumulocity](https://cumulocity.com/docs/device-management-application/viewing-device-details/#services)
2 changes: 1 addition & 1 deletion versioned_docs/version-1.4.2/operate/c8y/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Device Management with Cumulocity
tags: [Operate, Cloud]
sidebar_position: 9
description: Device management with %%te%% and Cumulocity IoT
description: Device management with %%te%% and Cumulocity
---

import DocCardList from '@theme/DocCardList';
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1.4.2/operate/c8y/remote-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Accessing devices remote using tcp based protocols (e.g. ssh, vnc e

To access a device remotely that runs %%te%%, a plugin of the operation plugin concept is used. The tedge-mapper is checking for cloud remote access operation and is triggering the particular plugin. You can use the remote access tab in device management to access the device via SSH or VNC.

Background information on the remote access feature provided by Cumulocity IoT can be found in their [official documentation](https://cumulocity.com/guides/cloud-remote-access/using-cloud-remote-access/).
Background information on the remote access feature provided by Cumulocity can be found in their [official documentation](https://cumulocity.com/docs/cloud-remote-access/using-cloud-remote-access/).

## Requirements

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-1.4.2/operate/c8y/restart-device.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ description: Restarting a device from the cloud

If your device is running %%te%%, you can restart it from the cloud.

### Cumulocity IoT
### Cumulocity

1. Go to the *Device Management* application in Cumulocity IoT
1. Go to the *Device Management* application in Cumulocity

2. Find your device and open up its homepage

Expand Down
Loading

0 comments on commit 725a39b

Please sign in to comment.