@@ -44,11 +44,17 @@ Currently, an installable version of ARCN does not exist. Therefore, you
44
44
need to setup a base Clear Linux OS to bootstrap ACRN on the NUC. You'll
45
45
need a network connection for your NUC to complete this setup.
46
46
47
- .. note :: ACRN requires Clear Linux version 21260 or newer.
47
+ .. note ::
48
+ ACRN requires Clear Linux version 21260 or newer. The instructions below
49
+ have been validated with version 21260 and need some adjustment to work
50
+ with newer versions. You will see a note when the instruction needs to be
51
+ adjusted.
48
52
49
53
1. Follow this `Clear Linux installation guide
50
54
<https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install> `__
51
- as a starting point for installing Clear Linux onto your NUC.
55
+ as a starting point for installing Clear Linux onto your NUC. Download the
56
+ ``clear-21260-installer.img.xz `` from the https://download.clearlinux.org/releases/21260/clear/
57
+ folder to get Clear Linux version 21260.
52
58
53
59
2. At the "Choose Installation Type" screen, choose the "< Automatic >"
54
60
option. This will install the minimum Clear Linux components.
@@ -87,7 +93,7 @@ need a network connection for your NUC to complete this setup.
87
93
88
94
.. code-block :: none
89
95
90
- # swupd bundle-add vim curl network-basic service-os kernel-pk
96
+ # swupd bundle-add vim network-basic service-os kernel-pk
91
97
92
98
.. table :: Clear Linux bundles
93
99
:widths: auto
@@ -98,8 +104,6 @@ need a network connection for your NUC to complete this setup.
98
104
+====================+===================================================+
99
105
| vim | vim text editor |
100
106
+--------------------+---------------------------------------------------+
101
- | curl | Provide the curl command-line utility |
102
- +--------------------+---------------------------------------------------+
103
107
| network-basic | Run network utilities and modify network settings |
104
108
+--------------------+---------------------------------------------------+
105
109
| service-os | Add the acrn hypervisor, the acrn devicemodel and |
@@ -122,19 +126,24 @@ partition. Follow these steps:
122
126
123
127
# mount /dev/sda1 /mnt
124
128
125
- # ls /mnt/EFI/org.clearlinux
129
+ # ls -1 /mnt/EFI/org.clearlinux
126
130
bootloaderx64.efi
127
131
kernel-org.clearlinux.native.4.15.7-536
128
132
kernel-org.clearlinux.pk414-sos.4.14.23-19
129
133
kernel-org.clearlinux.pk414-standard.4.14.23-19
130
134
loaderx64.efi
131
135
136
+ .. note::
137
+ Take note of the exact kernel versions (``*-sos`` and ``*-standard``)
138
+ as you will need them later.
139
+
140
+
132
141
#. Copy the ``acrn.efi `` hypervisor application (included in the Clear
133
142
Linux release) to the EFI partition.
134
143
135
144
.. code-block :: none
136
145
137
- # cp /usr/share/acrn/demo/ acrn.efi /mnt/EFI/org.clearlinux
146
+ # cp /usr/share/acrn/acrn.efi /mnt/EFI/org.clearlinux
138
147
139
148
#. Create a boot entry for ACRN. It must contain these settings:
140
149
@@ -167,6 +176,10 @@ partition. Follow these steps:
167
176
the instructions above, the partition (``root=/dev/sda3 ``) and image
168
177
locations used in the ``arcn.conf `` file will match.
169
178
179
+ .. note ::
180
+ Please make sure that the kernel version and root filesystem image (``clear-<version>-kvm.img ``)
181
+ match your set-up.
182
+
170
183
#. Add a timeout period for Systemd-Boot to wait, otherwise it will not
171
184
present the boot menu and will always boot the base Clear Linux
172
185
kernel.
@@ -185,7 +198,7 @@ partition. Follow these steps:
185
198
186
199
ACRN Hypervisor Boot menu
187
200
188
- #. After booting up the ACRN hypervisor, the Service OS be launched
201
+ #. After booting up the ACRN hypervisor, the Service OS will be launched
189
202
automatically by default, as shown in :numref: `gsg-sos-console `:
190
203
191
204
.. figure :: images/gsg-sos-console.png
@@ -194,7 +207,10 @@ partition. Follow these steps:
194
207
195
208
Service OS Console
196
209
197
- #. From here you can login as root and set the first-time root password.
210
+ .. note :: You may need to hit ``Enter`` to get a clean login prompt
211
+
212
+ #. From here you can login as root using the password you set previously when
213
+ you installed Clear Linux.
198
214
199
215
Create a Network Bridge
200
216
=======================
@@ -213,14 +229,13 @@ folder) as shown here:
213
229
:language: bash
214
230
215
231
By default, the script is located in the ``/usr/share/acrn/demo/ ``
216
- directory. Use it directly by making it executable and run it to create
217
- a network bridge:
232
+ directory. Run it to create a network bridge:
218
233
219
234
.. code-block :: none
220
235
221
236
# cd /usr/share/acrn/demo/
222
- # chmod +x ./bridge.sh
223
237
# ./bridge.sh
238
+ # cd
224
239
225
240
Set up Reference UOS
226
241
====================
@@ -229,7 +244,12 @@ Set up Reference UOS
229
244
230
245
.. code-block :: none
231
246
232
- # curl -O https://download.clearlinux.org/image/clear-21260-kvm.img.xz
247
+ # curl -O https://download.clearlinux.org/releases/21260/clear/clear-21260-kvm.img.xz
248
+
249
+ .. note ::
250
+ In case you want to use or try out a newer version of Clear Linux as the UOS, you can
251
+ download the latest from http://download.clearlinux.org/image. Make sure to adjust the steps
252
+ described below accordingly (image file name and kernel modules version).
233
253
234
254
#. Uncompress it.
235
255
@@ -243,7 +263,7 @@ Set up Reference UOS
243
263
244
264
# losetup -f -P --show /root/clear-21260-kvm.img
245
265
# ls /dev/loop0*
246
- # mount /dev/** loop0p3** /mnt
266
+ # mount /dev/loop0p3 /mnt
247
267
# cp -r /usr/lib/doc/modules/4.14.23-19.pk414-standard /mnt/lib/doc/modules/
248
268
# umount /mnt
249
269
# sync
@@ -258,19 +278,26 @@ Set up Reference UOS
258
278
.. literalinclude :: ../../acrn-devicemodel/samples/launch_uos.sh
259
279
:caption: acrn-devicemodel/samples/launch_uos.sh
260
280
:language: bash
281
+ :emphasize-lines: 22,24
282
+
283
+ .. note ::
284
+ In case you have downloaded a different Clear Linux image than the one above
285
+ (``clear-21260-kvm.img.xz ``), you will need to modify the Clear Linux file name
286
+ and version number highlighted above (the ``-s 3,virtio-blk `` argument) to match
287
+ what you have downloaded above. Likewise, you may need to adjust the kernel file
288
+ name on the second line highlighted (check the exact name to be used using:
289
+ ``ls /usr/lib/doc/kernel/org.clearlinux*-standard* ``).
261
290
262
291
By default, the script is located in the ``/usr/share/acrn/demo/ ``
263
- directory. Use it directly by making it executable and run it to
264
- launch the User OS:
292
+ directory. Run it directly to launch the User OS:
265
293
266
294
.. code-block :: none
267
295
268
296
# cd /usr/share/acrn/demo/
269
- # chmod +x ./launch_uos.sh
270
297
# ./launch_uos.sh
271
298
272
- #. At this point, you've successfully booted the ACRN system ,
273
- hypervisor, SOS, and UOS:
299
+ #. At this point, you've successfully booted the ACRN hypervisor ,
300
+ SOS, and UOS:
274
301
275
302
.. figure :: images/gsg-successful-boot.png
276
303
:align: center
0 commit comments