About this guide

Important: Cumulocity IoT Edge software and documentation both are currently in beta status.

The current release contains all functionality (Connectivity, Device Management, Cockpit) of the final release. However, additional quality and stability improvements are currently ongoing. Also changes in installation and operations are expected for the final release.

The purpose of the release is to get feedback from early adapters and partners. Therefore:

  • Do NOT use this release in production.
  • The documented upgrade procedure (see Operating Cumulocity IoT Edge) is only guaranteed to work with the final release, not with the beta release.

Documentation

The following documentation is available for Cumulocity IoT Edge:

SECTION CONTENT
Introduction Providing information on conceptual aspects of Cumulocity IoT Edge.
Setting up Cumulocity IoT Edge How to install the system on a virtual machine, including setting up the environment for Cumulocity IoT Edge and configuring the Edge server.
Working with Cumulocity IoT Edge How to use the IoT platform, how to connect a modbus device using Cloud Fieldbus and how to connect Edge to the cloud using Data Broker.
Operating Cumulocity IoT Edge How to operate the system, including operational procedures, health checks, backup and restore, and log files.

Conventions in this document

The following conventions are used in this document:

Lines starting with ´#´ are meant as commands to be executed by the root user. Example:

# ls -l

Lines starting with ´$´ represent commands to be executed by a non-root user. Example:

$ ls /etc

Items marked in brackets <x> need to be replaced by a custom value when executing commands or editing files. Example:

user=<username>;

should be edited like

user=johndoe