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

NAME

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

SYNOPSIS

9          kiwi [global options] service <command> [<args>]
10
11          kiwi system build -h | --help
12          kiwi 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              [--delete-package=<name>...]
21              [--signing-key=<key-file>...]
22          kiwi system build help
23

DESCRIPTION

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

OPTIONS

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

URI_TYPES

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

AUTHOR

152       Marcus Schäfer
153
155       2016, Marcus Schäfer
156
157
158
159
1609.17.38                          Apr 22, 2019           KIWI::SYSTEM::BUILD(8)
Impressum