1KIWI(8)                             KIWI NG                            KIWI(8)
2
3
4

NAME

6       kiwi - Creating Operating System Images
7

SYNOPSIS

9          kiwi-ng [global options] service <command> [<args>]
10
11          kiwi-ng -h | --help
12          kiwi-ng [--profile=<name>...]
13                  [--type=<build_type>]
14                  [--logfile=<filename>]
15                  [--debug]
16                  [--color-output]
17                  [--config=<configfile>]
18              image <command> [<args>...]
19          kiwi-ng [--debug]
20                  [--color-output]
21                  [--config=<configfile>]
22              result <command> [<args>...]
23          kiwi-ng [--profile=<name>...]
24                  [--shared-cache-dir=<directory>]
25                  [--type=<build_type>]
26                  [--logfile=<filename>]
27                  [--debug]
28                  [--color-output]
29                  [--config=<configfile>]
30              system <command> [<args>...]
31          kiwi-ng compat <legacy_args>...
32          kiwi-ng -v | --version
33          kiwi-ng help
34

DESCRIPTION

36       KIWI  NG  is an imaging solution that is based on an image XML descrip‐
37       tion.  Such a description is represented by a directory which  includes
38       at  least  one  config.xml  or .kiwi file and may as well include other
39       files like scripts or configuration data.
40
41       A collection of example image descriptions can be found on  the  github
42       repository here: https://github.com/OSInside/kiwi-descriptions. Most of
43       the descriptions provide a so called appliance image.  Appliance  means
44       that  it's a small, text only based image including a predefined remote
45       source setup to allow installation of missing software components at  a
46       later point in time.
47
48       KIWI  NG  operates in two steps. The system build command combines both
49       steps into one to make it easier to start with KIWI NG. The first  step
50       is  the  preparation  step  and if that step was successful, a creation
51       step follows which is able to create different image output types.
52
53       In the preparation step, you prepare a directory including the contents
54       of  your new filesystem based on one or more software package source(s)
55       The creation step is based on the result of the  preparation  step  and
56       uses  the  contents  of  the  new  image root tree to create the output
57       image.
58
59       KIWI NG supports the creation of the following image types:
60
61       · ISO Live Systems
62
63       · Virtual Disk for e.g cloud frameworks
64
65       · OEM Expandable Disk for system deployment from ISO or the network
66
67       · File system images for deployment in a pxe boot environment
68
69       Depending on the image type a variety of  different  disk  formats  and
70       architectures are supported.
71

GLOBAL OPTIONS

73       --color-output
74              Use  Escape Sequences to print different types of information in
75              colored output. The underlaying terminal has to understand those
76              escape  characters.  Error messages appear red, warning messages
77              yellow and debugging information will be printed light grey.
78
79       --config=<configfile>
80              Use specified runtime configuration file. If not  specified  the
81              runtime  configuration is looked up at ~/.config/kiwi/config.yml
82              or /etc/kiwi.yml
83
84       --debug
85              Print debug information on the commandline.
86
87       --logfile=<filename>
88              Specify log file.  the  logfile  contains  detailed  information
89              about the process.
90
91       --profile=<name>
92              Select profile to use. The specified profile must be part of the
93              XML description. The option can be specified multiple  times  to
94              allow using a combination of profiles
95
96       --shared-cache-dir=<directory>
97              Specify  an alternative shared cache directory. The directory is
98              shared via bind mount between the build host and image root sys‐
99              tem  and  contains  information  about  package repositories and
100              their cache and meta  data.  The  default  location  is  set  to
101              /var/cache/kiwi
102
103       --type=<build_type>
104              Select  image  build type. The specified build type must be con‐
105              figured as part of the XML description.
106
107       --version
108              Show program version
109

EXAMPLE

111          $ git clone https://github.com/OSInside/kiwi-descriptions
112
113          $ kiwi --type oem system build \
114              --description kiwi-descriptions/suse/x86_64/suse-leap-15.1 \
115              --target-dir /tmp/myimage
116

COMPATIBILITY

118       This version of KIWI NG uses a different caller syntax compared to for‐
119       mer versions. However there is a compatibility mode which allows to use
120       a legacy KIWI NG commandline as follows:
121
122          $ kiwi compat \
123              --build kiwi-descriptions/suse/x86_64/suse-leap-15.1 \
124              --type oem -d /tmp/myimage
125

AUTHOR

127       Marcus Schäfer
128

130       2020, Marcus Schäfer
131
132
133
134
1359.23.22                          Mar 22, 2021                          KIWI(8)
Impressum