Skip to content

Commit cd72305

Browse files
Geoffroy Van Cutsemjren1
authored andcommitted
getting_started: make instructions more specific
Make the Getting Started Guide instructions more specific and comprehensive for Clear Linux version 21260 (version of reference) Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
1 parent a5e3273 commit cd72305

File tree

1 file changed

+46
-19
lines changed

1 file changed

+46
-19
lines changed

doc/getting_started/index.rst

Lines changed: 46 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,17 @@ Currently, an installable version of ARCN does not exist. Therefore, you
4444
need to setup a base Clear Linux OS to bootstrap ACRN on the NUC. You'll
4545
need a network connection for your NUC to complete this setup.
4646

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.
4852

4953
1. Follow this `Clear Linux installation guide
5054
<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.
5258

5359
2. At the "Choose Installation Type" screen, choose the "< Automatic >"
5460
option. This will install the minimum Clear Linux components.
@@ -87,7 +93,7 @@ need a network connection for your NUC to complete this setup.
8793

8894
.. code-block:: none
8995
90-
# swupd bundle-add vim curl network-basic service-os kernel-pk
96+
# swupd bundle-add vim network-basic service-os kernel-pk
9197
9298
.. table:: Clear Linux bundles
9399
:widths: auto
@@ -98,8 +104,6 @@ need a network connection for your NUC to complete this setup.
98104
+====================+===================================================+
99105
| vim | vim text editor |
100106
+--------------------+---------------------------------------------------+
101-
| curl | Provide the curl command-line utility |
102-
+--------------------+---------------------------------------------------+
103107
| network-basic | Run network utilities and modify network settings |
104108
+--------------------+---------------------------------------------------+
105109
| service-os | Add the acrn hypervisor, the acrn devicemodel and |
@@ -122,19 +126,24 @@ partition. Follow these steps:
122126
123127
# mount /dev/sda1 /mnt
124128
125-
# ls /mnt/EFI/org.clearlinux
129+
# ls -1 /mnt/EFI/org.clearlinux
126130
bootloaderx64.efi
127131
kernel-org.clearlinux.native.4.15.7-536
128132
kernel-org.clearlinux.pk414-sos.4.14.23-19
129133
kernel-org.clearlinux.pk414-standard.4.14.23-19
130134
loaderx64.efi
131135
136+
.. note::
137+
Take note of the exact kernel versions (``*-sos`` and ``*-standard``)
138+
as you will need them later.
139+
140+
132141
#. Copy the ``acrn.efi`` hypervisor application (included in the Clear
133142
Linux release) to the EFI partition.
134143

135144
.. code-block:: none
136145
137-
# cp /usr/share/acrn/demo/acrn.efi /mnt/EFI/org.clearlinux
146+
# cp /usr/share/acrn/acrn.efi /mnt/EFI/org.clearlinux
138147
139148
#. Create a boot entry for ACRN. It must contain these settings:
140149

@@ -167,6 +176,10 @@ partition. Follow these steps:
167176
the instructions above, the partition (``root=/dev/sda3``) and image
168177
locations used in the ``arcn.conf`` file will match.
169178

179+
.. note::
180+
Please make sure that the kernel version and root filesystem image (``clear-<version>-kvm.img``)
181+
match your set-up.
182+
170183
#. Add a timeout period for Systemd-Boot to wait, otherwise it will not
171184
present the boot menu and will always boot the base Clear Linux
172185
kernel.
@@ -185,7 +198,7 @@ partition. Follow these steps:
185198

186199
ACRN Hypervisor Boot menu
187200

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
189202
automatically by default, as shown in :numref:`gsg-sos-console`:
190203

191204
.. figure:: images/gsg-sos-console.png
@@ -194,7 +207,10 @@ partition. Follow these steps:
194207

195208
Service OS Console
196209

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.
198214

199215
Create a Network Bridge
200216
=======================
@@ -213,14 +229,13 @@ folder) as shown here:
213229
:language: bash
214230

215231
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:
218233

219234
.. code-block:: none
220235
221236
# cd /usr/share/acrn/demo/
222-
# chmod +x ./bridge.sh
223237
# ./bridge.sh
238+
# cd
224239
225240
Set up Reference UOS
226241
====================
@@ -229,7 +244,12 @@ Set up Reference UOS
229244

230245
.. code-block:: none
231246
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).
233253

234254
#. Uncompress it.
235255

@@ -243,7 +263,7 @@ Set up Reference UOS
243263
244264
# losetup -f -P --show /root/clear-21260-kvm.img
245265
# ls /dev/loop0*
246-
# mount /dev/**loop0p3** /mnt
266+
# mount /dev/loop0p3 /mnt
247267
# cp -r /usr/lib/doc/modules/4.14.23-19.pk414-standard /mnt/lib/doc/modules/
248268
# umount /mnt
249269
# sync
@@ -258,19 +278,26 @@ Set up Reference UOS
258278
.. literalinclude:: ../../acrn-devicemodel/samples/launch_uos.sh
259279
:caption: acrn-devicemodel/samples/launch_uos.sh
260280
: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*``).
261290

262291
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:
265293

266294
.. code-block:: none
267295
268296
# cd /usr/share/acrn/demo/
269-
# chmod +x ./launch_uos.sh
270297
# ./launch_uos.sh
271298
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:
274301

275302
.. figure:: images/gsg-successful-boot.png
276303
:align: center

0 commit comments

Comments
 (0)