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                  [--target-arch=<name>]
26                  [--type=<build_type>]
27                  [--logfile=<filename>]
28                  [--debug]
29                  [--color-output]
30                  [--config=<configfile>]
31              system <command> [<args>...]
32          kiwi-ng compat <legacy_args>...
33          kiwi-ng -v | --version
34          kiwi-ng help
35

DESCRIPTION

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

GLOBAL OPTIONS

74       --color-output
75              Use  Escape Sequences to print different types of information in
76              colored output. The underlaying terminal has to understand those
77              escape  characters.  Error messages appear red, warning messages
78              yellow and debugging information will be printed light grey.
79
80       --config=<configfile>
81              Use specified runtime configuration file. If not  specified  the
82              runtime  configuration is looked up at ~/.config/kiwi/config.yml
83              or /etc/kiwi.yml
84
85       --debug
86              Print debug information on the commandline.
87
88       --logfile=<filename>
89              Specify log file.  the  logfile  contains  detailed  information
90              about the process.
91
92       --profile=<name>
93              Select profile to use. The specified profile must be part of the
94              XML description. The option can be specified multiple  times  to
95              allow using a combination of profiles
96
97       --shared-cache-dir=<directory>
98              Specify  an alternative shared cache directory. The directory is
99              shared via bind mount between the build host and image root sys‐
100              tem  and  contains  information  about  package repositories and
101              their cache and meta  data.  The  default  location  is  set  to
102              /var/cache/kiwi
103
104       --target-arch=<name>
105              Specify the image architecture. By default the host architecture
106              is used as the image architecture. If the specified architecture
107              name  does  not match the host architecture and is therefore re‐
108              questing a cross architecture image build, it's important to un‐
109              derstand  that  for  this  process to work a preparatory step to
110              support the image architecture and binary format on the building
111              host is required and not a responsibility of KIWI NG.
112
113       --type=<build_type>
114              Select  image  build type. The specified build type must be con‐
115              figured as part of the XML description.
116
117       --version
118              Show program version
119

EXAMPLE

121          $ git clone https://github.com/OSInside/kiwi
122
123          $ sudo kiwi-ng system build \
124              --description kiwi/build-tests/x86/leap/test-image-disk \
125              --set-repo obs://openSUSE:Leap:15.3/standard \
126              --target-dir /tmp/myimage
127

AUTHOR

129       Marcus Schäfer
130

COPYRIGHT

132       2020, Marcus Schäfer
133
134
135
136
1379.23.34                          May 21, 2021                          KIWI(8)