Quick Start

Hint

Abstract

This document describes how to start working with KIWI, an OS appliance builder. This description applies for version 9.18.25.

Before you start

  1. Install KIWI first, either via your distributions’ package manager (see Installation) or via:

    $ pip install kiwi
    
  2. Clone the repository containing example appliances (see Example Appliance Descriptions):

    $ git clone https://github.com/OSInside/kiwi-descriptions
    

Choose a First Image

Take a look which images are available in the example appliances repository and select one that matches your desired image as close as possible. Or just use the one given in the examples below.

Build your First Image

Your first image will be a simple system disk image which can run in any full virtualization system like QEMU. Invoke the following KIWI command in order to build it:

$ sudo kiwi-ng --type vmx system build \
    --description kiwi-descriptions/suse/x86_64/suse-leap-15.1-JeOS \
    --target-dir /tmp/myimage

The resulting image will be placed into the folder /tmp/myimage with the suffix .raw.

If you don’t wish to create a openSUSE Leap 15.1 image, substitute the folder following the --description option with another folder that contains the image description which you selected.

Run your Image

Running an image actually means booting the operating system. In order to do that attach the disk image to a virtual system. In this example we use QEMU and boot it as follows:

$ qemu -boot c \
    -drive file=LimeJeOS-Leap-15.1.x86_64-1.15.1.raw,format=raw,if=virtio \
    -m 4096

Tweak and Customize your Image

Now that you have successfully built and started your first image, you can start tweaking it to match your needs.

Find the documentation of the appliance description files in the following sections.