1KIWI(8) KIWI NG KIWI(8)
2
6 kiwi - Creating Operating System Images
7
9 kiwi-ng [global options] service <command> [<args>]
10 kiwi-ng -h | --help
12 kiwi-ng [--profile=<name>...]
13 [--type=<build_type>]
14 [--logfile=<filename>]
15 [--debug]
16 [--color-output]
17 image <command> [<args>...]
18 kiwi-ng [--debug]
19 [--color-output]
20 result <command> [<args>...]
21 kiwi-ng [--profile=<name>...]
22 [--shared-cache-dir=<directory>]
23 [--type=<build_type>]
24 [--logfile=<filename>]
25 [--debug]
26 [--color-output]
27 system <command> [<args>...]
28 kiwi-ng compat <legacy_args>...
29 kiwi-ng -v | --version
30 kiwi-ng help
31
33 KIWI NG is an imaging solution that is based on an image XML descrip‐
34 tion. Such a description is represented by a directory which includes
35 at least one config.xml or .kiwi file and may as well include other
36 files like scripts or configuration data.
37 A collection of example image descriptions can be found on the github
39 repository here: https://github.com/OSInside/kiwi-descriptions. Most of
40 the descriptions provide a so called JeOS image. JeOS means Just enough
41 Operating System. A JeOS is a small, text only based image including a
42 predefined remote source setup to allow installation of missing soft‐
43 ware components at a later point in time.
44 KIWI NG operates in two steps. The system build command combines both
46 steps into one to make it easier to start with KIWI NG. The first step
47 is the preparation step and if that step was successful, a creation
48 step follows which is able to create different image output types.
49 In the preparation step, you prepare a directory including the contents
51 of your new filesystem based on one or more software package source(s)
52 The creation step is based on the result of the preparation step and
53 uses the contents of the new image root tree to create the output
54 image.
55 KIWI NG supports the creation of the following image types:
57 · ISO Live Systems
59 · Virtual Disk for e.g cloud frameworks
61 · OEM Expandable Disk for system deployment from ISO or the network
63 · File system images for deployment in a pxe boot environment
65 Depending on the image type a variety of different disk formats and
67 architectures are supported.
68
70 --color-output
71 Use Escape Sequences to print different types of information in
72 colored output. The underlaying terminal has to understand those
73 escape characters. Error messages appear red, warning messages
74 yellow and debugging information will be printed light grey.
75 --debug
77 Print debug information on the commandline.
78 --logfile=<filename>
80 Specify log file. the logfile contains detailed information
81 about the process.
82 --profile=<name>
84 Select profile to use. The specified profile must be part of the
85 XML description. The option can be specified multiple times to
86 allow using a combination of profiles
87 --shared-cache-dir=<directory>
89 Specify an alternative shared cache directory. The directory is
90 shared via bind mount between the build host and image root sys‐
91 tem and contains information about package repositories and
92 their cache and meta data. The default location is set to
93 /var/cache/kiwi
94 --type=<build_type>
96 Select image build type. The specified build type must be con‐
97 figured as part of the XML description.
98 --version
100 Show program version
101
103 $ git clone https://github.com/OSInside/kiwi-descriptions
104 $ kiwi --type vmx system build \
106 --description kiwi-descriptions/suse/x86_64/suse-leap-15.1-JeOS \
107 --target-dir /tmp/myimage
108
110 This version of KIWI NG uses a different caller syntax compared to for‐
111 mer versions. However there is a compatibility mode which allows to use
112 a legacy KIWI NG commandline as follows:
113 $ kiwi compat \
115 --build kiwi-descriptions/suse/x86_64/suse-leap-15.1-JeOS \
116 --type vmx -d /tmp/myimage
117
119 Marcus Schäfer
120
122 2020, Marcus Schäfer
1239.20.5 Mar 27, 2020 KIWI(8)