Documentation

Appearance

Dataplicity OS or your own Linux #

You can start from Dataplicity OS or keep the Linux image you already ship. Both are first-class Dataplicity deployments.

Starting pointChoose it whenNext step
Dataplicity OSYou want a ready-made Compute Module 5 image with the Dataplicity agent, RAUC A/B slots, persistent device state, and the supported update layout already integrated.Use Dataplicity OS on CM5
Your Linux imageYou already have Debian, Ubuntu, Raspberry Pi OS, Yocto, Buildroot, a board-vendor image, or another recognisable Linux system.Integrate your Linux image

Dataplicity OS is a usable reference implementation, not a requirement to adopt a Dataplicity-owned distribution. If your product needs a different BSP, kernel, bootloader, package set, or hardware target, keep those choices. Dataplicity will help qualify the agent and optional RAUC integration on the image you intend to ship.

What Dataplicity OS includes #

The first Dataplicity OS target is a Raspberry Pi Compute Module 5 with eMMC on the official CM5 IO board. The image includes:

  • the Dataplicity rescue and supervisor agents in every root filesystem slot;
  • RAUC A/B root filesystems with Raspberry Pi tryboot integration;
  • persistent identity, configuration, cache, and operator data under /var/lib/dataplicity;
  • casync for efficient OS-image and Class Software delivery;
  • an admin operator account, OpenSSH, and a deny-by-default firewall;
  • Dataplicity Lens and the Faceplate presentation packages.

The image is useful in two ways:

  1. Flash it and use it as the operating system for a CM5 product.
  2. Build or fork it as a worked Yocto integration for your own product image.

Choose your path #

  • Use Dataplicity OS on CM5 covers obtaining an image, flashing eMMC, first boot, SSH, provisioning the agent, and confirming the device in Dataplicity.
  • Build and customise Dataplicity OS covers the kas build, output artefacts, hardware customisation, and production changes.
  • Build and sign RAUC firmware explains the image signing CA, bundle certificate, device keyring, and Dataplicity Device Class keyring.
  • Integrate your Linux image gives the agent runtime, network, filesystem, service, and optional RAUC requirements for other distributions and custom Yocto builds.

If the board or image is unusual, email support@dataplicity.com with its distribution, release, architecture, service manager, and update design.