1KIWI::SYSTEM::PREPARE(8) KIWI NG KIWI::SYSTEM::PREPARE(8)
2
6 kiwi::system::prepare - Prepare image root system
7
9 kiwi-ng [global options] service <command> [<args>]
10 kiwi-ng system prepare -h | --help
12 kiwi-ng system prepare --description=<directory> --root=<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 prepare help
27
29 Create a new image root directory. The prepare step builds a new image
30 root directory from the specified XML description. The specified root
31 directory is the root directory of the new image root system. As the
32 root user you can enter this system via chroot as follows:
33 $ chroot <directory> bash
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 re-use an existing image root directory
58 --clear-cache
60 delete repository cache for each of the used repositories before
61 installing any package. This is useful if an image build should
62 take and validate the signature of the package from the original
63 repository source for any build. Some package managers uncondi‐
64 tionally trust the contents of the cache, which is ok for cache
65 data dedicated to one build but in case of kiwi the cache is
66 shared between multiple image builds on that host for perfor‐
67 mance reasons.
68 --delete-package=<name>
70 specify package to delete. The option can be specified multiple
71 times
72 --description=<directory>
74 Path to the kiwi XML description. Inside of that directory there
75 must be at least a config.xml of *.kiwi XML description.
76 --ignore-repos
78 Ignore all repository configurations from the XML description.
79 Using that option is usally done with a sequence of --add-repo
80 options otherwise there are no repositories available for the
81 image build which would lead to an error.
82 --ignore-repos-used-for-build
84 Works the same way as --ignore-repos except that repository con‐
85 figurations which has the imageonly attribute set to true will
86 not be ignored.
87 --root=<directory>
89 Path to create the new root system.
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
148 Marcus Schäfer
149
151 2020, Marcus Schäfer
1529.24.13 Nov 29, 2021 KIWI::SYSTEM::PREPARE(8)