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