Schema Documentation 6.5

Hint

Element quantifiers

  • Optional elements are qualified with [?]
  • Elements that occur one or more times are qualified with [+]
  • Elements that occur zero or more times are qualified with [*]
  • Required elements are not qualified

image

The root element of the configuration file

Children:
The following elements occur in image: description , preferences [+], profiles [?], users [*], drivers [*], strip [*], repository [*], packages [*], extension [?]

List of attributes for image:

  • name : An image name without / and spaces
  • displayname [?]: A friendly display name. Used in the boot menu for isolinux and grub
  • kiwirevision [?]: A kiwi git revision number which is known to build a working image from this description. If the kiwi git revision doesn’t match the installed kiwi revision the process will exit.
  • id [?]: An identification number which is represented in a file named /etc/ImageID
  • schemaversion : The allowed Schema version (fixed value)
  • xsi:noNamespaceSchemaLocation [?]: The location of the XSD Schema (not relevant for RELAX NG or DTD)
  • xsi:schemaLocation [?]: A pair of URI references: First is a namespace name, second the location of the XSD Schema (not relevant for RELAX NG or DTD)

description

A Short Description

Parents:
These elements contain description: image
Children:
The following elements occur in description: author , contact [+], specification

List of attributes for description:

  • type : 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.

author

Author of the image

Parents:
These elements contain author: description

contact

Contact Information from the Author, like Email etc.

Parents:
These elements contain contact: description

specification

A Detailed Description

Parents:
These elements contain specification: description

preferences

Configuration Information Needed for Logical Extend All elements are optional since the combination of appropriate preference sections based on profiles combine to create on vaild definition

Parents:
These elements contain preferences: image
Children:
The following elements occur in preferences: bootsplash-theme [?], bootloader-theme [?], defaultdestination [?], defaultprebuilt [?], defaultroot [?], hwclock [?], keytable [?], locale [?], packagemanager [?], partitioner [?], rpm-check-signatures [?], rpm-excludedocs [?], rpm-force [?], showlicense [*], timezone [?], type [*], version [?]

List of attributes for preferences:

  • profiles [?]: A profile name which binds the section to this name

bootsplash-theme

Image bootsplash theme setup.

Parents:
These elements contain bootsplash-theme: preferences

bootloader-theme

Image bootloader theme setup.

Parents:
These elements contain bootloader-theme: preferences

defaultdestination

Default Path if destdir Otion is Not Specified

Parents:
These elements contain defaultdestination: preferences

defaultprebuilt

Default directory name for pre-built boot images, used if the directory is not specified on the command line

Parents:
These elements contain defaultprebuilt: preferences

defaultroot

Default Root Directory Name if root Option is Not Specified

Parents:
These elements contain defaultroot: preferences

hwclock

Setup Image harware clock setup, either utc or localtime

Parents:
These elements contain hwclock: preferences

keytable

Image keytable setup.

Parents:
These elements contain keytable: preferences

locale

Image locale setup.

Parents:
These elements contain locale: preferences

packagemanager

Name of the Package Manager

Parents:
These elements contain packagemanager: preferences

partitioner

Name of the Partitioner used for any disk partition tasks

Parents:
These elements contain partitioner: preferences

rpm-check-signatures

Setup a Package Signature

Parents:
These elements contain rpm-check-signatures: preferences

rpm-excludedocs

Do not install files marked as documentation in the package

Parents:
These elements contain rpm-excludedocs: preferences

rpm-force

Force the Installation of a Package

Parents:
These elements contain rpm-force: preferences

showlicense

Setup showlicense

Parents:
These elements contain showlicense: preferences

timezone

Setup Image Timezone setup

Parents:
These elements contain timezone: preferences

type

The Image Type of the Logical Extend

Parents:
These elements contain type: preferences
Children:
The following elements occur in type: containerconfig [?], machine [?], oemconfig [?], pxedeploy [?], size [?], systemdisk [?], vagrantconfig [*]

