Jump to contentJump to page navigation: previous page [access key p]/next page [access key n]
Navigation

KIWI NG Documentation

Publication Date: 09/24/2021
Preface
The Appliance Concept
Use Cases
Contact
1 Overview
1.1 Basic Workflow
1.2 Conceptual Overview
1.3 Terminology
1.4 System Requirements
2 Installation
2.1 Installation from OBS
2.2 Installation from Distribution Repositories
2.3 Example Appliance Descriptions
3 Quick Start
3.1 Before you start
3.2 Choose a First Image
3.3 Build your First Image
3.4 Run your Image
3.5 Tweak and Customize your Image
4 Working from the Command Line
4.1 kiwi-ng
4.2 kiwi-ng result list
4.3 kiwi-ng result bundle
4.4 kiwi-ng system prepare
4.5 kiwi-ng system update
4.6 kiwi-ng system build
4.7 kiwi-ng system create
4.8 kiwi-ng image resize
4.9 kiwi-ng image info
5 Troubleshooting
5.1 Incompatible Filesystem Settings on Host vs. Image
5.2 Build Host Constraints
5.3 Architectures
6 Building in a Self-Contained Environment
6.1 Requirements
6.2 Building with the boxbuild command
7 Concept and Workflow
7.1 Host Requirements To Build Images
7.2 Setting up Repositories
7.3 Adding and Removing Packages
7.4 Image Profiles
7.5 Adding Users
7.6 User Defined Scripts
7.7 The Runtime Configuration File
7.8 Customizing the Boot Process
7.9 Overview
7.10 Image Building Process
8 Image Description
8.1 Image Description Elements
8.2 Main Root
8.3 Image Identity
8.4 Image Preferences
8.5 Image Software Sources
8.6 Image Content Setup
8.7 Image Users
8.8 Image Namespace
9 Image Types
9.1 Image Results
10 Building Images for Supported Types
10.1 Build an ISO Hybrid Live Image
10.2 Build a Virtual Disk Image
10.3 Build an Expandable Disk Image
10.4 Build a Docker Container Image
10.5 Build a WSL Container Image
10.6 Build KIS Image (Kernel, Initrd, System)
11 Working with Images
11.1 Deploy ISO Image on an USB Stick
11.2 Deploy ISO Image as File on a FAT32 Formated USB Stick
11.3 Booting a Live ISO Images from Grub2
11.4 Image Description for Amazon EC2
11.5 Image Description for Microsoft Azure
11.6 Image Description for Google Compute Engine
11.7 Image Description for Vagrant
11.8 Image Description Encrypted Disk
11.9 Deploy and Run System in a RamDisk
11.10 Custom Disk Partitions
11.11 Custom Disk Volumes
11.12 Setting Up a Network Boot Server
11.13 Build PXE Root File System Image for the legacy netboot infrastructure
11.14 Booting a Root Filesystem from Network
11.15 Booting a Live ISO Image from Network
11.16 Setting Up YaST at First Boot
11.17 Add or Update the Fstab File
11.18 Building Images with Profiles
11.19 Building in the Open Build Service
11.20 Using SUSE Product ISO To Build
12 Contributing
12.1 Using KIWI NG in a Python Project
12.2 Plugin Architecture
12.3 Write Integration Tests for the Scripts
12.4 Extending KIWI NG with Custom Operations
12.5 The Basics
12.6 Fork the upstream repository
12.7 Create a local clone of the forked repository
12.8 Install Required Operating System Packages
12.9 Create a Python Virtual Development Environment
12.10 Running the Unit Tests
12.11 Create a Branch for each Feature or Bugfix
12.12 Coding Style
12.13 Additional Information
13 Python API
13.1 kiwi Package
13.2 kiwi.archive Package
13.3 kiwi.boot.image Package
13.4 kiwi.bootloader.config Package
13.5 kiwi.bootloader.install Package
13.6 kiwi.bootloader Package
13.7 kiwi.bootloader.template Package
13.8 kiwi.boot Package
13.9 kiwi.builder Package
13.10 kiwi.container Package
13.11 kiwi.container.setup Package
13.12 kiwi.filesystem Package
13.13 kiwi.iso_tools Package
13.14 kiwi.package_manager Package
13.15 kiwi.partitioner Package
13.16 kiwi.repository Package
13.17 kiwi.repository.template Package
13.18 kiwi.solver.repository Package
13.19 kiwi.solver Package
13.20 kiwi.storage Package
13.21 kiwi.storage.subformat Package
13.22 kiwi.storage.subformat.template Package
13.23 kiwi.system Package
13.24 kiwi.tasks package
13.25 kiwi.utils Package
13.26 kiwi.volume_manager Package
Print this page