Raspberry Pi Image Description Provisioning Map


The Provisioning Map (PMAP) defines how a Raspberry Pi image is provisioned on-device. It is an ordered sequence of entries describing partition assignments, slot mappings for A/B layouts, and optional LUKS2 encryption configuration. The PMAP is authored per-image and embedded in the IDP document by rpi-image-gen, or supplied manually for images built outside rpi-image-gen.

root oneOf item 0
Type: array

A standalone PMAP document as a bare array of entries.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 0 entry
Type: object

A single PMAP entry.

root oneOf item 0 item 0 items oneOf attributesEntry
Type: object

A PMAP entry that declares top-level attributes for the provisioning map, including format version and system type.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 0 attributes
Type: object

The attributes object containing PMAP version and system type.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 0 attributes PMAPversion
Type: string

The PMAP format version in semver format. Used by provisioning tools to determine how to parse this PMAP.

Must match regular expression: ^[0-9]+\.[0-9]+\.[0-9]+$

root oneOf item 0 item 0 items oneOf item 0 attributes system_type
Type: enum (of string)

The partition layout type. 'flat' for a simple single-slot layout, 'slotted' for an A/B layout.

Must be one of:

  • "flat"
  • "slotted"
root oneOf item 0 item 0 items oneOf partitionsEntry
Type: object

A PMAP entry that defines a flat list of partition references.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 1 partitions
Type: array

The list of partition references for this entry.

 No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items oneOf item 1 partitions partitionRef
Type: object

A reference to a partition image by name, with optional attributes.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items image
Type: string

The name of the partition image as defined in the IDP partitionimages map.

Must be at least 1 characters long

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items comment
Type: string

An optional human-readable comment describing this partition reference.

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items static
Type: object

Optional static attributes to fix partition properties such as UUID or role at provisioning time.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items static id
Type: string

A partition identifier string. Not currently used.

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items static uuid

A UUID for this partition. For standard partitions, corresponds to the UUID of the matching partition image. For on-device created partitions such as LUKS containers, this UUID is used at partition creation allowing the partition to be identified with this UUID on device.

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items static uuid anyOf item 0
Type: object
Must match regular expression: ^[0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$
root oneOf item 0 item 0 items oneOf item 1 partitions partitions items static uuid anyOf item 1
Type: object
Must match regular expression: ^[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}$

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items static role
Type: enum (of string)

The role of this partition on the device, used by the provisioning tool to apply role-specific handling.

Must be one of:

  • "boot"
  • "system"

root oneOf item 0 item 0 items oneOf item 1 partitions partitions items expand-to-fit
Type: boolean Default: false

If true, the partition is expanded to fill the remaining available space on the device.
root oneOf item 0 item 0 items oneOf slotsEntry
Type: object

A PMAP entry that defines a map for a slotted partition layout.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 2 slots
Type: object

The slot map for this entry.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 2 slots A
Type: object

The A slot, containing a list of partitions and optional encryption configuration.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 2 slots A partitions
Type: array

The list of partition references assigned to this slot.

 No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items oneOf item 2 slots A partitions partitionRef
Type: object

A reference to a partition image by name, with optional attributes.

Same definition as oneOf_i0_items_oneOf_i1_partitions_items

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted
Type: object

Optional encryption configuration for this slot.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2
Type: object

The LUKS2 configuration for this encrypted container.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2 key_size
Type: enum (of integer)

The encryption key size in bits.

Must be one of:

  • 128
  • 256
  • 512

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2 cipher
Type: string

The cipher and mode used for encryption, e.g. aes-xts-plain64.

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2 hash
Type: string

The hash algorithm used for metadata integrity, e.g. sha256.

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2 label
Type: string

An optional human-readable label for the LUKS2 container.

Must be at most 36 characters long

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2 uuid
Type: string

The UUID assigned to the LUKS2 container. Required so that the container can be identified and unlocked at runtime.

Must match regular expression: ^[0-9A-Fa-f]{8}(-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2 mname
Type: string

The device mapper name for the LUKS2 container, used as the mapped device name under /dev/mapper.

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted luks2 etype
Type: enum (of string)

The encrypted container type. 'raw' for a directly encrypted block device, 'partitioned' for a LUKS2 container that itself holds a partition table.

Must be one of:

  • "raw"
  • "partitioned"

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted partitions
Type: array

A flat list of partition references within this encrypted container.

 No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted partitions partitionRef
Type: object

A reference to a partition image by name, with optional attributes.

Same definition as oneOf_i0_items_oneOf_i1_partitions_items

root oneOf item 0 item 0 items oneOf item 2 slots A encrypted expand-to-fit
Type: boolean Default: false

If true, the encrypted container is expanded to fill the remaining available space on the device.

root oneOf item 0 item 0 items oneOf item 2 slots B
Type: object

The B slot, containing a list of partitions and optional encryption configuration.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 2 slots B partitions
Type: array

The list of partition references assigned to this slot.

 No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items oneOf item 2 slots B partitions partitionRef
Type: object

A reference to a partition image by name, with optional attributes.

Same definition as oneOf_i0_items_oneOf_i1_partitions_items

root oneOf item 0 item 0 items oneOf item 2 slots B encrypted
Type: object

Optional encryption configuration for this slot.

Same definition as encrypted
root oneOf item 0 item 0 items oneOf encryptedEntry
Type: object

A PMAP entry that defines an encrypted container.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 3 encrypted
Type: object

The encrypted container configuration for this entry.

 No Additional Properties

root oneOf item 0 item 0 items oneOf item 3 encrypted anyOf item 0
Type: object

The following properties are required:

  • slots
root oneOf item 0 item 0 items oneOf item 3 encrypted anyOf item 1
Type: object

The following properties are required:

  • partitions

root oneOf item 0 item 0 items oneOf item 3 encrypted luks2
Type: object

The LUKS2 configuration for this encrypted container.

Same definition as luks2

root oneOf item 0 item 0 items oneOf item 3 encrypted slots
Type: object

A slot map defining named A/B partition sets within this encrypted container.

Same definition as slots

root oneOf item 0 item 0 items oneOf item 3 encrypted partitions
Type: array

A flat list of partition references within this encrypted container.

 No Additional Items

Each item of this array must be:

root oneOf item 0 item 0 items oneOf item 3 encrypted partitions partitionRef
Type: object

A reference to a partition image by name, with optional attributes.

Same definition as oneOf_i0_items_oneOf_i1_partitions_items

root oneOf item 0 item 0 items oneOf item 3 encrypted expand-to-fit
Type: boolean Default: false

If true, the encrypted container is expanded to fill the remaining available space on the device.
root oneOf item 1
Type: object

A PMAP document embedded within an IDP layout object.

root oneOf item 1 layout
Type: object

The IDP layout container.

root oneOf item 1 layout provisionmap
Type: array

The provisioning map array embedded in the IDP layout.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root oneOf item 1 layout provisionmap entry
Type: object

A single PMAP entry.

Same definition as oneOf_i0_items

Additional Properties of any type are allowed.

root oneOf item 1 layout additionalProperties
Type: object

Additional Properties of any type are allowed.

root oneOf item 1 additionalProperties
Type: object