Manifest

Type: object

The automotive-image-builder format describes how to build an OS image, with options like what content (files, packages, containers) to install as well as detailed configuration options.

 No Additional Properties

root name
Type: string

The name of the manifest

root version
Type: string

The version of the manifest. If set, this is used as the "os version" in the ostree commit and will be available as IMAGE_VERSION in /etc/build-info.

root target
Type: string

The (default) hardware target to build for

root content
Type: object

The content to add to the rootfs, such as packages, files and container images, and systemd services.

 No Additional Properties

root content rpms
Type: array of string

A list of rpms to install. The packages will be installed from the default repositores, but can be extended with the enable_repos and repos options.

The package names can optionally contain version, but otherwise the repo priorities and available versions will be used to chose a version.

 No Additional Items

Each item of this array must be:

root content rpms rpms items
Type: string

root content enable_repos
Type: array of enum (of string)

Enable named predefined default repos which are not on by default.

 No Additional Items

Each item of this array must be:

root content enable_repos enable_repos items
Type: enum (of string)

Must be one of:

  • "debug"
  • "devel"

root content repos
Type: array

A list of additional dnf repositories to use when installing packages

 No Additional Items

Each item of this array must be:

root content repos repo
Type: object

A dnf repository to install rpms from

 No Additional Properties

root content repos repos items id
Type: string

The id to use for this repo in the configuration

root content repos repos items baseurl
Type: string

The url to the repo, or a pathname to a local repository

root content repos repos items priority
Type: integer

The priority of the repo, defaults to 99 if not specified. If there is more than one candidate package for a particular operation, the one from a repo with the lowest priority value is picked, possibly despite being less convenient otherwise (e.g. by being a lower version) (source: man dnf.conf)

root content container_images
Type: array

A list of container images to embedd into the image

 No Additional Items

Each item of this array must be:

root content container_images container_image
Type: object

A container image reference to install

 No Additional Properties

root content container_images container_images items source
Type: string

The container image name, for example quay.io/fedora/fedora.

root content container_images container_images items tag
Type: string Default: "latest"

The tag to use in the repository

root content container_images container_images items digest
Type: string

Use a specific version of the image specified by digest

root content container_images container_images items name
Type: string

The name to use for the container image when embedded (if not set, same as source)

root content container_images container_images items containers-transport
Type: enum (of string)

The containers transport from which to copy the container.

Must be one of:

  • "docker"
  • "containers-storage"

root content container_images container_images items index
Type: boolean

If set to true, also install the related manifest-list for the image.

root content add_files
Type: array

Add regular files (inline or from local file / url) to the image

 No Additional Items

Each item of this array must be:

root content add_files add_file
Type: object

root content add_files add_files items oneOf item 0
Type: object

Add local file

 No Additional Properties

root content add_files add_files items oneOf item 0 path
Type: string

The absolute destination pathname of the added file.

 Must match regular expression: ^\/?(?!\.\.)((?!\/\.\.\/).)+$

root content add_files add_files items oneOf item 0 source_path
Type: string

The local (absolute or relative to manifest) path of the file to add
root content add_files add_files items oneOf item 1
Type: object

Add file from a http url

 No Additional Properties

root content add_files add_files items oneOf item 1 path
Type: string

The absolute destination pathname of the added file.

Same definition as path

root content add_files add_files items oneOf item 1 url
Type: string

The url of the file to add
root content add_files add_files items oneOf item 2
Type: object

Create file from inline data

 No Additional Properties

root content add_files add_files items oneOf item 2 path
Type: string

The absolute destination pathname of the added file.

Same definition as path

root content add_files add_files items oneOf item 2 text
Type: string

Embedded text content to use for the added file
root content add_files add_files items oneOf item 3
Type: object

Add files using glob pattern

 No Additional Properties

root content add_files add_files items oneOf item 3 path
Type: string

The absolute destination pathname of the added file.

Same definition as path