List of attributes for type:

  • boot [?]: Specifies the path of the boot image (initrd), relative to /usr/share/kiwi/image
  • bootfilesystem [?]: 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
  • firmware [?]: 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
  • bootkernel [?]: 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
  • bootloader [?]: 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
  • bootloader_console [?]: Specifies the bootloader console. The value only has an effect for the grub bootloader. By default a graphics console setup is used
  • zipl_targettype [?]: 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
  • bootpartition [?]: specify if an extra boot partition should be used or not. This will overwrite kiwi’s default layout
  • bootpartsize [?]: 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
  • efipartsize [?]: 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
  • bootprofile [?]: Specifies the boot profile defined in the boot image description. When kiwi builds the boot image the information is passed as add-profile option
  • boottimeout [?]: 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
  • btrfs_root_is_snapshot [?]: 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
  • btrfs_root_is_readonly_snapshot [?]: 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
  • checkprebuilt [?]: Activates whether KIWI should search for a prebuild boot image or not. Obsolete attribute since KIWI v8
  • compressed [?]: 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
  • devicepersistency [?]: Specifies which method to use in order to get persistent storage device names. By default by-uuid is used.
  • editbootconfig [?]: 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
  • editbootinstall [?]: 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
  • filesystem [?]: Specifies the root filesystem type
  • flags [?]: Specifies overlay filesystem flags for the iso image type. clic uses the fuse based clicfs as root overlay filesystem. When using clicfs make sure it is installed on your build host system and also put as bootincluded package in your XML description: <package name="clicfs" bootinclude="true"/>, clic_udf same as clicfs but allows creation if live images which exceeds the 4G boundary, overlay uses the kernel overlayfs as root overlay filesystem. This is the most stable and preferred method.
  • format [?]: Specifies the format of the virtual disk.
  • formatoptions [?]: 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
  • fsnocheck [?]: Turn off periodic filesystem checks on ext2/3/4. Obsolete attribute since KIWI v8
  • fsmountoptions [?]: 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
  • gcelicense [?]: Specifies the license tag in a GCE format
  • hybrid [?]: 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.
  • hybridpersistent [?]: Will trigger the creation of a partition for a COW file to keep data persistent over a reboot
  • hybridpersistent_filesystem [?]: 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 btrfs filesystem is used
  • gpt_hybrid_mbr [?]: for gpt disk types only: create a hybrid GPT/MBR partition table
  • force_mbr [?]: 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
  • initrd_system [?]: 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
  • image : Specifies the image type
  • installboot [?]: 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”
  • installprovidefailsafe [?]: Specifies if the bootloader menu should provide an” failsafe entry with special kernel parameters or not”
  • installiso [?]: Specifies if a install iso should be created (oem only)
  • installstick [?]: Specifies if a install stick should be created (oem only)
  • installpxe [?]: Specifies if all data for a pxe network installation should be created (oem only)
  • kernelcmdline [?]: The kernelcmdline element specifies additional kernel command line options
  • luks [?]: 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
  • luksOS [?]: 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
  • mdraid [?]: Setup software raid in degraded mode with one disk Thus only mirroring and striping is possible
  • overlayroot [?]: 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
  • primary [?]: Specifies the primary type (choose KIWI option type)
  • ramonly [?]: for use with overlay filesystems only: will force any COW action to happen in RAM
  • rootfs_label [?]: label to set for the root filesystem. By default ROOT is used
  • spare_part [?]: 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
  • target_blocksize [?]: 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
  • target_removable [?]: 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
  • vga [?]: 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
  • vhdfixedtag [?]: Specifies the GUID in a fixed format VHD
  • volid [?]: 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.
  • wwid_wait_timeout [?]: 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
  • derived_from [?]: 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.
containerconfig

Provides metadata information for containers

Parents:
These elements contain containerconfig: type
Children:
The following elements occur in containerconfig: entrypoint [?], subcommand [?], expose [?], volumes [?], environment [?], labels [?]

