kiwi.builder Package¶
Submodules¶
kiwi.builder.archive
Module¶
kiwi.builder.container
Module¶
kiwi.builder.disk
Module¶
-
class
kiwi.builder.disk.
DiskBuilder
(xml_state, target_dir, root_dir, custom_args=None)[source]¶ Bases:
object
Disk image builder
- Parameters
-
create
()[source]¶ Build a bootable disk image and optional installation image The installation image is a bootable hybrid ISO image which embeds the disk image and an image installer
Image types which triggers this builder are:
image=”oem”
image=”vmx”
- Returns
result
- Return type
instance of
Result
-
create_disk
()[source]¶ Build a bootable raw disk image
- Raises
KiwiInstallMediaError – if install media is required and image type is not oem
KiwiVolumeManagerSetupError – root overlay at the same time volumes are defined is not supported
- Returns
result
- Return type
instance of
Result
-
create_disk_format
(result_instance)[source]¶ Create a bootable disk format from a previously created raw disk image
- Parameters
result_instance (object) – instance of
Result
- Returns
updated result_instance
- Return type
instance of
Result
-
create_install_media
(result_instance)[source]¶ Build an installation image. The installation image is a bootable hybrid ISO image which embeds the raw disk image and an image installer
- Parameters
result_instance (object) – instance of
Result
- Returns
updated result_instance with installation media
- Return type
instance of
Result
kiwi.builder.filesystem
Module¶
kiwi.builder.install
Module¶
-
class
kiwi.builder.install.
InstallImageBuilder
(xml_state, root_dir, target_dir, boot_image_task, custom_args=None)[source]¶ Bases:
object
Installation image builder
- Parameters
xml_state (object) – instance of
XMLState
root_dir (str) – system image root directory
target_dir (str) – target directory path name
boot_image_task (object) – instance of
BootImage
custom_args (dict) – Custom processing arguments defined as hash keys: * xz_options: string of XZ compression parameters
-
create_install_iso
()[source]¶ Create an install ISO from the disk_image as hybrid ISO bootable via legacy BIOS, EFI and as disk from Stick
Image types which triggers this builder are:
installiso=”true|false”
installstick=”true|false”
-
create_install_pxe_archive
()[source]¶ Create an oem install tar archive suitable for installing a disk image via the network using the PXE boot protocol. The archive contains:
The raw system image xz compressed
The raw system image checksum metadata file
The append file template for the boot server
The system image initrd for kexec
The install initrd
The kernel
Image types which triggers this builder are:
installpxe=”true|false”
kiwi.builder.live
Module¶
-
class
kiwi.builder.live.
LiveImageBuilder
(xml_state, target_dir, root_dir, custom_args=None)[source]¶ Bases:
object
Live image builder
- Parameters
-
create
()[source]¶ Build a bootable hybrid live ISO image
Image types which triggers this builder are:
image=”iso”
- Raises
KiwiLiveBootImageError – if no kernel or hipervisor is found in boot image tree
- Returns
result
- Return type
instance of
Result
kiwi.builder.kis
Module¶
-
class
kiwi.builder.kis.
KisBuilder
(xml_state, target_dir, root_dir, custom_args=None)[source]¶ Bases:
object
Filesystem based image builder.
- Parameters
-
create
()[source]¶ Build a component image consisting out of a boot image(initrd) plus its appropriate kernel files and the root filesystem image with a checksum.
Image types which triggers this builder are:
image=”kis”
image=”pxe”
- Raises
KiwiKisBootImageError – if no kernel or hipervisor is found in boot image tree
- Returns
result
- Return type
instance of
Result