root content add_files add_files items oneOf item 3 source_glob
Type: string

The glob pattern (absolute or relative to manifest) to match files for copying

root content add_files add_files items oneOf item 3 preserve_path
Type: boolean Default: false

If true, preserve the directory structure of matched files. If false, flatten files to path.

root content add_files add_files items oneOf item 3 max_files
Type: integer Default: 1000

Maximum number of files to process from glob pattern. Raises TooManyFilesError if exceeded.

Value must be greater or equal to 1

root content add_files add_files items oneOf item 3 allow_empty
Type: boolean Default: false

If true, allow glob patterns with no matches. Useful for creating drop-in directories.

root content chmod_files
Type: array
No Additional Items

Each item of this array must be:

root content chmod_files chmod_file
Type: object

Change file permissions

 No Additional Properties

root content chmod_files chmod_files items path
Type: string

The absolute pathname of the file to change

Same definition as path

root content chmod_files chmod_files items mode
Type: string

Symbolic or numeric octal mode

root content chmod_files chmod_files items recursive
Type: boolean

root content chown_files
Type: array
No Additional Items

Each item of this array must be:

root content chown_files chown_file
Type: object

Change owner and/or group of installed files

 No Additional Properties

root content chown_files chown_files items anyOf item 0
Type: object

The following properties are required:

  • path
  • user
root content chown_files chown_files items anyOf item 1
Type: object

The following properties are required:

  • path
  • group

root content chown_files chown_files items path
Type: string

The absolute pathname of the file to change

Same definition as path

root content chown_files chown_files items user
Type: object

User name or id

root content chown_files chown_files items user oneOf item 0
Type: string
Must match regular expression: ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$
root content chown_files chown_files items user oneOf item 1
Type: number

Value must be greater or equal to 0

root content chown_files chown_files items group
Type: object

Group name or id

root content chown_files chown_files items group oneOf item 0
Type: string
Must match regular expression: ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$
root content chown_files chown_files items group oneOf item 1
Type: number

Value must be greater or equal to 0

root content chown_files chown_files items recursive
Type: boolean Default: false

Change ownership recursively

root content remove_files
Type: array
No Additional Items

Each item of this array must be:

root content remove_files remove_file
Type: object

Remove an installed file

 No Additional Properties

root content remove_files remove_files items path
Type: string

The absolute pathname of the file to remove

Same definition as path

root content make_dirs
Type: array
No Additional Items

Each item of this array must be:

root content make_dirs make_dir
Type: object

Create a directory

 No Additional Properties

root content make_dirs make_dirs items path
Type: string

The absolute pathname of the directory to create

Same definition as path

root content make_dirs make_dirs items mode
Type: number

root content make_dirs make_dirs items parents
Type: boolean

If true, parent directories are created if needed

root content make_dirs make_dirs items exist_ok
Type: boolean

If true, don't fail if directory exists

root content systemd
Type: object

Configure what systemd services are to be running other than the default ones.

 No Additional Properties

root content systemd enabled_services
Type: array of string

List of systemd services to enable

 No Additional Items

Each item of this array must be:

root content systemd enabled_services enabled_services items
Type: string

root content systemd disabled_services
Type: array of string

List of systemd services to disable

 No Additional Items

Each item of this array must be:

root content systemd disabled_services disabled_services items
Type: string

root content sbom
Type: object

Generate a Software Bill of Materials (SBOM) document in SPDX v2 format for the installed RPM packages.

 No Additional Properties

root content sbom doc_path
Type: string

Output path for the SBOM file

root qm
Type: object

If this section is included then a separate QM partion will be created in the image with the defined content.

 No Additional Properties

root qm content
Type: object

The content to add to the qm partition

Same definition as content

root qm memory_limit
Type: object
No Additional Properties

root qm memory_limit max
Type: string

MemoryMax for QM partition (see systemd.resource-control manpage)

root qm memory_limit high
Type: string

