KIWI NG Logo
  • Overview
    • Basic Workflow
      • Components of an Image Description
    • Conceptual Overview
    • Terminology
    • System Requirements
  • Installation
    • Installation from OBS
    • Installation from your distribution’s repositories
    • Installation from PyPI
    • 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
      • COMPATIBILITY
    • 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
  • Building in a Self-Contained Environment
    • Requirements
    • Building with the boxbuild command
  • Concept and Workflow
    • 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
      • Script Template for config.sh / images.sh
      • Functions and Variables Provided by KIWI NG
        • Functions
        • Profile Environment Variables
      • Configuration Tips
    • The Runtime Configuration File
    • Customizing the Boot Process
      • Boot Image Hook-Scripts
      • Boot Image Parameters
        • Boot Debugging
    • Legacy KIWI vs. KIWI Next Generation (KIWI NG)
      • When Do I need to use KIWI Legacy
      • Dropped Features
      • Compatibility
    • Overview
    • Image Building Process
      • The Prepare Step
      • The Create Step
  • Image Description
    • Image Description Elements
      • <image>
      • <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><type>
        • <preferences><type><bootloader>
        • <preferences><type><containerconfig>
        • <preferences><type><vagrantconfig>
        • <preferences><type><systemdisk>
        • <preferences><type><oemconfig>
        • <preferences><type><size>
        • <preferences><type><machine>
      • <repository>
        • <repository><source>
      • <packages>
        • <packages><package>
        • <packages><namedCollection>
        • <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 Types
    • Image Results
    • Build Host Constraints
    • Architectures
  • Building Images for Supported Types
    • Build an ISO Hybrid Live Image
      • Decision for a live ISO technology
    • Build a Virtual Disk Image
      • Setting up the Bootloader of 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
    • Build a Docker Container Image
    • Build a WSL Container Image
      • Setup of the WSL-DistroLauncher
      • Testing the WSL image
    • Build KIS Image (Kernel, Initrd, System)
  • Working with Images
    • Deploy ISO Image on an USB Stick
    • Deploy ISO Image as File on a FAT32 Formated USB Stick
    • Image Description for Amazon EC2
    • Image Description for Microsoft Azure
    • Image Description for Google Compute Engine
    • Setting Up a Network Boot Server
      • Installing and Configuring DHCP and TFTP with dnsmasq
    • Setting Up YaST at First Boot
    • Image Description for Vagrant
      • Customizing the embedded Vagrantfile
    • Booting a Live ISO Image from Network
    • Deploy and Run System in a RamDisk
    • Custom Disk Partitions
      • Custom Partitioning at Boot Time
    • Custom Disk Volumes
    • Add or Update the Fstab File
    • Image Description Encrypted Disk
    • 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
    • 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
  • Contributing
    • Using KIWI NG in a Python Project
    • Plugin Architecture
      • Naming Conventions
      • Example Plugin
    • 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
      • kiwi.cli Module
      • kiwi.command Module
      • kiwi.command_process Module
      • kiwi.defaults Module
      • kiwi.exceptions Module
      • kiwi.firmware Module
      • kiwi.help Module
      • kiwi.kiwi Module
      • kiwi.logger Module
      • kiwi.logger_color_formatter Module
      • kiwi.logger_filter Module
      • kiwi.mount_manager Module
      • kiwi.path Module
      • kiwi.privileges Module
      • kiwi.runtime_checker Module
      • kiwi.runtime_config Module
      • kiwi.version Module
      • kiwi.xml_description Module
      • kiwi.xml_state Module
      • Module Contents
    • kiwi.archive Package
      • Submodules
      • kiwi.archive.cpio Module
      • kiwi.archive.tar Module
      • Module Contents
    • kiwi.boot.image Package
      • Submodules
      • kiwi.boot.image.base Module
      • kiwi.boot.image.dracut Module
      • kiwi.boot.image.builtin_kiwi Module
      • Module Contents
    • kiwi.bootloader.config Package
      • Submodules
      • kiwi.bootloader.config.base Module
      • kiwi.bootloader.config.grub2 Module
      • kiwi.bootloader.config.isolinux Module
      • Module Contents
    • kiwi.bootloader.install Package
      • Submodules
      • kiwi.bootloader.install.base Module
      • kiwi.bootloader.install.grub2 Module
      • Module Contents
    • kiwi.bootloader Package
      • Module Contents
    • kiwi.bootloader.template Package
      • Submodules
      • kiwi.bootloader.template.grub2 Module
      • kiwi.bootloader.template.isolinux Module
      • Module Contents
    • kiwi.boot Package
      • Module Contents
    • kiwi.builder Package
      • Submodules
      • kiwi.builder.archive Module
      • kiwi.builder.container Module
      • kiwi.builder.disk Module
      • kiwi.builder.filesystem Module
      • kiwi.builder.install Module
      • kiwi.builder.live Module
      • kiwi.builder.kis Module
      • Module Contents
    • kiwi.container Package
      • Submodules
      • kiwi.container.oci Module
      • Module Contents
    • kiwi.container.setup Package
      • Submodules
      • kiwi.container.setup.base Module
      • kiwi.container.setup.docker Module
      • Module Contents
    • kiwi.filesystem Package
      • Submodules
      • kiwi.filesystem.base Module
      • kiwi.filesystem.btrfs Module
      • kiwi.filesystem.clicfs Module
      • kiwi.filesystem.ext2 Module
      • kiwi.filesystem.ext3 Module
      • kiwi.filesystem.ext4 Module
      • kiwi.filesystem.fat16 Module
      • kiwi.filesystem.fat32 Module
      • kiwi.filesystem.isofs Module
      • kiwi.filesystem.setup Module
      • kiwi.filesystem.squashfs Module
      • kiwi.filesystem.xfs Module
      • Module Contents
    • kiwi.iso_tools Package
      • Submodules
      • kiwi.iso_tools.base Module
      • kiwi.iso_tools.cdrtools Module
      • kiwi.iso_tools.iso Module
      • Module Contents
    • kiwi.package_manager Package
      • Submodules
      • kiwi.package_manager.base Module
      • kiwi.package_manager.dnf Module
      • kiwi.package_manager.zypper Module
      • Module Contents
    • kiwi.partitioner Package
      • Submodules
      • kiwi.partitioner.base Module
      • kiwi.partitioner.dasd Module
      • kiwi.partitioner.gpt Module
      • kiwi.partitioner.msdos Module
      • Module Contents
    • kiwi.repository Package
      • Submodules
      • kiwi.repository.base Module
      • kiwi.repository.dnf Module
      • kiwi.repository.zypper Module
      • Module Contents
    • kiwi.repository.template Package
      • Submodules
      • kiwi.repository.template.apt Module
      • Module Contents
    • kiwi.solver.repository Package
      • Submodules
      • kiwi.solver.repository.base Module
      • Module Contents
    • kiwi.solver Package
      • Submodules
      • kiwi.solver.sat Module
      • Module Contents
    • kiwi.storage Package
      • Submodules
      • kiwi.storage.device_provider Module
      • kiwi.storage.disk Module
      • kiwi.storage.loop_device Module
      • kiwi.storage.luks_device Module
      • kiwi.storage.mapped_device Module
      • kiwi.storage.raid_device Module
      • kiwi.storage.setup Module
      • Module Contents
    • kiwi.storage.subformat Package
      • Submodules
      • kiwi.storage.subformat.base Module
      • kiwi.storage.subformat.gce Module
      • kiwi.storage.subformat.ova Module
      • kiwi.storage.subformat.qcow2 Module
      • kiwi.storage.subformat.vagrant_base Module
      • kiwi.storage.subformat.vagrant_libvirt Module
      • kiwi.storage.subformat.vagrant_virtualbox Module
      • kiwi.storage.subformat.vdi Module
      • kiwi.storage.subformat.vhd Module
      • kiwi.storage.subformat.vhdfixed Module
      • kiwi.storage.subformat.vhdx Module
      • kiwi.storage.subformat.vmdk Module
      • Module Contents
    • kiwi.storage.subformat.template Package
      • Submodules
      • kiwi.storage.subformat.template.vmware_settings Module
      • kiwi.storage.subformat.template.vagrant_config Module
      • kiwi.storage.subformat.template.virtualbox_ovf Module
      • Module contents
    • kiwi.system Package
      • Submodules
      • kiwi.system.identifier Module
      • kiwi.system.kernel Module
      • kiwi.system.prepare Module
      • kiwi.system.profile Module
      • kiwi.system.result Module
      • kiwi.system.root_bind Module
      • kiwi.system.root_init Module
      • kiwi.system.setup Module
      • kiwi.system.shell Module
      • kiwi.system.size Module
      • kiwi.system.uri Module
      • kiwi.system.users Module
      • Module Contents
    • kiwi.tasks package
      • Submodules
      • kiwi.tasks.base Module
      • kiwi.tasks.result_bundle Module
      • kiwi.tasks.result_list Module
      • kiwi.tasks.system_build Module
      • kiwi.tasks.system_create Module
      • kiwi.tasks.system_prepare Module
      • kiwi.tasks.system_update Module
      • Module Contents
    • kiwi.utils Package
      • Submodules
      • kiwi.utils.checksum Module
      • kiwi.utils.block Module
      • kiwi.utils.compress Module
      • kiwi.utils.sync Module
      • kiwi.utils.sysconfig Module
      • Module Contents
    • kiwi.volume_manager Package
      • Submodules
      • kiwi.volume_manager.base Module
      • kiwi.volume_manager.btrfs Module
      • kiwi.volume_manager.lvm Module
      • Module Contents
KIWI NG
  • »
  • Python API
  • View page source

Python API¶

Note

This API documentation covers KIWI NG 9.23.5

  • kiwi Package
  • kiwi.archive Package
  • kiwi.boot.image Package
  • kiwi.bootloader.config Package
  • kiwi.bootloader.install Package
  • kiwi.bootloader Package
  • kiwi.bootloader.template Package
  • kiwi.boot Package
  • kiwi.builder Package
  • kiwi.container Package
  • kiwi.container.setup Package
  • kiwi.filesystem Package
  • kiwi.iso_tools Package
  • kiwi.package_manager Package
  • kiwi.partitioner Package
  • kiwi.repository Package
  • kiwi.repository.template Package
  • kiwi.solver.repository Package
  • kiwi.solver Package
  • kiwi.storage Package
  • kiwi.storage.subformat Package
  • kiwi.storage.subformat.template Package
  • kiwi.system Package
  • kiwi.tasks package
  • kiwi.utils Package
  • kiwi.volume_manager Package
Next Previous

© Copyright 2020, Marcus Schäfer.

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