kiwi.iso_tools Package¶
Submodules¶
kiwi.iso_tools.base
Module¶
- class kiwi.iso_tools.base.IsoToolsBase(source_dir: str)[source]¶
Bases:
object
Base Class for Parameter API for iso creation tools
- add_efi_loader_parameters(loader_file: str) None [source]¶
Add ISO creation parameters to embed the EFI loader
Implementation in specialized tool class
- create_iso(filename: str, hidden_files: Optional[List[str]] = None) None [source]¶
Create iso file
Implementation in specialized tool class
- Parameters:
filename (str) – unused
hidden_files (list) – unused
- get_tool_name() str [source]¶
Return caller name for iso creation tool
Implementation in specialized tool class
- Returns:
tool name
- Return type:
str
- has_iso_hybrid_capability() bool [source]¶
Indicate if the iso tool has the capability to embed a partition table into the iso such that it can be used as both; an iso and a disk
Implementation in specialized tool class
- init_iso_creation_parameters(custom_args: Optional[Dict[str, str]] = None) None [source]¶
Create a set of standard parameters for the main isolinux loader
Implementation in specialized tool class
- Parameters:
custom_args (list) – unused
kiwi.iso_tools.xorriso
Module¶
- class kiwi.iso_tools.xorriso.IsoToolsXorrIso(source_dir: str)[source]¶
Bases:
IsoToolsBase
xorriso wrapper class
Implementation of Parameter API for iso creation tools using the libburnia project. Addressed here is the tool xorriso
- add_efi_loader_parameters(loader_file: str) None [source]¶
Add ISO creation parameters to embed the EFI loader
In order to boot the ISO from EFI, the EFI binary is added as alternative loader to the ISO creation parameter list. The EFI binary must be included into a fat filesystem in order to become recognized by the firmware. For details about this file refer to _create_embedded_fat_efi_image() from bootloader/config/grub2.py
- create_iso(filename: str, hidden_files: Optional[List[str]] = None) None [source]¶
Creates the iso file with the given filename using xorriso
- Parameters:
filename (str) – output filename
hidden_files (list) – list of hidden files
- get_tool_name() str [source]¶
Lookup xorriso in search path
- Raises:
KiwiIsoToolError – if xorriso tool is not found
- Returns:
xorriso tool path
- Return type:
str
kiwi.iso_tools.iso
Module¶
- class kiwi.iso_tools.iso.Iso(source_dir: str)[source]¶
Bases:
object
Implements helper methods around the creation of ISO filesystems
- static set_media_tag(isofile: str) None [source]¶
Include checksum tag in the ISO so it can be verified with the mediacheck program.
- Parameters:
isofile (str) – path to the ISO file
- setup_isolinux_boot_path() None [source]¶
Write the base boot path into the isolinux loader binary
- Raises:
KiwiIsoLoaderError – if loader/isolinux.bin is not found