KIWI NG Logo
  • Overview
    • Basic Workflow
      • Components of an Image Description
    • Conceptual Overview
    • Terminology
    • System Requirements
  • Installation
    • Installation from OBS
    • Installation from Distribution Repositories
    • Installation for SUSE Linux Enterprise
    • Example Appliance Descriptions
  • Quick Start
    • Before you start
    • Choose a First Image
    • Build your First Image
    • Run your Image
    • Tweak and Customize your Image
  • Working from the Command Line
    • kiwi-ng
      • SYNOPSIS
      • DESCRIPTION
      • GLOBAL OPTIONS
      • EXAMPLE
    • kiwi-ng result list
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
    • kiwi-ng result bundle
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
    • kiwi-ng system prepare
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
    • kiwi-ng system update
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
    • kiwi-ng system build
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
      • URI_TYPES
    • kiwi-ng system create
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
    • kiwi-ng image resize
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
    • kiwi-ng image info
      • SYNOPSIS
      • DESCRIPTION
      • OPTIONS
  • Troubleshooting
    • Build Host Constraints
    • Architectures
    • Host Security Settings Conflicts with KIWI
    • Incompatible Filesystem Settings on Host vs. Image
    • Boxbuild Tweaks
      • Increase Box Build Image Size
  • KIWI Plugins
    • Building in a Self-Contained Environment
      • Requirements
      • Building with the boxbuild command
      • Sharing Backends
    • Building based on Containers
      • Installation
      • Concept
      • Create a stash
      • Rebuild from a stash
      • Turn a container into a VM image
  • Concept and Workflow
    • Host Requirements To Build Images
    • Setting up Repositories
      • Adding repositories
        • Supported repository paths
    • Adding and Removing Packages
      • The package element
      • The archive element
      • Uninstall System Packages
      • The product and namedCollection element
      • The ignore element
    • Image Profiles
    • Adding Users
    • User-Defined Scripts
      • Developing/Debugging Scripts
        • Script Template for config.sh / images.sh
        • Functions and Variables Provided by KIWI NG
        • Configuration Tips
    • The Runtime Configuration File
    • Customizing the Boot Process
      • Boot Image Hook-Scripts
      • Boot Image Parameters
        • Boot Debugging
    • Overview
    • Image Building Process
      • The Prepare Step
      • The Create Step
  • Image Description
    • Image Description Elements
      • <image>
      • <include>
      • <description>
      • <preferences>
        • <preferences><version>
        • <preferences><packagemanager>
        • <preferences><rpm-locale-filtering>
        • <preferences><rpm-check-signatures>
        • <preferences><rpm-excludedocs>
        • <preferences><keytable>
        • <preferences><timezone>
        • <preferences><locale>
        • <preferences><bootsplash-theme>
        • <preferences><bootloader-theme>
        • <preferences><release-version>
        • <preferences><type>
        • <preferences><type><luksformat>
        • <preferences><type><bootloader>
        • <preferences><type><bootloader><securelinux>
        • <preferences><type><bootloader><bootloadersettings>
        • <preferences><type><containerconfig>
        • <preferences><type><vagrantconfig>
        • <preferences><type><systemdisk>
        • <preferences><type><partitions>
        • <preferences><type><oemconfig>
        • <preferences><type><size>
        • <preferences><type><machine>
        • <preferences><type><installmedia>
      • <containers>
      • <containers><container>
      • <repository>
        • <repository><source>
      • <packages>
        • <packages><package>
        • <packages><namedCollection>
        • <packages><collectionModule>
        • <packages><file>
        • <packages><archive>
        • <packages><ignore>
        • <packages><product>
      • <users>
      • <profiles>
    • Main Root
    • Image Identity
    • Image Preferences
    • Image Software Sources
    • Image Content Setup
    • Image Users
    • Image Namespace
    • Image Includes
  • Image Types
    • Image Results
    • Image Bundle Format
  • Building Images for Supported Types
    • Build an ISO Hybrid Live Image
      • overlay or dmsquash
    • Build a Virtual Disk Image
      • Setting up the Bootloader in the Image
      • Modifying the Size of the Image
      • Customizing the Virtual Machine
        • Modifying the VM Configuration Directly
        • Adding Network Interfaces to the VM
        • Specifying Disks and Disk Controllers
        • Adding CD/DVD Drives
    • Build an Expandable Disk Image
      • Deployment Methods
      • Manual Deployment
      • CD/DVD Deployment
      • Network Deployment
      • OEM Customization
      • Installation Media Customization
    • Build a Container Image
    • Build a WSL Container Image
      • Setup of the WSL-DistroLauncher
      • Testing the WSL image
    • Build KIS Image (Kernel, Initrd, System)
    • Build an AWS Nitro Enclave
  • Working with Images
    • Deploy ISO Image on an USB Stick
    • Deploy ISO Image as File on a FAT32 Formated USB Stick
    • Booting a Live ISO Images from Grub2
    • Image Description for Amazon EC2
    • Image Description for Microsoft Azure
    • Image Description for Google Compute Engine
    • Image Description for Vagrant
      • Customizing the embedded Vagrantfile
    • Image Description Encrypted Disk
    • Deploy and Run System in a RamDisk
    • Custom Disk Partitions
    • Custom Disk Volumes
    • Partition Clones
      • Use Case
    • Setting Up a Network Boot Server
      • Installing and Configuring DHCP and TFTP with dnsmasq
    • Build PXE Root File System Image for the legacy netboot infrastructure
      • PXE Client Setup Configuration
        • Setup Client with Remote Root
        • Setup Client with System on Local Disk
        • Setup Client with System on Local MD RAID Disk
        • Setup Loading of Custom Configuration File(s)
        • Setup Client to Force Reload Image
        • Setup Client to Force Reload Configuration Files
        • Setup Client for Reboot After Deployment
        • Setup custom kernel boot options
        • Setup a Custom Boot Timeout
        • Setup a Different Download Protocol and Server
    • Booting a Root Filesystem from Network
    • Booting a Live ISO Image from Network
    • Setting Up YaST at First Boot
    • Add or Update the Fstab File
    • Building Images with Profiles
      • Local Builds
      • Building with the Open Build Service
    • Building in the Open Build Service
      • Advantages of using the Open Build Service (OBS)
      • Differences Between Building Locally and on OBS
      • Recommendations
        • Working with OBS
        • Repository Configuration
        • Project Configuration
    • Using SUSE Product ISO To Build
    • Circumvent Debian Bootstrap
      • How to Create a bootstrap_package
  • Contributing
    • Using KIWI NG in a Python Project
    • Plugin Architecture
      • Naming conventions
      • Example plugin
    • Write Integration Tests for the Scripts
      • Test setup
    • Extending KIWI NG with Custom Operations
      • The <extension> Section
      • RELAX NG Schema for the Extension
      • Extension schema in XML catalog
      • Using the extension
    • The Basics
    • Fork the upstream repository
    • Create a local clone of the forked repository
    • Install Required Operating System Packages
    • Create a Python Virtual Development Environment
    • Running the Unit Tests
    • Create a Branch for each Feature or Bugfix
    • Coding Style
      • Documentation
    • Additional Information
      • Signing Git Patches
      • Bumping the Version
      • Creating a RPM Package
  • Python API
    • kiwi Package
      • Submodules
      • kiwi.app Module
        • App
      • kiwi.cli Module
        • Cli
      • kiwi.command Module
        • Command
        • CommandCallT
        • CommandT
      • kiwi.command_process Module
        • CommandIterator
        • CommandProcess
      • kiwi.defaults Module
        • Defaults
        • grub_loader_type
        • shim_loader_type
        • unit_type
      • kiwi.exceptions Module
        • KiwiAnyMarkupPluginError
        • KiwiArchiveSetupError
        • KiwiArchiveTarError
        • KiwiBootImageSetupError
        • KiwiBootLoaderConfigSetupError
        • KiwiBootLoaderDiskPasswordError
        • KiwiBootLoaderGrubDataError
        • KiwiBootLoaderGrubFontError
        • KiwiBootLoaderGrubInstallError
        • KiwiBootLoaderGrubModulesError
        • KiwiBootLoaderGrubPlatformError
        • KiwiBootLoaderGrubSecureBootError
        • KiwiBootLoaderInstallSetupError
        • KiwiBootLoaderTargetError
        • KiwiBootLoaderZiplInstallError
        • KiwiBootLoaderZiplPlatformError
        • KiwiBootLoaderZiplSetupError
        • KiwiBootStrapPhaseFailed
        • KiwiBuildahError
        • KiwiBundleError
        • KiwiCommandCapabilitiesError
        • KiwiCommandError
        • KiwiCommandNotFound
        • KiwiCommandNotLoaded
        • KiwiCompressionFormatUnknown
        • KiwiConfigFileFormatNotSupported
        • KiwiConfigFileNotFound
        • KiwiContainerBuilderError
        • KiwiContainerImageSetupError
        • KiwiContainerSetupError
        • KiwiCredentialsError
        • KiwiCustomPartitionConflictError
        • KiwiDataStructureError
        • KiwiDebianBootstrapError
        • KiwiDecodingError
        • KiwiDescriptionInvalid
        • KiwiDeviceProviderError
        • KiwiDiskBootImageError
        • KiwiDiskFormatSetupError
        • KiwiDiskGeometryError
        • KiwiDistributionNameError
        • KiwiEnclaveBootImageError
        • KiwiEnclaveFormatError
        • KiwiError
        • KiwiExtensionError
        • KiwiFileAccessError
        • KiwiFileNotFound
        • KiwiFileSystemSetupError
        • KiwiFileSystemSyncError
        • KiwiFormatSetupError
        • KiwiHelpNoCommandGiven
        • KiwiImageResizeError
        • KiwiImportDescriptionError
        • KiwiIncludFileNotFoundError
        • KiwiInstallBootImageError
        • KiwiInstallMediaError
        • KiwiInstallPhaseFailed
        • KiwiIsoMetaDataError
        • KiwiIsoToolError
        • KiwiKernelLookupError
        • KiwiKisBootImageError
        • KiwiLiveBootImageError
        • KiwiLoadCommandUndefined
        • KiwiLogFileSetupFailed
        • KiwiLogSocketSetupFailed
        • KiwiLoopSetupError
        • KiwiLuksSetupError
        • KiwiMappedDeviceError
        • KiwiMarkupConversionError
        • KiwiMountKernelFileSystemsError
        • KiwiMountSharedDirectoryError
        • KiwiNotImplementedError
        • KiwiOCIArchiveToolError
        • KiwiOSReleaseImportError
        • KiwiOffsetError
        • KiwiPackageManagerSetupError
        • KiwiPackagesDeletePhaseFailed
        • KiwiPartitionTooSmallError
        • KiwiPartitionerGptFlagError
        • KiwiPartitionerMsDosFlagError
        • KiwiPartitionerSetupError
        • KiwiPrivilegesError
        • KiwiProfileNotFound
        • KiwiRaidSetupError
        • KiwiRepositorySetupError
        • KiwiRequestError
        • KiwiRequestedTypeError
        • KiwiResizeRawDiskError
        • KiwiResultError
        • KiwiRootDirExists
        • KiwiRootImportError
        • KiwiRootInitCreationError
        • KiwiRpmDirNotRemoteError
        • KiwiRuntimeConfigFileError
        • KiwiRuntimeConfigFormatError
        • KiwiRuntimeError
        • KiwiSatSolverJobError
        • KiwiSatSolverJobProblems
        • KiwiSatSolverPluginError
        • KiwiSchemaImportError
        • KiwiScriptFailed
        • KiwiSetupIntermediateConfigError
        • KiwiShellVariableValueError
        • KiwiSizeError
        • KiwiSolverRepositorySetupError
        • KiwiSystemDeletePackagesFailed
        • KiwiSystemInstallPackagesFailed
        • KiwiSystemUpdateFailed
        • KiwiTargetDirectoryNotFound
        • KiwiTemplateError
        • KiwiTypeNotFound
        • KiwiUmountBusyError
        • KiwiUnknownServiceName
        • KiwiUriOpenError
        • KiwiUriStyleUnknown
        • KiwiUriTypeUnknown
        • KiwiValidationError
        • KiwiVhdTagError
        • KiwiVolumeGroupConflict
        • KiwiVolumeManagerSetupError
        • KiwiVolumeRootIDError
        • KiwiVolumeTooSmallError
      • kiwi.firmware Module
        • FirmWare
      • kiwi.help Module
        • Help
      • kiwi.kiwi Module
        • extras()
        • main()
        • usage()
      • kiwi.logger Module
        • Logger
      • kiwi.logger_color_formatter Module
        • ColorFormatter
        • ColorMessage
      • kiwi.logger_filter Module
        • DebugFilter
        • ErrorFilter
        • InfoFilter
        • LoggerSchedulerFilter
        • WarningFilter
      • kiwi.mount_manager Module
        • MountManager
      • kiwi.path Module
        • Path
      • kiwi.privileges Module
        • Privileges
      • kiwi.runtime_checker Module
        • RuntimeChecker
        • dracut_module_type
      • kiwi.runtime_config Module
        • RuntimeConfig
      • kiwi.version Module
      • kiwi.xml_description Module
        • XMLDescription
      • kiwi.xml_state Module
        • ContainerT
        • FileT
        • XMLState
        • description_type
        • package_type
        • size_type
        • volume_type
      • Module Contents
    • kiwi.archive Package
      • Submodules
      • kiwi.archive.cpio Module
        • ArchiveCpio
      • kiwi.archive.tar Module
        • ArchiveTar
      • Module Contents
    • kiwi.boot.image Package
      • Submodules
      • kiwi.boot.image.base Module
        • BootImageBase
        • boot_names_type
      • kiwi.boot.image.dracut Module
        • BootImageDracut
      • kiwi.boot.image.builtin_kiwi Module
        • BootImageKiwi
      • Module Contents
        • BootImage
    • kiwi.bootloader.config Package
      • Submodules
      • kiwi.bootloader.config.base Module
        • BootLoaderConfigBase
      • kiwi.bootloader.config.grub2 Module
        • BootLoaderConfigGrub2
      • kiwi.bootloader.config.systemd_boot Module
        • BootLoaderSystemdBoot
      • kiwi.bootloader.config.zipl Module
        • BootLoaderZipl
      • Module Contents
        • create_boot_loader_config()
    • kiwi.bootloader.install Package
      • Submodules
      • kiwi.bootloader.install.base Module
        • BootLoaderInstallBase
      • kiwi.bootloader.install.grub2 Module
        • BootLoaderInstallGrub2
      • kiwi.bootloader.install.systemd_boot Module
        • BootLoaderInstallSystemdBoot
      • kiwi.bootloader.install.zipl Module
        • BootLoaderInstallZipl
      • Module Contents
        • BootLoaderInstall
    • kiwi.bootloader Package
      • Module Contents
    • kiwi.bootloader.template Package
      • Submodules
      • kiwi.bootloader.template.grub2 Module
        • BootLoaderTemplateGrub2
      • Module Contents
    • kiwi.boot Package
      • Module Contents
    • kiwi.builder Package
      • Submodules
      • kiwi.builder.archive Module
        • ArchiveBuilder
      • kiwi.builder.container Module
        • ContainerBuilder
      • kiwi.builder.disk Module
        • DiskBuilder
        • StorageMap
      • kiwi.builder.filesystem Module
        • FileSystemBuilder
      • kiwi.builder.install Module
        • InstallImageBuilder
      • kiwi.builder.live Module
        • LiveImageBuilder
      • kiwi.builder.kis Module
        • KisBuilder
      • Module Contents
        • ImageBuilder
    • kiwi.container Package
      • Submodules
      • kiwi.container.oci Module
        • ContainerImageOCI
        • OciConfig
      • Module Contents
        • ContainerImage
    • kiwi.container.setup Package
      • Submodules
      • kiwi.container.setup.base Module
        • ContainerSetupBase
      • kiwi.container.setup.docker Module
        • ContainerSetupDocker
      • Module Contents
        • ContainerSetup
    • kiwi.filesystem Package
      • Submodules
      • kiwi.filesystem.base Module
        • FileSystemBase
      • kiwi.filesystem.btrfs Module
        • FileSystemBtrfs
      • kiwi.filesystem.ext2 Module
        • FileSystemExt2
      • kiwi.filesystem.ext3 Module
        • FileSystemExt3
      • kiwi.filesystem.ext4 Module
        • FileSystemExt4
      • kiwi.filesystem.fat16 Module
        • FileSystemFat16
      • kiwi.filesystem.fat32 Module
        • FileSystemFat32
      • kiwi.filesystem.isofs Module
        • FileSystemIsoFs
      • kiwi.filesystem.setup Module
        • FileSystemSetup
      • kiwi.filesystem.squashfs Module
        • FileSystemSquashFs
      • kiwi.filesystem.xfs Module
        • FileSystemXfs
      • Module Contents
        • FileSystem
    • kiwi.iso_tools Package
      • Submodules
      • kiwi.iso_tools.base Module
        • IsoToolsBase
      • kiwi.iso_tools.xorriso Module
        • IsoToolsXorrIso
      • kiwi.iso_tools.iso Module
        • Iso
      • Module Contents
        • IsoTools
    • kiwi.package_manager Package
      • Submodules
      • kiwi.package_manager.base Module
        • PackageManagerBase
      • kiwi.package_manager.dnf4 Module
        • PackageManagerDnf4
      • kiwi.package_manager.zypper Module
        • PackageManagerZypper
      • Module Contents
        • PackageManager
    • kiwi.partitioner Package
      • Submodules
      • kiwi.partitioner.base Module
        • PartitionerBase
      • kiwi.partitioner.dasd Module
        • PartitionerDasd
      • kiwi.partitioner.gpt Module
        • PartitionerGpt
      • kiwi.partitioner.msdos Module
        • PartitionerMsDos
      • Module Contents
        • Partitioner
    • kiwi.repository Package
      • Submodules
      • kiwi.repository.base Module
        • RepositoryBase
      • kiwi.repository.dnf4 Module
        • RepositoryDnf4
      • kiwi.repository.zypper Module
        • RepositoryZypper
      • Module Contents
        • Repository
    • kiwi.repository.template Package
      • Submodules
      • kiwi.repository.template.apt Module
        • PackageManagerTemplateAptGet
      • Module Contents
    • kiwi.solver.repository Package
      • Submodules
      • kiwi.solver.repository.base Module
        • SolverRepositoryBase
        • SolverRepositoryRpmMd
        • SolverRepositoryRpmDir
        • SolverRepositorySUSE
      • Module Contents
        • SolverRepository
    • kiwi.solver Package
      • Submodules
      • kiwi.solver.sat Module
        • Sat
      • Module Contents
    • kiwi.storage Package
      • Submodules
      • kiwi.storage.device_provider Module
        • DeviceProvider
      • kiwi.storage.disk Module
        • Disk
        • ptable_entry_type
      • kiwi.storage.loop_device Module
        • LoopDevice
      • kiwi.storage.luks_device Module
        • LuksDevice
      • kiwi.storage.mapped_device Module
        • MappedDevice
      • kiwi.storage.raid_device Module
        • RaidDevice
      • kiwi.storage.clone_device Module
        • CloneDevice
      • kiwi.storage.setup Module
        • DiskSetup
      • Module Contents
    • kiwi.storage.subformat Package
      • Submodules
      • kiwi.storage.subformat.base Module
        • DiskFormatBase
      • kiwi.storage.subformat.gce Module
        • DiskFormatGce
      • kiwi.storage.subformat.ova Module
        • DiskFormatOva
      • kiwi.storage.subformat.qcow2 Module
        • DiskFormatQcow2
      • kiwi.storage.subformat.vagrant_base Module
        • DiskFormatVagrantBase
      • kiwi.storage.subformat.vagrant_libvirt Module
        • DiskFormatVagrantLibVirt
      • kiwi.storage.subformat.vagrant_virtualbox Module
        • DiskFormatVagrantVirtualBox
      • kiwi.storage.subformat.vdi Module
        • DiskFormatVdi
      • kiwi.storage.subformat.vhd Module
        • DiskFormatVhd
      • kiwi.storage.subformat.vhdfixed Module
        • DiskFormatVhdFixed
      • kiwi.storage.subformat.vhdx Module
        • DiskFormatVhdx
      • kiwi.storage.subformat.vmdk Module
        • DiskFormatVmdk
      • Module Contents
        • DiskFormat
    • kiwi.storage.subformat.template Package
      • Submodules
      • kiwi.storage.subformat.template.vmware_settings Module
        • VmwareSettingsTemplate
      • kiwi.storage.subformat.template.vagrant_config Module
        • VagrantConfigTemplate
      • kiwi.storage.subformat.template.virtualbox_ovf Module
        • VirtualboxOvfTemplate
      • Module contents
    • kiwi.system Package
      • Submodules
      • kiwi.system.identifier Module
        • SystemIdentifier
      • kiwi.system.kernel Module
        • Kernel
        • kernel_type
        • xen_hypervisor_type
      • kiwi.system.prepare Module
        • SystemPrepare
      • kiwi.system.profile Module
        • Profile
      • kiwi.system.result Module
        • Result
        • result_file_type
        • result_name_tags
      • kiwi.system.root_bind Module
        • RootBind
      • kiwi.system.root_init Module
        • RootInit
      • kiwi.system.setup Module
        • SystemSetup
      • kiwi.system.shell Module
        • Shell
      • kiwi.system.size Module
        • SystemSize
      • kiwi.system.uri Module
        • Uri
      • kiwi.system.users Module
        • Users
      • Module Contents
    • kiwi.tasks package
      • Submodules
      • kiwi.tasks.base Module
        • CliTask
      • kiwi.tasks.result_bundle Module
        • ResultBundleTask
      • kiwi.tasks.result_list Module
        • ResultListTask
      • kiwi.tasks.system_build Module
        • SystemBuildTask
      • kiwi.tasks.system_create Module
        • SystemCreateTask
      • kiwi.tasks.system_prepare Module
        • SystemPrepareTask
      • kiwi.tasks.system_update Module
        • SystemUpdateTask
      • Module Contents
    • kiwi.utils Package
      • Submodules
      • kiwi.utils.checksum Module
        • BlockID
      • kiwi.utils.block Module
        • Checksum
      • kiwi.utils.compress Module
        • Compress
      • kiwi.utils.sync Module
        • DataSync
      • kiwi.utils.sysconfig Module
        • SysConfig
      • Module Contents
    • kiwi.volume_manager Package
      • Submodules
      • kiwi.volume_manager.base Module
        • VolumeManagerBase
      • kiwi.volume_manager.btrfs Module
        • VolumeManagerBtrfs
      • kiwi.volume_manager.lvm Module
        • VolumeManagerLVM
      • Module Contents
        • VolumeManager
KIWI NG
  • Search

© Copyright 2020-2024, Marcus Schäfer.

Built with Sphinx using a theme provided by Read the Docs.