Dataplicity OS or your own Linux #

Most products keep the Linux image they already build. Dataplicity OS is a ready-made Compute Module 5 quickstart and a worked Yocto reference for people who want something flashable today. It is not the required or preferred operating system for Dataplicity.

Starting point	Choose it when	Next step
Your Linux image	You already have Debian, Ubuntu, Raspberry Pi OS, Yocto, Buildroot, a board-vendor image, or another recognisable Linux system. This is the normal product path.	Integrate your Linux image
Dataplicity OS	You want a CM5 eMMC quickstart with the agent, RAUC A/B layout, persistent state, and Class Software runtime already wired, or you want a concrete reference while designing your own image.	Choose a Dataplicity OS image

Dataplicity manages devices through the agent contract, not through ownership of the OS. Bring your own BSP, kernel, bootloader, package set, and update design when that is what the product needs. Use Dataplicity OS when the reference CM5 image already solves enough of the problem to get started.

What Dataplicity OS is for #

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 on the dpdata partition;
casync for efficient OS-image and Class Software delivery;
a production access posture: locked admin console, disabled OpenSSH service, and deny-by-default UFW;
containerd and nerdctl for optional Class Software, with runtime state on dpdata;
Dataplicity Lens and the Faceplate presentation packages;
explicit CSI camera boot overlays, because Compute Modules do not auto-detect cameras.

Use it in either of these ways:

Flash it as a CM5 quickstart when the board and layout match.
Read or fork it as a worked example while integrating Dataplicity into the Linux image you intend to ship.

Do not treat the official catalog as a general board-support matrix. A different board, BSP, or security policy belongs on your own image path.

The current Dataplicity OS .raucb updates only the inactive root filesystem. It does not update the boot, kernel, or firmware partitions.

Build channels and access posture #

Official signed releases are either production-profile or an explicit staging debug profile. Lab builds from the public kas config are a third, developer-only posture.

Build	Intended use	Local console / SSH	Build channel marker
Lab / local `kas.yml`	Reproduce or customise the reference tree	Lab conveniences such as `debug-tweaks` may be present	Not a customer release
Staging or prod release	Factory flash and OTA	Locked `admin`, `sshd` disabled, UFW denies inbound	`production`
Staging debug profile	Controlled diagnostics only	Password login, SSH, port 22 allow, extra tools	`debug`

Production customer units use the production-profile image. The staging debug profile is blocked from production releases. See Local console and remote access and Build and customise Dataplicity OS.

Choose your path #

Integrate your Linux image is the accepted contract for bring-your-own OS: persistent state, RAM-backed volatile paths, optional containers, and optional RAUC.
Choose a Dataplicity OS image explains the official platform catalog, factory flash, and OTA boundary.
Use Dataplicity OS on CM5 covers flashing eMMC, first boot, provisioning, and confirming the device in Dataplicity.
Local console and remote access explains the production lock, temporary console unlock, Remote Shell, and staging debug profile.
Dataplicity OS software runtime explains containerd, nerdctl, persistent state, and Class Software.
Build and customise Dataplicity OS covers the kas build, CSI boot overlays, staging versus production image flags, and product forks.
Build and sign RAUC firmware explains signing trust for Dataplicity OS or a custom RAUC image.

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