1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
.. _self_contained:
Building in a Self-Contained Environment
========================================
.. note:: **Abstract**
Users building images with {kiwi} face problems if they want
to build an image matching one of the following criteria:
* The build should happen as a non-root user.
* The build should happen on a host system distribution for which
no {kiwi} packages exist.
* The build happens on an incompatible host system distribution
compared to the target image distribution. For example,
building an apt/dpkg-based system on an rpm-based system.
* Run more than one build process at the same time on the
same host.
* Run a build process for a different target architecture
compared to the host architecture (Cross-Arch Image Build).
This document describes how to perform the build process in
a self-contained environment using fast-booting virtual
machines to address the issues listed above.
The changes on the machine to become a build host will
be reduced to the requirements of the {kiwi} `boxed plugin`.
Requirements
------------
Add the {kiwi} repo from the Open Build Service. For details, see
:ref:`installation-from-obs`. The following {kiwi} plugin needs to be
installed on the build system:
.. code:: bash
$ sudo zypper in python3-kiwi_boxed_plugin
Building with the boxbuild command
----------------------------------
The installation of the {kiwi} boxed plugin has registered a new kiwi
command named `boxbuild`. The command implementation uses KVM as a
virtualization technology and runs the {kiwi} `build` command inside
a KVM-controlled virtual machine. For running the build process in a
virtual machine, it's required to provide VM images that are suitable
to perform this job. We call the VM images `boxes`, and they contain
kiwi itself as well as all other components needed to build appliances.
Those boxes are hosted in the Open Build Service and are publicly
available at the `Subprojects` tab in the: `Virtualization:Appliances:SelfContained <https://build.opensuse.org/project/show/Virtualization:Appliances:SelfContained>`__
project.
As a user, you don't need to work with the boxes because this is all done
by the plugin and provided as a service by the {kiwi} team. The `boxbuild`
command knows where to fetch the box and also cares for an update of the
box when it has changed.
Building an image with the `boxbuild` command is similar to building with
the `build` command. The plugin validates the given command call with the
capabilities of the `build` command. Thus, one part of the `boxbuild` command
is exactly the same as with the `build` command. The separation between
`boxbuild` and `build` options is done using the `--` separator. The following
example shows how to build an example from the `kiwi-descriptions` repo:
.. code:: bash
$ git clone https://github.com/OSInside/kiwi-descriptions.git
$ kiwi-ng --profile Virtual system boxbuild --box leap -- \
--description kiwi-descriptions/suse/x86_64/suse-leap-15.6 \
--target-dir /tmp/myimage
.. note::
The provided `--description` and `--target-dir` options are
set up as shared folders between the host and the box. No other
data will be shared with the host.
Sharing Backends
----------------
As mentioned above, the `boxbuild` call shares the two host directories
provided in `--description` and `--target-dir` with the box. To do this,
the following sharing backends are supported:
``--9p-sharing``
With QEMU's `9pfs`, you can create virtual filesystem devices
(virtio-9p-device) and expose them to the box. For more information,
see `9pfs <https://wiki.qemu.org/Documentation/9psetup>`__. Using
this sharing backend does not require any setup procedure from the
user and is also the default for `boxbuild`.
``--sshfs-sharing``
SSHFS is a FUSE-based filesystem client for mounting remote
directories over a Secure Shell connection (SSH). In `boxbuild`,
this is used to mount directories from the host into the box.
Because this runs through an SSH connection, the host must allow
connections from the box. If you plan to use `sshfs`, add the
following SSH public key to the :file:`~/.ssh/authorized_keys`
file of the user who is expected to call `boxbuild`:
.. code:: bash
echo "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCtiqDaYgEMkr7za7qc4iPXftgu/j3sodPOtpoG8PinwRX6/3xZteOJzCH2qCZjEgA5zsP9lxy/119cWXvdxFUvyEINjH77unzRnaHj/yTXPhHuhHgAiEubuHer2gZoOs+UH4cGJLKCrabjTjZdeK9KvL+hoAgJaWxDUvGsXYDQTBHXlKjniOL1MGbltDBHnYhu4k+PjjJ+UEBN+8+F74Y5fYgIovXXY88WQrybuEr1eAYjhvk/ln6TKw1P6uvVMuIbAGUgnZFntDCI91Qw8ps1j+lX3vNc8ZBoOwM6nHZqq4FAqbXuH+NvQFS/xDM6wwZQhAe+14dTQBA5F1mgCVf+fSbteb0/CraSGmgKIM8aPnK8rfF+BY6Jar3AJFKVRPshRzrQj6CWYu3BfmOLupCpqOK2XFyoU2lEpaZDejgPSJq/IBGZdjKplWJFF8ZRQ01a8eX8K2fjrQt/4k9c7Pjlg1aDH8Sf+5+vcehlSNs1d50wnFoaIPrgDdy04omiaJ8= kiwi@boxbuild" >> ~/.ssh/authorized_keys
The public key mentioned here is associated with an SSH key pair
we provide in the pre-built box images.
.. warning::
If the `sshfs` backend is used without the host trusting the box,
the `boxbuild` call will become interactive at the time of the sshfs
mount. In this case, the user might be asked for a passphrase, or
depending on the host's `sshd` setup, the request will be declined and
the boxbuild will fail.
``--virtiofs-sharing``
QEMU virtio-fs shared filesystem daemon. Share a host directory tree
with a box through a virtio-fs device. For more information,
see `virtiofs <https://manpages.ubuntu.com/manpages/jammy/en/man1/virtiofsd.1.html>`__.
Using this sharing backend does not require any setup procedure from the
user.
.. warning::
virtiofs support was added but is considered experimental and
not yet stable across the distributions. Feedback is welcome.
Building in Container
---------------------
By default, and also as the preferred method, boxbuild runs in a KVM
virtual machine. However, support for building in container
instances via `podman` is also implemented. The boxes are built as
virtual machine images and also as OCI containers hosted on the
openSUSE registry. In container mode, boxbuild pulls
the requested box from the remote registry to the local registry
and starts a container instance. The following example shows how
to build the mentioned {kiwi} integration test image in a
container:
.. code:: bash
$ kiwi-ng --profile Virtual system boxbuild --container --box leap -- \
--description kiwi-descriptions/suse/x86_64/suse-leap-15.6 \
--target-dir /tmp/myimage
.. note::
The provided `--description` and `--target-dir` options are
set up as shared volumes between the host and the box container.
In addition, containers also share the kiwi cache from
`/var/cache/kiwi` with the host for better performance.
.. warning::
For building in a container, several runtime constraints
exist, and the isolation model is not as strict as it is
when building in a VM. Please read the following information
to get clarity on the existing constraints.
``loop devices``
As kiwi requires loop devices and calls other operations
that require root privileges, `podman` is started through `sudo`.
As podman runs daemonless, the calling user must have the
privileges to perform the needed kiwi actions. Non-
privileged builds are therefore not possible in container
mode with kiwi.
``linux capabilities``
Several Linux capabilities, as they can be found in
https://man7.org/linux/man-pages/man7/capabilities.7.html, are
set when `boxbuild` starts the container:
* AUDIT_WRITE
* AUDIT_CONTROL
* CAP_MKNOD
* CAP_SYS_ADMIN
``host device nodes``
The host device nodes from `/dev` are shared with the container
instance. This is required to work with loop devices
inside the container. Device isolation is therefore
not possible in container mode with kiwi. The loop device
handling for container-based builds restricts the number of
simultaneous kiwi build processes on this host to the number
of available loop device nodes exposed from the host kernel.
|
