1KIWI::SYSTEM::BUILD(8)              KIWI NG             KIWI::SYSTEM::BUILD(8)
2
3
4

NAME

6       kiwi::system::build - Build image in combined prepare and create step
7

SYNOPSIS

9          kiwi-ng [global options] service <command> [<args>]
10
11          kiwi-ng system build -h | --help
12          kiwi-ng system build --description=<directory> --target-dir=<directory>
13              [--allow-existing-root]
14              [--clear-cache]
15              [--ignore-repos]
16              [--ignore-repos-used-for-build]
17              [--set-repo=<source,type,alias,priority,imageinclude,package_gpgcheck>]
18              [--add-repo=<source,type,alias,priority,imageinclude,package_gpgcheck>...]
19              [--add-package=<name>...]
20              [--add-bootstrap-package=<name>...]
21              [--delete-package=<name>...]
22              [--signing-key=<key-file>...]
23          kiwi-ng system build help
24

DESCRIPTION

26       build  an  image in one step. The build command combines kiwi's prepare
27       and create steps in order to build an image with just one command call.
28       The  build  command creates the root directory of the image below <tar‐
29       get-dir>/build/image-root and if not specified differently writes a log
30       file <target-dir>/build/image-root.log. The result image files are cre‐
31       ated in the specified target-dir.
32

OPTIONS

34       --add-bootstrap-package=<name>
35              specify package to install as part of the early  kiwi  bootstrap
36              phase.  The option can be specified multiple times
37
38       --add-package=<name>
39              specify  package  to  add(install).  The option can be specified
40              multiple times
41
42       --add-repo=<source,type,alias,priority,imageinclude,package_gpgcheck>
43              Add a new repository to the existing repository setup in the XML
44              description.  This  option can be specified multiple times.  For
45              details about the provided  option  values  see  the  --set-repo
46              information below
47
48       --allow-existing-root
49              Allow  to  use  an existing root directory from an earlier build
50              attempt. Use with caution this could cause an inconsistent  root
51              tree  if  the existing contents does not fit to the former image
52              type setup
53
54       --clear-cache
55              delete repository cache for each of the used repositories before
56              installing  any package. This is useful if an image build should
57              take and validate the signature of the package from the original
58              repository  source for any build. Some package managers uncondi‐
59              tionally trust the contents of the cache, which is ok for  cache
60              data  dedicated  to  one  build but in case of kiwi the cache is
61              shared between multiple image builds on that  host  for  perfor‐
62              mance reasons.
63
64       --delete-package=<name>
65              specify  package to delete. The option can be specified multiple
66              times
67
68       --description=<directory>
69              Path to the XML description. This is a directory  containing  at
70              least one _config.xml_ or _*.kiwi_ XML file.
71
72       --ignore-repos
73              Ignore  all  repository configurations from the XML description.
74              Using that option is usally done with a sequence  of  --add-repo
75              options  otherwise  there  are no repositories available for the
76              image build which would lead to an error.
77
78       --ignore-repos-used-for-build
79              Works the same way as --ignore-repos except that repository con‐
80              figurations  which  has the imageonly attribute set to true will
81              not be ignored.
82
83       --set-repo=<source,type,alias,priority,imageinclude,package_gpgcheck>
84              Overwrite the first repository entry in the XML description with
85              the provided information:
86
87              · source
88
89                source  url, pointing to a package repository which must be in
90                a format supported by the selected package  manager.  See  the
91                URI_TYPES section for details about the supported source loca‐
92                tors.
93
94              · type
95
96                repository type, could be one of rpm-md, rpm-dir or yast2.
97
98              · alias
99
100                An alias name for the repository. If not specified kiwi calcu‐
101                lates  an  alias name as result from a sha sum. The sha sum is
102                used to uniquely identify the repository, but not very expres‐
103                sive. We recommend to set an expressive and uniq alias name.
104
105              · priority
106
107                A  number indicating the repository priority. How the value is
108                evaluated depends on  the  selected  package  manager.  Please
109                refer  to  the package manager documentation for details about
110                the supported priority ranges and their meaning.
111
112              · imageinclude
113
114                Set to either true or false  to  specify  if  this  repository
115                should be part of the system image repository setup or not.
116
117              · package_gpgcheck
118
119                Set  to  either  true  or  false to specify if this repository
120                should validate the package signatures.
121
122       --signing-key=<key-file>
123              set the key file to be trusted and  imported  into  the  package
124              manager database before performing any opertaion. This is useful
125              if an image build should take and validate repository and  pack‐
126              age  signatures  during build time. This option can be specified
127              multiple times
128
129       --target-dir=<directory>
130              Path to store the build results.
131

URI_TYPES

133       · http:// | https:// | ftp://
134
135         remote repository delivered via http or ftp protocol.
136
137       · obs://
138
139         Open Buildservice repository. The source data is translated  into  an
140         http url pointing to http://download.opensuse.org.
141
142       · ibs://
143
144         Internal  Open Buildservice repository. The source data is translated
145         into an http url pointing to download.suse.de.
146
147       · iso://
148
149         Local iso file. kiwi loop mounts the file and uses the mount point as
150         temporary directory source type
151
152       · dir://
153
154         Local directory
155

AUTHOR

157       Marcus Schäfer
158
160       2020, Marcus Schäfer
161
162
163
164
1659.20.5                           Mar 27, 2020           KIWI::SYSTEM::BUILD(8)
Impressum