The Image Description Provisioning (IDP) document describes a Raspberry Pi image for secure on-device provisioning. It combines image layout information (partition table, partition images, sizes, filesystem types and attributes) with a Provisioning Map (PMAP) that defines how the image is deployed — including partition creation, LUKS encryption, and security attributes. IDP documents are consumed by Raspberry Pi provisioning tools such as rpi-sb-provisioner.
No Additional PropertiesThe IDP document format version in semver format (MAJOR.MINOR.PATCH). Provisioning tools use this field to select the correct parsing and provisioning path, enabling backward compatibility across document format revisions.
Must match regular expression:^[0-9]+\.[0-9]+\.[0-9]+$
Build configuration metadata derived from the rpi-image-gen environment. For images built outside rpi-image-gen these fields must be populated manually.
No Additional PropertiesThe Raspberry Pi device family the image is intended for.
An optional device variant identifier, e.g. memory size or edition (8G, lite). Use 'none' if no variant applies.
The storage media type the image is intended for, as seen by the OS. Determines which block device the provisioning tool will target.
The logical sector size in bytes of the target storage device. Used to guide image layout decisions such as alignment and padding.
The version string of the image, typically matching the artefact version set at build time.
The output directory path where the image and associated artefacts were written by the build.
Image-level attributes describing the overall image geometry and identity.
No Additional PropertiesThe base name of the image, used to identify the image artefact.
Must be at least 1 characters long
The physical size of the raw disk image in bytes.
Value must be greater or equal to 0
The partition alignment of the image in bytes. Accepts integer values or genimage-style size suffixes (e.g. 8M).
The image layout, comprising the partition table, partition images, and provisioning map.
No Additional PropertiesThe partition table descriptor, including type and disk identifier.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"gpt"
A standard UUID string (case-insensitive), e.g. F5C56D0D-B6D9-4353-9F7C-9E8FBF89D864.
Must match regular expression:^[0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$
^0x[0-9A-Fa-f]{8}$
The partition table type. 'gpt' for GUID Partition Table, 'dos' for MBR.
The disk identifier. A UUID for GPT disks, or a 4-byte hex value (e.g. 0x1234abcd) for MBR disks.
Additional Properties of any type are allowed.
Type: objectA map of partition entries keyed by partition name, each describing a partition's geometry, filesystem type, and attributes.
Each additional property must conform to the following schema
Type: objectDescribes a single partition image, including its geometry, filesystem type, and attributes.
An arbitrary string identifying this partition. Used as the key in the partitionimages map and referenced by name in the PMAP.
Must be at least 1 characters long
Whether this partition image has a corresponding entry in the partition table. Represented as a string boolean.
The physical size of the partition image in bytes. Must be at least one sector (512 bytes).
Value must be greater or equal to 512
The filename of the raw partition image file.
Must be at least 1 characters long
The filesystem or image type of this partition, e.g. ext4.
Must be at least 1 characters long
Whether the partition is flagged as bootable. Represented as a string boolean.
The mountpoint of this partition on the running device, e.g. /boot or /.
The GPT partition type UUID, identifying the type of partition (e.g. Linux filesystem, EFI System).
Same definition as idThe GPT partition label, a human-readable name for the partition entry in the partition table.
The GPT partition UUID, uniquely identifying this partition entry in the partition table.
Same definition as idThe filesystem label assigned to this partition.
The filesystem UUID. A standard UUID for most filesystem types, or a 4-byte hex vfat volume ID.
A standard UUID string (case-insensitive), e.g. F5C56D0D-B6D9-4353-9F7C-9E8FBF89D864.
Same definition as idA vfat volume ID in 4-byte hexadecimal format, e.g. 1234-ABCD.
Must match regular expression:^[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}$
The filename of the sparse image file containing this partition's data, e.g. boot.sparse. Required for fastboot provisioning flows.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectThe embedded Provisioning Map (PMAP), defining how partitions are assigned, ordered, and optionally encrypted on the target device. See the PMAP schema for full details.
No Additional Items