MemoryHigh for QM partition (see systemd.resource-control manpage)

root qm cpu_weight

CPUWeight for the QM partition (see systemd.resource-control manpage)

root qm cpu_weight oneOf item 0
Type: enum (of string)

Must be one of:

  • "idle"
root qm cpu_weight oneOf item 1
Type: integer

Value must be greater or equal to 1 and lesser or equal to 100

root qm container_checksum
Type: string

Optional container digest that is validated at boot

root network
Type: object Default: {"dynamic": {}}

Define the Network setup, which can be of two types, dynamic or static, the default is dynamic

 No Additional Properties

root network static
Type: object

Section to configure the network with static IP addresses (i.e. no DHCP) and fixed configuration options.

 No Additional Properties

root network static ip
Type: string

The fixed ip address assigned to the node.

root network static ip_prefixlen
Type: number

Prefix length is the number of bits that define the network portion of an IP address, specified in CIDR notation. For example 24 for a 255.255.255.0 netmask.

root network static gateway
Type: string

the default route taken by non-local packets when the host does not know where the destination is.

root network static dns
Type: string

DNS is the IP address of the name server to be used (eg. example.com to 192.0.2.1).

root network static iface
Type: string

The hardware network interface name to setup for the static ip at boot (for example eth0). Normally this doesn't need to be specified, as the default network interface for the target board will be used. However, in case you are using a non-standard network driver or card this can be used to override that.

root network static load_module
Type: string

Optional name of a kernel module to load at boot for the network support. Normally this feature may not be needed because the target board will load the default network drivers, but if a non-standard network driver is used, it can be specified using this option.

root network dynamic
Type: object

Use network manager for dynamic network setup, currently has no options

root image
Type: object

Configure global options for the image.

 No Additional Properties

root image image_size
Type: string

The size of the total image, allows suffixes like "GB" (powers of 1000) or "GiB" (powers of 1024)

Must match regular expression: ^[0-9]+ *(kB|KiB|MB|MiB|GB|GiB|TB|TiB)$

root image sealed
Type: boolean

Sealed images can only boot the original, or re-sealed images, not e.g. layered bootc images. Defaults to true.

root image selinux_mode
Type: enum (of string) Default: "enforcing"

The selinux mode (enforcing or permissive)

Must be one of:

  • "enforcing"
  • "permissive"

root image selinux_policy
Type: string

The name of the selinux policy to use

root image selinux_booleans
Type: object

Set individual selinux policy boolean options

Each additional property must conform to the following schema

root image selinux_booleans additionalProperties
Type: boolean

root image partitions
Type: object

Disk partition details, like sizes.

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: root
root image partitions root
Type: object
No Additional Properties

root image partitions root grow
Type: boolean

Support for growing root filesystem to match physical image size.

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: (aboot|ukiboot|boot|efi|vbmeta|sbl)
root image partitions (aboot|ukiboot|boot|efi|vbmeta|sbl)
Type: object
No Additional Properties

root image partitions (aboot|ukiboot|boot|efi|vbmeta|sbl) size
Type: string

size of partition (if used)

Must match regular expression: ^[0-9]+ *(kB|KiB|MB|MiB|GB|GiB|TB|TiB)$

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: var
root image partitions var
Type: object

Use separate partition for /var

 No Additional Properties

root image partitions var relative_size
Type: number Default: 0.3

Size of /var partition(s) relative to total image size, 0 to disable

Note: This size includes the /var/qm if that is used, see qmrelativesize options.

Value must be greater or equal to 0 and lesser or equal to 1.0

root image partitions var size
Type: string

Size of /var partition in bytes (with suffix), 0 to disable

Must match regular expression: ^[0-9]+ *(kB|KiB|MB|MiB|GB|GiB|TB|TiB)$

root image partitions var external
Type: boolean

The /var partition is on an external device (not an image parition)

root image partitions var uuid
Type: object

The uuid of the partition

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