List of attributes for containerconfig:

  • name : 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
  • tag [?]: 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
  • maintainer [?]: Specifies a maintainer for the container.
  • user [?]: Specifies a user for the container.
  • workingdir [?]: Specifies the default working directory of the container
entrypoint

Provides details for the entry point command. This includes the execution name and its parameters. Arguments can be optionally specified

Parents:
These elements contain entrypoint: containerconfig
Children:
The following elements occur in entrypoint: argument [*]

List of attributes for entrypoint:

  • execute : Specifies the entry point program name to execute
  • clear : Specifies to clear or not some data or configurations
argument

Provides details about a command argument

Parents:
These elements contain argument: entrypoint, subcommand

List of attributes for argument:

  • name : Specifies a command argument name
subcommand

Provides details for the subcommand command. This includes the execution name and its parameters. Arguments can be optionally specified. The subcommand is appended the command information from the entrypoint. It is in the responsibility of the author to make sure the combination of entrypoint and subcommand forms a valid execution command

Parents:
These elements contain subcommand: containerconfig
Children:
The following elements occur in subcommand: argument [*]

List of attributes for subcommand:

  • execute : Specifies the subcommand program name to execute
  • clear : Specifies to clear or not some data or configurations
argument

Provides details about a command argument

Parents:
These elements contain argument: entrypoint, subcommand

List of attributes for argument:

  • name : Specifies a command argument name
expose

Provides details about network ports which should be exposed from the container. At least one port must be configured

Parents:
These elements contain expose: containerconfig
Children:
The following elements occur in expose: port [+]
port

Provides details about an exposed port.

Parents:
These elements contain port: expose

List of attributes for port:

  • number : Specifies the port number to expose
volumes

Provides details about storage volumes in the container At least one volume must be configured

Parents:
These elements contain volumes: containerconfig
Children:
The following elements occur in volumes: volume [+]
volume

Specify which parts of the filesystem should be on an extra volume.

Parents:
These elements contain volume: volumes, systemdisk

List of attributes for volume:

  • copy_on_write [?]: Apply the filesystem copy-on-write attribute for this volume
  • freespace [?]: 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
  • mountpoint [?]: volume path. The mountpoint specifies a path which has to exist inside the root directory.
  • name : 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.
  • size [?]: 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
environment

Provides details about the container environment variables At least one environment variable must be configured

Parents:
These elements contain environment: containerconfig
Children:
The following elements occur in environment: env [+]
env

Provides details about an environment variable

Parents:
These elements contain env: environment

List of attributes for env:

  • name : Specifies the environment variable name
  • value : Specifies the environment variable value
labels

Provides details about container labels At least one label must be configured

Parents:
These elements contain labels: containerconfig
Children:
The following elements occur in labels: label [+]
label

Provides details about a container label

Parents:
These elements contain label: labels

List of attributes for label:

  • name : Specifies the label name
  • value : Specifies the label value
machine

specifies the VM configuration sections

Parents:
These elements contain machine: type
Children:
The following elements occur in machine: vmconfig-entry [*], vmdisk , vmdvd [?], vmnic [*]

List of attributes for machine:

  • min_memory [?]: The virtual machine min memory in MB (ovf only)
  • max_memory [?]: The virtual machine max memory in MB (ovf only)
  • min_cpu [?]: The virtual machine min CPU count (ovf only)
  • max_cpu [?]: The virtual machine max CPU count (ovf only)
  • ovftype [?]: The OVF configuration type
  • HWversion [?]: The virtual HW version number for the VM configuration (vmdk and ovf)
  • arch [?]: the VM architecture type (vmdk only)
  • domain [?]: The domain setup for the VM (xen only)
  • guestOS [?]: The virtual guestOS identification string for the VM (vmdk and ovf, note the name designation is different for the two formats)
  • memory [?]: The memory, in MB, setup for the guest VM (all formats)
  • ncpus [?]: The number of virtual cpus for the guest VM (all formats)
