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 [--temp-dir=<directory>]
14 [--type=<build_type>]
15 [--logfile=<filename>]
16 [--logsocket=<socketfile>]
17 [--loglevel=<number>]
18 [--debug]
19 [--debug-run-scripts-in-screen]
20 [--color-output]
21 [--config=<configfile>]
22 [--kiwi-file=<kiwifile>]
23 image <command> [<args>...]
24 kiwi-ng [--logfile=<filename>]
25 [--logsocket=<socketfile>]
26 [--loglevel=<number>]
27 [--debug]
28 [--debug-run-scripts-in-screen]
29 [--color-output]
30 [--config=<configfile>]
31 result <command> [<args>...]
32 kiwi-ng [--profile=<name>...]
33 [--shared-cache-dir=<directory>]
34 [--temp-dir=<directory>]
35 [--target-arch=<name>]
36 [--type=<build_type>]
37 [--logfile=<filename>]
38 [--logsocket=<socketfile>]
39 [--loglevel=<number>]
40 [--debug]
41 [--debug-run-scripts-in-screen]
42 [--color-output]
43 [--config=<configfile>]
44 [--kiwi-file=<kiwifile>]
45 system <command> [<args>...]
46 kiwi-ng compat <legacy_args>...
47 kiwi-ng -v | --version
48 kiwi-ng help
49
51 KIWI NG is an imaging solution that is based on an image XML descrip‐
52 tion. Such a description is represented by a directory which includes
53 at least one config.xml or .kiwi file and may as well include other
54 files like scripts or configuration data.
55 A collection of example image descriptions can be found on the github
57 repository here: https://github.com/OSInside/kiwi-descriptions. Most of
58 the descriptions provide a so called appliance image. Appliance means
59 that it's a small, text only based image including a predefined remote
60 source setup to allow installation of missing software components at a
61 later point in time.
62 KIWI NG operates in two steps. The system build command combines both
64 steps into one to make it easier to start with KIWI NG. The first step
65 is the preparation step and if that step was successful, a creation
66 step follows which is able to create different image output types.
67 In the preparation step, you prepare a directory including the contents
69 of your new filesystem based on one or more software package source(s)
70 The creation step is based on the result of the preparation step and
71 uses the contents of the new image root tree to create the output im‐
72 age.
73 KIWI NG supports the creation of the following image types:
75 • ISO Live Systems
77 • Virtual Disk for e.g cloud frameworks
79 • OEM Expandable Disk for system deployment from ISO or the network
81 • File system images for deployment in a pxe boot environment
83 Depending on the image type a variety of different disk formats and ar‐
85 chitectures are supported.
86
88 --color-output
89 Use Escape Sequences to print different types of information in
90 colored output. The underlaying terminal has to understand those
91 escape characters. Error messages appear red, warning messages
92 yellow and debugging information will be printed light grey.
93 --config=<configfile>
95 Use specified runtime configuration file. If not specified the
96 runtime configuration is looked up at ~/.config/kiwi/config.yml
97 or /etc/kiwi.yml
98 --debug
100 Print debug information on the commandline. Same as: '--loglevel
101 10'
102 --debug-run-scripts-in-screen
104 Run scripts called by kiwi in a screen session.
105 --logfile=<filename>
107 Specify log file. The logfile contains detailed information
108 about the process. The special call: --logfile stdout sends all
109 information to standard out instead of writing to a file
110 --logsocket=<socketfile>
112 send log data to the given Unix Domain socket in the same format
113 as with --logfile
114 --loglevel=<number>
116 specify logging level as number. Details about the available log
117 levels can be found at:
118 https://docs.python.org/3/library/logging.html#logging-levels
119 Setting a log level causes all message >= level to be displayed.
120 ----------------------------
122 | Level | Numeric value |
123 ----------------------------
124 | CRITICAL | 50 |
125 | ERROR | 40 |
126 | WARNING | 30 |
127 | INFO | 20 |
128 | DEBUG | 10 |
129 | NOTSET | 0 |
130 ----------------------------
131 --profile=<name>
133 Select profile to use. The specified profile must be part of the
134 XML description. The option can be specified multiple times to
135 allow using a combination of profiles.
136 --shared-cache-dir=<directory>
138 Specify an alternative shared cache directory. The directory is
139 shared via bind mount between the build host and image root sys‐
140 tem and contains information about package repositories and
141 their cache and meta data. The default location is set to
142 /var/cache/kiwi.
143 --temp-dir=<directory>
145 Specify an alternative base temporary directory. The provided
146 path is used as base directory to store temporary files and di‐
147 rectories. By default /var/tmp is used.
148 --target-arch=<name>
150 Specify the image architecture. By default the host architecture
151 is used as the image architecture. If the specified architecture
152 name does not match the host architecture and is therefore re‐
153 questing a cross architecture image build, it's important to un‐
154 derstand that for this process to work a preparatory step to
155 support the image architecture and binary format on the building
156 host is required and not a responsibility of KIWI NG.
157 --type=<build_type>
159 Select image build type. The specified build type must be con‐
160 figured as part of the XML description.
161 --kiwi-file=<kiwifile>
163 Basename of kiwi file which contains the main image configura‐
164 tion elements. If not specified kiwi searches for a file named
165 config.xml or a file matching *.kiwi
166 --version
168 Show program version
169
171 $ git clone https://github.com/OSInside/kiwi
172 $ sudo kiwi-ng system build \
174 --description kiwi/build-tests/x86/leap/test-image-disk \
175 --set-repo obs://openSUSE:Leap:15.3/standard \
176 --target-dir /tmp/myimage
177
179 Marcus Schäfer
180
182 2023, Marcus Schäfer
1839.25.16 Oct 16, 2023 KIWI(8)