Connecting Edge to the cloud

Registering Edge in the cloud tenant

To manage, configure, and monitor remotely through a Cumulocity IoT cloud tenant, you must first register Edge as a device in the Cumulocity IoT cloud tenant. You can register Edge by providing the Cumulocity IoT cloud tenant URI, and optionally, TLS key and certificate chain with which Edge connects to cloud through MQTT protocol using an X.509 certificate for authentication. If you do not provide the TLS key and the certificate chain, the Edge Operator uses an internally generated TLS key and certificate for identifying Edge as a device to the cloud tenant. For completing the registration process, you must sign into your cloud tenant and follow the steps described in Managing trusted certificates to add the Certificate Authority (CA) certificate to the trusted certificate list of your tenant.

In case you let Edge use the internally generated TLS key and certificates, you can download the CA certificate by using the following command:

kubectl get edge c8yedge -n c8yedge --output jsonpath='{.status.helpCommands.fetchGeneratedCACrt}' | sh

Once registered, the Edge deployment appears as a device named after the domain name of your Edge instance. For example, if you have configured your domain name as myown.iot.com, the Edge deployment appears as myown.iot.com .

Upgrading Edge remotely

You can remotely update your instance of Edge using the Cumulocity IoT’s firmware update feature. This process requires you to upload a YAML file specifying the Edge version to your tenant account. For more information about the firmware feature, see Device Management > Managing device data > Managing device firmware in the User guide.

Update the sample version file to specify the Edge version follow the steps below to upgrade:

1. Log in to your Cumulocity IoT tenant account and go to the Device Management application.

2. In the Firmware repository page, click Add firmware and provide a name for the firmware, add a description and its version (all required).

   

   Optionally, you can define the device type filter when adding a new firmware. For example, c8y_EdgeAgent.

3. Select the Provide a file path option to specify an HTTPS URL of a server from where the version file can be downloaded.

   Click Add firmware. The firmware object appears in the firmware list.

4. Click All devices in the Devices menu, select your instance of Edge from the device list.

5. Click Firmware. The Firmware tab shows the current Edge version.

   

   You can also see the current Edge version in the Info tab.

   

6. Click Replace firmware.

7. Select the firmware that you just uploaded and click Install.

   • To check the status of the update, hover over the refresh icon as shown in the figure below:
   • To check the details of the update, click the text outlined in red in the figure below:

Updating Edge appliances using bulk operations

For information about updating Edge using bulk operations, see Updating Edge using bulk operations.

Downloading diagnostics remotely

You can download the diagnostics report remotely from your tenant account after you have registered your instance of Edge in the tenant account.

To download the diagnostics report from your tenant account:

1. Log in to your Cumulocity IoT tenant.

2. Go to the Device Management application.

3. Click Devices > All devices in the navigator.

4. Select your instance of Edge for which you want to download the diagnostics report.

5. Click Diagnostics > Request diagnostic file.

   

6. Click the ZIP file link to download the diagnostic report.

Managing software remotely

You can remotely manage the applications, microservices and extensions installed on Edge using the Cumulocity IoT software management feature. This process requires you to first upload an application, microservice or extension to the software repository before installing them. For more information on uploading items to the software repository, see To add a new software or software version. For more information about the software management feature in general, see Managing device software.

• Applications - You need a Cumulocity IoT application, see Web SDK for details. Upload the application zip to the software repository with the software type c8yedge_application
• Microservices - You need a microservice, see Microservice SDK for details. Upload the microservice zip to the software repository with the software type c8yedge_microservice
• Extensions - You need either a widget or plugin, see Micro frontends for details. Upload the extension zip to the software repository with the software type c8yedge_extension

Installing software

1. Navigate to your Edge device’s Software tab. The Software tab lists your installed applications, microservices and extensions. Click Install software. The Install software dialog lists the software from the software repository which matches Edge’s supported types of c8yedge_application, c8yedge_microservice and c8yedge_extension.
2. Select one or multiple software items.
3. Click Install.
4. Under Software changes on the right, review your planned changes and confirm the software update operation by clicking Apply changes.

The install operation will be created and executed on the device. The software installation is completed when the device has installed the software.

Updating software

To update software on your Edge device, hover over the software item which you want to update and click Update. Select a version from the list and click Update again. The software will be updated with the selected version.

The update operation will be created and executed on the device. The software update is completed when the device has updated the software.

Removing software

To remove software on your Edge device, hover over the software item which you want to remove and click the remove icon.

The remove operation will be created and executed on the device. The software removal is completed when the device has removed the software.