KIWI NG Documentation
GitHub
KIWI NG 11.1.16
  • Overview
    • Components of an Image Description
    • Basic Workflow
    • Concepts
    • Terminology
  • Installation
    • Installation from OBS
    • Installation from Distribution Repositories
  • Quick Start
    • Before you start
    • Choose a First Image
    • Build your First Image
    • Run your Image
    • Tweak and Customize your Image
  • Building Images
    • The Build Process
      • The Prepare Step
      • The Create Step
    • Build Results
      • Image Types
      • Further Result Files
      • Bundling Results
    • Setting up the Build Host
      • Host Requirements
      • The Runtime Configuration File
    • Repositories
      • Repository Paths
    • Packages
      • The package element
      • The archive element
      • The namedCollection and product elements
      • Removing Packages
    • Users
    • Profiles
    • Scripts
      • Script Template
      • Functions and Variables Provided by KIWI NG
      • Debugging Scripts
      • Configuration Tips
    • Customizing the Boot Process
      • Boot Image Hook-Scripts
      • Boot Image Parameters
      • Boot Debugging
  • Working from the Command Line
    • kiwi-ng
      • Usage
      • Global Options
      • Example
    • kiwi-ng system build
      • Usage
      • Options
      • Example
    • kiwi-ng system prepare
      • Usage
      • Options
      • Example
    • kiwi-ng system create
      • Usage
      • Options
      • Example
    • kiwi-ng system update
      • Usage
      • Options
      • Example
    • kiwi-ng system boxbuild
      • Usage
      • Options
      • Environment
      • Example
    • kiwi-ng system stash
      • Usage
      • Options
      • Example
    • kiwi-ng system stackbuild
      • Usage
      • Options
      • Example
    • kiwi-ng result list
      • Usage
      • Options
      • Example
    • kiwi-ng result bundle
      • Usage
      • Options
      • Example
    • kiwi-ng image info
      • Usage
      • Options
      • Example
    • kiwi-ng image resize
      • Usage
      • Options
      • Example
    • Getting Help
    • Writing Options
  • Image Description
    • Schema Reference
      • <image>
      • <include>
      • <description>
      • <certificates>
      • <preferences>
      • <containers>
      • <containers><container>
      • <repository>
      • <packages>
      • <users>
      • <drivers>
      • <strip>
      • <extension>
      • <profiles>
    • Description Directory Layout
    • Minimal Example
    • Top-Level Schema Layout
    • What to Configure First
    • Common Patterns
    • Complete Schema Reference
  • Alternative Build Methods
    • Building in a Self-Contained Environment
      • Requirements
      • Building with the boxbuild command
      • Sharing Backends
      • Building in Container
    • Building with kiwi-boxbuild
      • Overview
      • Requirements
      • Building with the kiwi-boxbuild command
      • Supported boxbuild options
      • Sharing a host path with the box
      • Using a custom boxes configuration
      • Configuring the runtime container
      • Building on Windows 11
    • Building based on Containers
      • Requirements
      • Concept
      • Create a stash
      • Rebuild from a stash
      • Turn a container into a VM image
  • Examples
    • 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
    • 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
    • Deploy ISO Image on a USB Stick
    • Deploy ISO Image as a File on a FAT32 Formatted USB Stick
    • Booting Live ISO Images from Grub2
      • Booting Install 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 for an Encrypted Disk
    • Deploy and Run a 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 Filesystem Image for the legacy netboot infrastructure
      • PXE Client Setup Configuration
    • Booting a Root Filesystem from Network
    • Booting a Live ISO Image from Network
      • Available Remote Boot Options
      • Persistent Live System
    • 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
    • Using SUSE Product ISO To Build
    • Circumvent Debian Bootstrap
      • How to Create a bootstrap_package
    • Building Build Tests
  • Troubleshooting
    • Build Host Constraints
      • Package Manager Behavior
    • Architectures
    • Host Security Settings Conflicts with KIWI
    • Incompatible Filesystem Settings on Host vs. Image
    • Boxbuild Tweaks
      • Increase Box Build Image Size
  • 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
    • 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
    • Coding Style
    • Documentation
    • Bumping the Version
    • AI policy
    • Creating an RPM Package
KIWI NG
  • Search


© Copyright 2020-2026, Marcus Schäfer.

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