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