"9c6ae55b-cf88-45b8-84e8-64990759f39d"

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: var_qm
root image partitions var_qm
Type: object

Use separate partition for /var/qm

 No Additional Properties

root image partitions var_qm relative_size
Type: number Default: 0

Size of /var/qm partition relative to total image size. 0 to disable.

Note: This is only included if qm is enabled.

Value must be greater or equal to 0 and lesser or equal to 1.0

root image partitions var_qm size
Type: string

Size of /var/qm partition in bytes (with suffix), 0 to disable.

Note: This is only included if qm is enabled.

Must match regular expression: ^[0-9]+ *(kB|KiB|MB|MiB|GB|GiB|TB|TiB)$

root image partitions var_qm external
Type: boolean

The /var/qm partition is on an external device (not an image parition)

root image partitions var_qm uuid
Type: object

The uuid of the partition

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

"9c6ae55b-cf88-45b8-84e8-64990759f39d"

root image hostname
Type: string

The network hostname

root image ostree_ref
Type: string

The name of the ostree ref (defaults to $distro_name/$arch/$target-$naem)

root auth
Type: object

Configuration related to users, group and authentications.

 No Additional Properties

root auth root_password
Type: string or null

Roots's encrypted password, as returned by crypt(3), or empty for no password. Use null to disallow login, which is the default.

root auth root_ssh_keys
Type: array or null

Roots's ssh keys, or nothing to disable

 No Additional Items

root auth sshd_config
Type: object

Configuration of ssh daemon

 No Additional Properties

root auth sshd_config PasswordAuthentication
Type: boolean

Enable or disable password authentication

root auth sshd_config PermitRootLogin

Specifies whether root can log in using ssh.

root auth sshd_config PermitRootLogin oneOf item 0
Type: enum (of string)

Must be one of:

  • "prohibit-password"
  • "forced-commands-only"
root auth sshd_config PermitRootLogin oneOf item 1
Type: boolean

root auth users
Type: object

Keys are usernames, values are objects giving user info.

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$
root auth users add_user
Type: object
No Additional Properties

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ groups
Type: array of string

Array of group names for this user

 No Additional Items

Each item of this array must be:

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ groups groups items
Type: string

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ description
Type: string

User account description (or full name)

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ home
Type: string

Path to user's home directory

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ shell
Type: string

User's login shell

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ password
Type: string

User's encrypted password, as returned by crypt(3)

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ key
Type: string

SSH Public Key to add to ~/.ssh/authorized_keys

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ keys
Type: array of string

Array of SSH Public Keys to add to ~/.ssh/authorized_keys

 No Additional Items

Each item of this array must be:

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ keys keys items
Type: string

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ expiredate
Type: integer

The date on which the user account will be disabled. This date is represented as a number of days since January 1st, 1970.

root auth users ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ force_password_reset
Type: boolean

Force this user to change their password on first login

root auth groups
Type: object

Keys are group, values are objects giving group info.

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$
root auth groups add_group
Type: object
No Additional Properties

root auth groups ^[A-Za-z0-9_.][A-Za-z0-9_.-]{0,31}$ gid
Type: number

GID for this group

root kernel
Type: object

Kernel options

 No Additional Properties

root kernel debug_logging
Type: boolean

Add more debug logging

root kernel cmdline
Type: array

Extra kernel commandline options

 No Additional Items

root kernel kernel_package
Type: string

Use a custom kernel package name (instead of kernel-automotive)

root kernel kernel_version
Type: string

Use a custom kernel package version

root kernel loglevel
Type: integer

Use a kernel log level

root kernel remove_modules
Type: array

Remove kernel modules (and dependendices) from image

 No Additional Items

root experimental
Type: object

Experimental options. Unsupported, may change over time without warning.

 No Additional Properties

root experimental internal_defines
Type: object

Internal OSBuild MPP defines

Additional Properties of any type are allowed.

root experimental internal_defines additionalProperties
Type: object