A friendly display name. Used in the boot menu
for isolinux and grub

An identification number which is represented in a file
named /etc/ImageID

An image name without / and spaces

The allowed Schema version (fixed value)

The location of the XSD Schema (not relevant for RELAX NG or DTD)

A pair of URI references: First is a namespace name,
second the location of the XSD Schema
(not relevant for RELAX NG or DTD)

Kiwi distinguishes between two basic image description types
which uses the same format but one is created and provided by
the kiwi developers and the other is created by the users of
kiwi. The type=boot specifies a boot image (initrd) which should
be provided by the kiwi developers wheras type=system specifies
a standard image description created by a kiwi user.

A profile name which binds the section to this name

Specifies the path of the boot image (initrd) description
provided with KIWI

if an extra boot partition is required this attribute
specify which filesystem should be used for it. The
type of the bootloader might overwrite this setting
e.g for the syslinux loader fat is required

Specifies the kernel boot profile defined in the boot
image description. When kiwi builds the boot image the
information is passed as add-profile option

Specifies the bootloader used for booting the image.
At the moment grub2, zipl and the combination of zipl plus
userspace grub2 are supported. The special custom entry
allows to skip the bootloader configuration and installation
and leaves this up to the user which can be done by using
the editbootinstall and editbootconfig custom scripts

Specifies the bootloader console.
The value only has an effect for the grub bootloader.
By default a graphics console setup is used

specify if an extra boot partition should be used or not.
This will overwrite kiwi's default layout

For images with a separate boot partition this attribute
specifies the size in MB. If not set the min bootpart
size is set to 200 MB

Specifies the boot profile defined in the boot image
description. When kiwi builds the boot image the
information is passed as add-profile option

Specifies the boot timeout in seconds prior to launching
the default boot option. the unit for the timeout value
is seconds if GRUB is used as the boot loader and 1/10
seconds if syslinux is used

Tell kiwi to set the btrfs root filesystem snapshot read-only
Once all data has been placed to the root filesystem snapshot
it will be turned into read-only mode if this option is set to
true. The option is only effective if btrfs_root_is_snapshot
is also set to true. By default the root filesystem snapshot
is writable

Tell kiwi to install the system into a btrfs snapshot
The snapshot layout is compatible with the snapper management
toolkit. By default no snapshots are used

Specifies whether the image output file should be
compressed or not. This makes only sense for filesystem
only images respectively for the pxe or cpio type

Specifies the image URI of the container image. The image created
by KIWI will use the specified container as the base root
to work on.

Specifies which method to use in order to get persistent
storage device names. By default by-uuid is used.

Specifies the path to a script which is called right
before the bootloader is installed. The script runs
relative to the directory which contains the image
structure

Specifies the path to a script which is called right
after the bootloader is installed. The script runs
relative to the directory which contains the image
structure

For images with an EFI fat partition this attribute
specifies the size in MB. If not set the min efipart
size is set to 20 MB

Specifies the root filesystem type

Specifies the boot firmware of the system. Most systems
uses a standard BIOS but there are also other firmware
systems like efi, coreboot, etc.. This attribute is
used to differentiate the image according to the firmware
which boots up the system. It mostly has an impact on
the disk layout and the partition table type. By default
the standard x86 bios firmware setup is used

Specifies overlay filesystem flags for the iso image type
as they are supported by the kiwi-live dracut module.
`overlay` uses squashfs and the kernel overlayfs filesystem

Force use of MBR (msdos table) partition table even if the
use of the GPT would be the natural choice. On e.g some
arm systems an EFI partition layout is required but must
not be stored in a GPT. For those rare cases this attribute
allows to force the use of the msdos table including all
its restrictions in max partition size and amount of
partitions

Specifies the format of the virtual disk.

Specifies additional format options passed on to qemu-img
formatoptions is a comma separated list of format specific
options in a name=value format like qemu-img expects it.
kiwi will take the information and pass it as parameter to
the -o option in the qemu-img call

Specifies the filesystem mount options which also ends up in fstab
The string given here is passed as value to the -o option of mount

Specifies the license tag in a GCE format

for gpt disk types only:
create a hybrid GPT/MBR partition table

Specifies that the ISO file will be turned into a hybrid image.
hybrid means the ISO image can be used as CD/DVD image and as a
disk image if the iso is e.g dumped on a USB stick. In both cases
the result is a bootable system.