vmconfig-entry

An entry for the VM configuration file

Parents:
These elements contain vmconfig-entry: machine
vmdisk

The VM disk definition.

Parents:
These elements contain vmdisk: machine

List of attributes for vmdisk:

  • disktype [?]: The type of the disk as it is internally handled by the VM (ovf only)
  • controller [?]: The disk controller used for the VM guest (vmdk only)
  • id [?]: The disk ID / device for the VM disk (vmdk only)
  • device [?]: The disk device to appear in the guest (xen only)
  • diskmode [?]: The disk mode (vmdk only)
vmdvd

The VM CD/DVD drive definition. You can setup either a scsi CD or an ide CD drive

Parents:
These elements contain vmdvd: machine

List of attributes for vmdvd:

  • controller : The CD/DVD controller used for the VM guest
  • id : The CD/DVD ID for the VM CD rom drive
vmnic

The VM network interface definition

Parents:
These elements contain vmnic: machine

List of attributes for vmnic:

  • driver [?]: The driver used for the VM network interface
  • interface : The interface ID for the VM network interface
  • mode [?]: The VM network mode
  • mac [?]: The VM mac address
oemconfig

Specifies the OEM configuration section

Parents:
These elements contain oemconfig: type
Children:
The following elements occur in oemconfig: oem-ataraid-scan [?], oem-boot-title [?], oem-bootwait [?], oem-device-filter [?], oem-nic-filter [?], oem-inplace-recovery [?], oem-kiwi-initrd [?], oem-multipath-scan [?], oem-vmcp-parmfile [?], oem-partition-install [?], oem-reboot [?], oem-reboot-interactive [?], oem-recovery [?], oem-recoveryID [?], oem-recovery-part-size [?], oem-shutdown [?], oem-shutdown-interactive [?], oem-silent-boot [?], oem-silent-install [?], oem-silent-verify [?], oem-skip-verify [?], oem-swap [?], oem-swapsize [?], oem-systemsize [?], oem-unattended [?], oem-unattended-id [?]
oem-ataraid-scan

For oemboot driven images: turn on or off the search for ata raid devices (aka fake raid controllers) true/false (default is true)

Parents:
These elements contain oem-ataraid-scan: oemconfig
oem-boot-title

For oemboot driven images: setup of the boot menu text displayed within the square brackets after first reboot of the OEM image

Parents:
These elements contain oem-boot-title: oemconfig
oem-bootwait

For oemboot driven images: halt system after image dump true/false

Parents:
These elements contain oem-bootwait: oemconfig
oem-device-filter

For oemboot driven images: filter install devices by given regular expression. The expression is handled by the bash regexp operator

Parents:
These elements contain oem-device-filter: oemconfig
oem-nic-filter

For oemboot driven images: filter network interface names by given regular expression. The expression is handled by the bash regexp operator. Interface names matching the rule will be skipped. All other interface names stay in the list. It is also possible to pass the variable kiwi_oemnicfilter as kernel command line in a PXE deployment

Parents:
These elements contain oem-nic-filter: oemconfig
oem-inplace-recovery

For oemboot driven images: Specify whether the recovery archive should be stored as part of the image or not. If it’s not stored it’s created during install of the oem image

Parents:
These elements contain oem-inplace-recovery: oemconfig
oem-kiwi-initrd

For oemboot driven images: use kiwi initrd in any case and don’t replace it with mkinitrd created initrd

Parents:
These elements contain oem-kiwi-initrd: oemconfig
oem-multipath-scan

For oemboot driven images: turn on or off the search for multipath devices: true/false (default is true)

Parents:
These elements contain oem-multipath-scan: oemconfig
oem-vmcp-parmfile

For oemboot driven images: provide the name of a parmfile which is loaded via cmsfscat on s390 systems. Default value is set to: PARM-S11

Parents:
These elements contain oem-vmcp-parmfile: oemconfig
oem-partition-install

