OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity
acrn-hypervisor/doc/getting_started/index.rst

381 lines
13 KiB
ReStructuredText
Raw Blame History

.. _getting_started:
Getting Started Guide
#####################
After reading the :ref:`introduction`, use this guide to get started
using ACRN in a reference setup. We'll show how to set up your
development and target hardware, and then how to boot up the ACRN
hypervisor and the `Clear Linux`_ Service OS and Guest OS on the Intel
|reg| NUC.
.. _Clear Linux: https://clearlinux.org
Hardware setup
**************
The Intel |reg| NUC (NUC6CAYH) is the supported reference target
platform for ACRN work, as described in :ref:`hardware`, and is the only
platform currently tested with these setup instructions.
The recommended NUC hardware configuration is:
- NUC: `NUC Kit
NUC6CAYH <https://www.intel.com/content/www/us/en/products/boards-kits/nuc/kits/nuc6cayh.html>`__
- `UEFI BIOS (version 0047) <https://downloadcenter.intel.com/product/95062/Intel-NUC-Kit-NUC6CAYH>`__.
- Memory: 8G DDR3
- SSD: 120G SATA
Software setup
**************
Firmware update on the NUC
==========================
You may need to update to the latest UEFI firmware for the NUC hardware.
Follow these `BIOS Update Instructions
<https://www.intel.com/content/www/us/en/support/articles/000005636.html>`__
for downloading and flashing an updated BIOS for the NUC.
Set up a Clear Linux Operating System
=====================================
Currently, an installable version of ARCN does not exist. Therefore, you
need to setup a base Clear Linux OS to bootstrap ACRN on the NUC. You'll
need a network connection for your NUC to complete this setup.
.. note::
ACRN requires Clear Linux version 21260 or newer. The instructions below
have been validated with version 21260 and need some adjustment to work
with newer versions. You will see a note when the instruction needs to be
adjusted.
1. Follow this `Clear Linux installation guide
<https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install>`__
as a starting point for installing Clear Linux onto your NUC. Download the
``clear-21260-installer.img.xz`` from the https://download.clearlinux.org/releases/21260/clear/
folder to get Clear Linux version 21260.
2. At the "Choose Installation Type" screen, choose the "< Automatic >"
option. This will install the minimum Clear Linux components.
3. At the "Choose target device for installation" screen, select your
NUC's storage device to delete all existing content and create
partitions automatically. The installer will
create three partitions as shown in :numref:`CL-partitions`
for the recommended 120GB SSD drive.
.. table:: Clear Linux Partitions
:widths: auto
:name: CL-partitions
+-------------+----------+-----------------------+
| Partition | Size | Type |
+=============+==========+=======================+
| /dev/sda1 | 511M | EFI System |
+-------------+----------+-----------------------+
| /dev/sda2 | 32M | Linux swap |
+-------------+----------+-----------------------+
| /dev/sda3 | 111.3G | Linux root (x86-64) |
+-------------+----------+-----------------------+
4. After installation is complete, boot into Clear Linux, login as
root, and set a password.
5. Clear Linux is set to automatically update itself. If you do not want
it to autoupdate, issue this command:
.. code-block:: none
# swupd autoupdate --disable
6. Use the ``swupd bundle-add`` command and add these Clear Linux bundles:
.. code-block:: none
# swupd bundle-add vim network-basic service-os kernel-pk
.. table:: Clear Linux bundles
:widths: auto
:name: CL-bundles
+--------------------+---------------------------------------------------+
| Bundle | Description |
+====================+===================================================+
| vim | vim text editor |
+--------------------+---------------------------------------------------+
| network-basic | Run network utilities and modify network settings |
+--------------------+---------------------------------------------------+
| service-os | Add the acrn hypervisor, the acrn devicemodel and |
| | Service OS kernel |
+--------------------+---------------------------------------------------+
| kernel-pk | Run the Intel "PK" kernel(product kernel source) |
| | and enterprise-style kernel with backports |
+--------------------+---------------------------------------------------+
Add the ACRN hypervisor to the EFI Partition
============================================
In order to boot the ACRN SOS on the NUC, you'll need to add it to the EFI
partition. Follow these steps:
#. Mount the EFI partition and verify you have the following files:
.. code-block:: none
# mount /dev/sda1 /mnt
# ls -1 /mnt/EFI/org.clearlinux
bootloaderx64.efi
kernel-org.clearlinux.native.4.15.7-536
kernel-org.clearlinux.pk414-sos.4.14.23-19
kernel-org.clearlinux.pk414-standard.4.14.23-19
loaderx64.efi
.. note::
Take note of the exact kernel versions (``*-sos`` and ``*-standard``)
as you will need them later.
#. Copy the ``acrn.efi`` hypervisor application (included in the Clear
Linux release) to the EFI partition.
.. code-block:: none
# cp /usr/share/acrn/acrn.efi /mnt/EFI/org.clearlinux
#. Create a boot entry for ACRN. It must contain these settings:
+-----------+----------------------------------------------------------------+
| Setting | Description |
+===========+================================================================+
| title | Text to show in the boot menu |
+-----------+----------------------------------------------------------------+
| efi | Executable EFI image |
+-----------+----------------------------------------------------------------+
| options | Options to pass to the EFI program or kernel boot parameters |
+-----------+----------------------------------------------------------------+
A sample `acrn.conf
<https://github.com/projectacrn/acrn-hypervisor/tree/master/bsp/uefi/clearlinux/acrn.conf>`__
is included in the Clear Linux release, and is also available in the
acrn-hypervisor GitHub repo (in the bsp/uefi/clearlinux
folder) as shown here:
.. literalinclude:: ../../acrn-hypervisor/bsp/uefi/clearlinux/acrn.conf
:caption: acrn-hypervisor/bsp/uefi/clearlinux/acrn.conf
Copy the ``acrn.conf`` file to the EFI partition we mounted earlier:
.. code-block:: none
# cp /usr/share/acrn/demo/acrn.conf /mnt/loader/entries/
If you're following
the instructions above, the partition (``root=/dev/sda3``) and image
locations used in the ``arcn.conf`` file will match.
.. note::
Please make sure that the kernel version and root filesystem image (``clear-<version>-kvm.img``)
match your set-up.
#. Add a timeout period for Systemd-Boot to wait, otherwise it will not
present the boot menu and will always boot the base Clear Linux
kernel.
.. code-block:: none
# clr-boot-manager set-timeout 20
# clr-boot-manager update
#. Reboot and select "The ACRN Hypervisor" to boot, as shown in
:numref:`gsg-bootmenu`:
.. figure:: images/gsg-bootmenu.png
:align: center
:name: gsg-bootmenu
ACRN Hypervisor Boot menu
#. After booting up the ACRN hypervisor, the Service OS will be launched
automatically by default, as shown in :numref:`gsg-sos-console`:
.. figure:: images/gsg-sos-console.png
:align: center
:name: gsg-sos-console
Service OS Console
.. note:: You may need to hit ``Enter`` to get a clean login prompt
#. From here you can login as root using the password you set previously when
you installed Clear Linux.
Create a Network Bridge
=======================
Without a network bridge, the SOS and UOS are not able to talk to each
other.
A sample `bridge.sh
<https://github.com/projectacrn/acrn-devicemodel/tree/master/samples/bridge.sh>`__
is included in the Clear Linux release, and
is also available in the acrn-devicemodel GitHub repo (in the samples
folder) as shown here:
.. literalinclude:: ../../acrn-devicemodel/samples/bridge.sh
:caption: acrn-devicemodel/samples/bridge.sh
:language: bash
By default, the script is located in the ``/usr/share/acrn/demo/``
directory. Run it to create a network bridge:
.. code-block:: none
# cd /usr/share/acrn/demo/
# ./bridge.sh
# cd
Set up Reference UOS
====================
#. Download the pre-built reference Clear Linux UOS image.
.. code-block:: none
# curl -O https://download.clearlinux.org/releases/21260/clear/clear-21260-kvm.img.xz
.. note::
In case you want to use or try out a newer version of Clear Linux as the UOS, you can
download the latest from http://download.clearlinux.org/image. Make sure to adjust the steps
described below accordingly (image file name and kernel modules version).
#. Uncompress it.
.. code-block:: none
# unxz clear-21260-kvm.img.xz
#. Deploy the UOS kernel modules to UOS virtual disk image
.. code-block:: none
# losetup -f -P --show /root/clear-21260-kvm.img
# ls /dev/loop0*
# mount /dev/loop0p3 /mnt
# cp -r /usr/lib/doc/modules/4.14.23-19.pk414-standard /mnt/lib/doc/modules/
# umount /mnt
# sync
#. Run the launch_uos.sh script to launch the UOS.
A sample `launch_uos.sh
<https://github.com/projectacrn/acrn-devicemodel/tree/master/samples/launch_uos.sh>`__
is included in the Clear Linux release, and
is also available in the acrn-devicemodel GitHub repo (in the samples
folder) as shown here:
.. literalinclude:: ../../acrn-devicemodel/samples/launch_uos.sh
:caption: acrn-devicemodel/samples/launch_uos.sh
:language: bash
:emphasize-lines: 22,24
.. note::
In case you have downloaded a different Clear Linux image than the one above
(``clear-21260-kvm.img.xz``), you will need to modify the Clear Linux file name
and version number highlighted above (the ``-s 3,virtio-blk`` argument) to match
what you have downloaded above. Likewise, you may need to adjust the kernel file
name on the second line highlighted (check the exact name to be used using:
``ls /usr/lib/doc/kernel/org.clearlinux*-standard*``).
By default, the script is located in the ``/usr/share/acrn/demo/``
directory. Run it directly to launch the User OS:
.. code-block:: none
# cd /usr/share/acrn/demo/
# ./launch_uos.sh
#. At this point, you've successfully booted the ACRN hypervisor,
SOS, and UOS:
.. figure:: images/gsg-successful-boot.png
:align: center
:name: gsg-successful-boot
Build ACRN from Source
**********************
If you would like to build ACRN hypervisor and device model from source,
follow these steps.
Install build tools and dependencies
====================================
ARCN development is supported on popular Linux distributions,
each with their own way to install development tools:
* On a Clear Linux development system, install the ``os-clr-on-clr`` bundle to get
the necessary tools:
.. code-block:: console
$ sudo swupd bundle-add os-clr-on-clr
* On a Ubuntu/Debian development system:
.. code-block:: console
$ sudo apt install git \
gnu-efi \
libssl-dev \
libpciaccess-dev \
uuid-dev
* On a Fedora/doc/Redhat development system:
.. code-block:: console
$ sudo dnf install gcc \
gnu-efi-devel \
libuuid-devel \
openssl-devel \
libpciaccess-devel
* On a CentOS development system:
.. code-block:: console
$ sudo yum install gcc \
gnu-efi-devel \
libuuid-devel \
openssl-devel \
libpciaccess-devel
Build the hypervisor and device model
=====================================
#. Download the ACRN hypervisor and build it.
.. code-block:: console
$ git clone https://github.com/projectacrn/acrn-hypervisor
$ cd acrn-hypervisor
$ make PLATFORM=uefi
The build results are found in the ``build`` directory.
#. Download the ACRN device model and build it.
.. code-block:: console
$ git clone https://github.com/projectacrn/acrn-devicemodel
$ cd acrn-devicemodel
$ make
The build results are found in the ``build`` directory.
Follow the same instructions to boot and test the images you created
from your build.
Reference in New Issue View Git Blame Copy Permalink