Will trigger the creation of a partition for a COW file
to keep data persistent over a reboot

Set the filesystem to use for persistent writing if a
hybrid image is used as disk on e.g a USB Stick. By default
the ext4 filesystem is used

Specifies the image type

specify which initrd builder to use, default is kiwi's
builtin architecture. Be aware that the dracut initrd
system does not support all features of the kiwi initrd

Specifies the bootloader default boot entry for the"
initial boot of a kiwi install image. This value is"
only evaluated for grub and ext|syslinux"

Specifies if a install iso should be created (oem only)

Specifies if the bootloader menu should provide an"
failsafe entry with special kernel parameters or not"

Specifies if all data for a pxe network installation should
be created (oem only)

Specifies if a install stick should be created (oem only)

The kernelcmdline element specifies additional
kernel command line options

Setup cryptographic volume along with the given filesystem
using the LUKS extension. The value of this attribute
represents the password string used to be able to
mount that filesystem while booting

With the luksOS value a predefined set of ciper, keysize
and hash format options is passed to the cryptsetup call
in order to create a format compatible to the specified
distribution

Setup software raid in degraded mode with one disk
Thus only mirroring and striping is possible

Specifies if the bootloader menu should provide an"
mediacheck entry to verify ISO integrity or not.
Disabled by default and only available for x86 arch family."

Specifies to use an overlay root system consisting
out of a squashfs compressed read-only root system
overlayed using the overlayfs filesystem into an
extra read-write partition. Available for the disk
image types, vmx and oem

Specifies the primary type (choose KIWI option type)

for use with overlay filesystems only:
will force any COW action to happen in RAM

label to set for the root filesystem. By default ROOT is used

Request a spare partition right before the root partition
of the requested size. The attribute takes a size value
and allows a unit in MB or GB, e.g 200M. If no unit is given
the value is considered to be mbytes. A spare partition
can only be configured for the disk image types oem and vmx

Specifies the image blocksize in bytes which has to match
the logical (SSZ) blocksize of the target storage device.
By default 512 byte is used which works on many disks
However 4096 byte disks are coming. You can check the
desired target by calling: blockdev --report device

Indicate if the target disk for oem images is deployed
to a removable device e.g a USB stick or not. This only
affects the EFI setup if requested and in the end avoids
the creation of a custom boot menu entry in the firmware
of the target machine. By default the target disk is
expected to be non-removable

Specifies the kernel framebuffer mode. More information
about the possible values can be found by calling
hwinfo --framebuffer or in /usr/src/linux/Documentation/fb/vesafb.txt

Specifies the GUID in a fixed format VHD

for the iso type only:
Specifies the volume ID (volume name or label) to be written
into the master block. There is space for 32 characters.

Specifies the wait period in seconds after launching
the multipath daemon to wait until all presented devices
are available on the host. Default timeout is 3 seconds

Specify the image is a Xen dom0 (Xen Server) image
The information is used to create a correct bootloader
configuration with regards to the required loading of
the Xen Hypervisor

The device type of the disk zipl should boot. On zFCP
devices use SCSI, on DASD devices use CDL or LDL on
emulated DASD devices use FBA

Specifies a maintainer for the container.

Specifies a name for the container. This is usually the
the repository name of the container as read if the container
image is imported via the docker load command

Specifies a tag for the container. This is usually the
the tag name of the container as read if the container
image is imported via the docker load command

Specifies a user for the container.

Specifies the default working directory of the container

Specifies to clear or not some data or configurations

Specifies the entry point program name to execute

Specifies a command argument name

Specifies to clear or not some data or configurations

Specifies the subcommand program name to execute

Specifies the port number to expose

Apply the filesystem copy-on-write attribute for this volume

free space to be added to this volume. The value is
used as MB by default but you can add "M" and/or "G" as
postfix

volume path. The mountpoint specifies a path which has to
exist inside the root directory.

volume name. The name of the volume. if mountpoint is
not specified the name specifies a path which has to
exist inside the root directory.

absolute size of the volume. If the size value
is too small to store all data kiwi will exit.
The value is used as MB by default but you can
add "M" and/or "G" as postfix

Specifies the environment variable name

Specifies the environment variable value

Specifies the label name

Specifies the label value