For oemboot driven images: install the system not as disk but into a free partition. If this option is set all other oem-* options concerning the partition table will not have any effect

Parents:
These elements contain oem-partition-install: oemconfig
oem-reboot

For oemboot driven images: reboot after first deployment true/false

Parents:
These elements contain oem-reboot: oemconfig
oem-reboot-interactive

For oemboot driven images: reboot after first deployment true/false

Parents:
These elements contain oem-reboot-interactive: oemconfig
oem-recovery

For oemboot driven images: create a recovery archive yes/no

Parents:
These elements contain oem-recovery: oemconfig
oem-recoveryID

For oemboot driven images: Set the partition ID of recovery partition. Default value is 83 (Linux)

Parents:
These elements contain oem-recoveryID: oemconfig
oem-recovery-part-size

For oemboot driven images: Set the size of the recovery partition. Value is interpreted as MB

Parents:
These elements contain oem-recovery-part-size: oemconfig
oem-shutdown

For oemboot driven images: shutdown after first deployment true/false

Parents:
These elements contain oem-shutdown: oemconfig
oem-shutdown-interactive

For oemboot driven images: shutdown after first deployment true/false

Parents:
These elements contain oem-shutdown-interactive: oemconfig
oem-silent-boot

For oemboot driven images: boot silently during the initial boot true/false

Parents:
These elements contain oem-silent-boot: oemconfig
oem-silent-install

For oemboot driven images: do not show progress of the image dump process, true/false

Parents:
These elements contain oem-silent-install: oemconfig
oem-silent-verify

For oemboot driven images: do not show progress of the image verification process, true/false

Parents:
These elements contain oem-silent-verify: oemconfig
oem-skip-verify

For oemboot driven images: do not perform the md5 verification process, true/false

Parents:
These elements contain oem-skip-verify: oemconfig
oem-swap

For oemboot driven images: use a swap partition yes/no

Parents:
These elements contain oem-swap: oemconfig
oem-swapsize

For oemboot driven images: Set the size of the swap partition in MB

Parents:
These elements contain oem-swapsize: oemconfig
oem-systemsize

For oemboot driven images: Set the size of the system (root) partition in MB

Parents:
These elements contain oem-systemsize: oemconfig
oem-unattended

For oemboot driven images: don’t ask questions if possible true/false

Parents:
These elements contain oem-unattended: oemconfig
oem-unattended-id

