1KIWI::SYSTEM::BUILD(8) KIWI NG KIWI::SYSTEM::BUILD(8)
2
6 kiwi::system::build - Build image in combined prepare and create step
7
9 kiwi-ng [global options] service <command> [<args>]
10 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 [--set-container-derived-from=<uri>]
23 [--set-container-tag=<name>]
24 [--add-container-label=<label>...]
25 [--signing-key=<key-file>...]
26 kiwi-ng system build help
27
29 build an image in one step. The build command combines kiwi's prepare
30 and create steps in order to build an image with just one command call.
31 The build command creates the root directory of the image below <tar‐
32 get-dir>/build/image-root and if not specified differently writes a log
33 file <target-dir>/build/image-root.log. The result image files are cre‐
34 ated in the specified target-dir.
35
37 --add-bootstrap-package=<name>
38 specify package to install as part of the early kiwi bootstrap
39 phase. The option can be specified multiple times
40 --add-container-label=<name=value>
42 add a container label in the container configuration metadata.
43 It overwrites the label with the provided key-value pair in case
44 it was already defined in the XML description
45 --add-package=<name>
47 specify package to add(install). The option can be specified
48 multiple times
49 --add-repo=<source,type,alias,priority,imageinclude,package_gpgcheck>
51 Add a new repository to the existing repository setup in the XML
52 description. This option can be specified multiple times. For
53 details about the provided option values see the --set-repo in‐
54 formation below
55 --allow-existing-root
57 Allow to use an existing root directory from an earlier build
58 attempt. Use with caution this could cause an inconsistent root
59 tree if the existing contents does not fit to the former image
60 type setup
61 --clear-cache
63 delete repository cache for each of the used repositories before
64 installing any package. This is useful if an image build should
65 take and validate the signature of the package from the original
66 repository source for any build. Some package managers uncondi‐
67 tionally trust the contents of the cache, which is ok for cache
68 data dedicated to one build but in case of kiwi the cache is
69 shared between multiple image builds on that host for perfor‐
70 mance reasons.
71 --delete-package=<name>
73 specify package to delete. The option can be specified multiple
74 times
75 --description=<directory>
77 Path to the XML description. This is a directory containing at
78 least one _config.xml_ or _*.kiwi_ XML file.
79 --ignore-repos
81 Ignore all repository configurations from the XML description.
82 Using that option is usally done with a sequence of --add-repo
83 options otherwise there are no repositories available for the
84 image build which would lead to an error.
85 --ignore-repos-used-for-build
87 Works the same way as --ignore-repos except that repository con‐
88 figurations which has the imageonly attribute set to true will
89 not be ignored.
90 --set-repo=<source,type,alias,priority,imageinclude,package_gpgcheck>
92 Overwrite the first repository entry in the XML description with
93 the provided information:
94 • source
96 source url, pointing to a package repository which must be in
98 a format supported by the selected package manager. See the
99 URI_TYPES section for details about the supported source loca‐
100 tors.
101 • type
103 repository type, could be one of rpm-md, rpm-dir or yast2.
105 • alias
107 An alias name for the repository. If not specified kiwi calcu‐
109 lates an alias name as result from a sha sum. The sha sum is
110 used to uniquely identify the repository, but not very expres‐
111 sive. We recommend to set an expressive and uniq alias name.
112 • priority
114 A number indicating the repository priority. How the value is
116 evaluated depends on the selected package manager. Please re‐
117 fer to the package manager documentation for details about the
118 supported priority ranges and their meaning.
119 • imageinclude
121 Set to either true or false to specify if this repository
123 should be part of the system image repository setup or not.
124 • package_gpgcheck
126 Set to either true or false to specify if this repository
128 should validate the package signatures.
129 --set-container-derived-from=<uri>
131 overwrite the source location of the base container for the se‐
132 lected image type. The setting is only effective if the config‐
133 ured image type is setup with an initial derived_from reference
134 --set-container-tag=<name>
136 overwrite the container tag in the container configuration. The
137 setting is only effective if the container configuraiton pro‐
138 vides an initial tag value
139 --signing-key=<key-file>
141 set the key file to be trusted and imported into the package
142 manager database before performing any opertaion. This is useful
143 if an image build should take and validate repository and pack‐
144 age signatures during build time. This option can be specified
145 multiple times
146 --target-dir=<directory>
148 Path to store the build results.
149
151 • http:// | https:// | ftp://
152 remote repository delivered via http or ftp protocol.
154 • obs://
156 Open Buildservice repository. The source data is translated into an
158 http url pointing to http://download.opensuse.org.
159 • ibs://
161 Internal Open Buildservice repository. The source data is translated
163 into an http url pointing to download.suse.de.
164 • iso://
166 Local iso file. kiwi loop mounts the file and uses the mount point as
168 temporary directory source type
169 • dir://
171 Local directory
173
175 Marcus Schäfer
176
178 2020, Marcus Schäfer
1799.23.34 May 21, 2021 KIWI::SYSTEM::BUILD(8)