For oemboot driven images: use the specified disk id the device is looked up in /dev/disk/by-* and /dev/mapper/*

Parents:
These elements contain oem-unattended-id: oemconfig
pxedeploy

Controls the Image Deploy Process

Parents:
These elements contain pxedeploy: type
Children:
The following elements occur in pxedeploy: timeout [?], kernel [?], initrd [?], partitions [?], union [?], configuration [*]

List of attributes for pxedeploy:

  • server [?]: Name or IP Address of server for downloading the data
  • blocksize [?]: Blocksize value used for atftp downloads
timeout

Specifies an ATFTP Download Timeout

Parents:
These elements contain timeout: pxedeploy
kernel

Specifies Where to Find the Boot Kernel

Parents:
These elements contain kernel: pxedeploy
initrd

Specifies where the Boot Image can be Found

Parents:
These elements contain initrd: pxedeploy
partitions

A List of Partitions

Parents:
These elements contain partitions: pxedeploy
Children:
The following elements occur in partitions: partition [+]

List of attributes for partitions:

  • device [?]: As part of the network deploy configuration this section specifies the disk device name
partition

A Partition

Parents:
These elements contain partition: partitions

List of attributes for partition:

  • type : Partition Type identifier, see parted for details
  • number : Partition ID
  • size [?]: A partition size or optional image size
  • mountpoint [?]: Mount path for this partition
  • target [?]: Is a real target or not which means is part of the /etc/fstab file or not
union

Specifies the Overlay Filesystem

Parents:
These elements contain union: pxedeploy

List of attributes for union:

  • ro : Device only for read-only
  • rw : Device for Read-Write
  • type : Union type to use to overlay read-write and read-only parts
configuration

Specifies Configuration files

Parents:
These elements contain configuration: pxedeploy

List of attributes for configuration:

  • source : A source location where a package or configuration file can be found
  • dest : Destination of a resource
  • arch [?]: A system architecture name, matching the ‘uname -m’ information Multiple architectures can be combined as comma separated list e.g arch=”x86_64,ix86”
size

Specifies the Size of an Image in (M)egabyte or (G)igabyte If the attribute additive is set the value will be added to the required size of the image

Parents:
These elements contain size: type

List of attributes for size:

  • unit [?]: The unit of the image size
  • additive [?]: Specifies if the size value is absolute or added on top of the current data size
systemdisk

Specify volumes and size attributes

Parents:
These elements contain systemdisk: type
Children:
The following elements occur in systemdisk: volume [*]

List of attributes for systemdisk:

  • name [?]: Specify Volume group name, default is kiwiVG. This information is only used if the LVM volume management is used
  • preferlvm [?]: Prefer LVM even if the used filesystem has its own volume management system
volume

Specify which parts of the filesystem should be on an extra volume.

Parents:
These elements contain volume: volumes, systemdisk

List of attributes for volume:

  • copy_on_write [?]: Apply the filesystem copy-on-write attribute for this volume
  • freespace [?]: 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
  • mountpoint [?]: volume path. The mountpoint specifies a path which has to exist inside the root directory.
  • name : 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.
  • size [?]: 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
vagrantconfig

Specifies the Vagrant configuration section

Parents:
These elements contain vagrantconfig: type

List of attributes for vagrantconfig:

  • provider : The vagrant provider for this box
  • virtualsize : The vagrant virtual image size in GB
  • boxname [?]: The boxname as it’s written into the json file If not specified the image name is used

version

A Version Number for the Image, Consists of Major.Minor.Release

Parents:
These elements contain version: preferences

profiles

Creates Namespace Section for Drivers

Parents:
These elements contain profiles: image
Children:
The following elements occur in profiles: profile [+]

profile

Creates Profiles

Parents:
These elements contain profile: profiles

List of attributes for profile:

  • name : A name
  • description : Description of how this profiles influences the image
  • import [?]: Import profile by default if no profile was set on the command line

users

A List of Users

Parents:
These elements contain users: image
Children:
The following elements occur in users: user [+]

List of attributes for users:

  • profiles [?]: A profile name which binds the section to this name

user

A User with Name, Password, Path to Its Home And Shell

Parents:
These elements contain user: users

List of attributes for user:

  • groups [?]: The list of groups that he user belongs to. The frist item in the list is used as the login group. If ‘groups’ is not present a default group is assigned to the user according to he specifing toolchain behaviour.
  • home : The home directory for this user
  • id [?]: The user ID for this user
  • name : A name
  • password [?]: The password
  • pwdformat [?]: Format of the given password, encrypted is the default
  • realname [?]: The name of an user
  • shell [?]: The shell for this user

drivers

A Collection of Driver Files

Parents:
These elements contain drivers: image
Children:
The following elements occur in drivers: file [+]

List of attributes for drivers:

  • profiles [?]: A profile name which binds the section to this name

file

A Pointer to a File

Parents:
These elements contain file: drivers, strip

List of attributes for file:

  • name : A name
  • arch [?]: A system architecture name, matching the ‘uname -m’ information Multiple architectures can be combined as comma separated list e.g arch=”x86_64,ix86”

strip

A Collection of files to strip

Parents:
These elements contain strip: image
Children:
The following elements occur in strip: file [+]

List of attributes for strip:

  • type : Specifies the strip data type. delete references a list of custom files and directories to delete, tools references file names in linux bin/sbin directories, libs references file names in linux lib directories.
  • profiles [?]: A profile name which binds the section to this name

file

A Pointer to a File

Parents:
These elements contain file: drivers, strip

List of attributes for file:

  • name : A name
  • arch [?]: A system architecture name, matching the ‘uname -m’ information Multiple architectures can be combined as comma separated list e.g arch=”x86_64,ix86”

repository

The Name of the Repository

Parents:
These elements contain repository: image
Children:
The following elements occur in repository: source

List of attributes for repository:

  • type [?]: Type of repository
  • profiles [?]: A profile name which binds the section to this name
  • status [?]: Specifies the status of the repository. This can be replaceable or if not specified it’s a must have repository
  • alias [?]: Alias name to be used for this repository. This is an optional free form text. If not set the source attribute value is used and builds the alias name by replacing each ‘/’ with a ‘_’. An alias name should be set if the source argument doesn’t really explain what this repository contains
  • components [?]: Distribution components, used for deb repositories. If not set it defaults to main
  • distribution [?]: Distribution name information, used for deb repositories
  • imageinclude [?]: Specify whether or not this repository should be configured in the resulting image. Boolean value true or false, the default is false.
  • prefer-license [?]: Use the license found in this repository, if any, as the license installed in the image
  • priority [?]: Channel priority assigned to all packages available in this channel (0 if not set). If the exact same package is available in more than one channel, the highest priority is used
  • password [?]: The password
  • username [?]: A name of a user

source

A Pointer to a data source. This can be a remote location as well as a path specification

Parents:
These elements contain source: repository

List of attributes for source:

  • path : A path

packages

Specifies Packages/Patterns Used in Different Stages

Parents:
These elements contain packages: image
Children:
The following elements occur in packages: archive [*], ignore [*], namedCollection [*], product [*], package [*]

List of attributes for packages:

  • type : Specifies package collection type. bootstrap packages gets installed in the very first phase of an image build in order to fill the empty root directory with bootstrap data. image packages are installed after the bootstrap phase as chroot operation. delete packages are uninstalled after the preparation phase is done. image_type_name packages are only installed if this build type is requested.
  • profiles [?]: A profile name which binds the section to this name
  • patternType [?]: Selection type for patterns. Could be onlyRequired or plusRecommended

archive

Name of an image archive file (tarball)

Parents:
These elements contain archive: packages

List of attributes for archive:

  • name : A name
  • bootinclude [?]: Indicates that this package should be part of the boot image (initrd) too. This attribute can be used to include for example branding packages specified in the system image description to become part of the boot image also

ignore

Ignores a Package

Parents:
These elements contain ignore: packages

List of attributes for ignore:

  • name : A name
  • arch [?]: A system architecture name, matching the ‘uname -m’ information Multiple architectures can be combined as comma separated list e.g arch=”x86_64,ix86”

namedCollection

Name of a Pattern for SUSE or a Group for RH

Parents:
These elements contain namedCollection: packages

List of attributes for namedCollection:

  • name : A name
  • arch [?]: A system architecture name, matching the ‘uname -m’ information Multiple architectures can be combined as comma separated list e.g arch=”x86_64,ix86”

product

Name of a Product From openSUSE

Parents:
These elements contain product: packages

List of attributes for product:

  • name : A name
  • arch [?]: A system architecture name, matching the ‘uname -m’ information Multiple architectures can be combined as comma separated list e.g arch=”x86_64,ix86”

package

Name of an image Package

Parents:
These elements contain package: packages

List of attributes for package:

  • name : A name
  • arch [?]: A system architecture name, matching the ‘uname -m’ information Multiple architectures can be combined as comma separated list e.g arch=”x86_64,ix86”
  • replaces [?]: Replace package with some other package
  • bootdelete [?]: Indicates that this package should be removed from the boot image (initrd). the attribute is only evaluated if the bootinclude attribute is specified along with it too
  • bootinclude [?]: Indicates that this package should be part of the boot image (initrd) too. This attribute can be used to include for example branding packages specified in the system image description to become part of the boot image also

extension

Define custom XML extensions

Parents:
These elements contain extension: image