github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-19 12:12:16 +00:00
Code Issues Projects Releases Wiki Activity

Doc: document update base on release_v1.5

Browse Source 
Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
This commit is contained in:
fuzhongl 2020-01-08 16:33:21 +08:00 committed by wenlingz
parent 6ec5db627d
commit 2c2bd9cd3b
3 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/getting-started/rt_industry.rst
View File

@ -6,9 +6,9 @@ Getting Started Guide for ACRN Industry Scenario
Verified version Verified version
**************** ****************
- Clear Linux version: **31670** - Clear Linux version: **32030**
- ACRN-hypervisor tag: **v1.4** - ACRN-hypervisor tag: **v1.5 (acrn-2020w01.1-140000p)**
- ACRN-Kernel(Service VM kernel): **4.19.78-98.iot-lts2018-sos** - ACRN-Kernel (Service VM kernel): **4.19.78-98.iot-lts2018-sos**
Prerequisites Prerequisites
************* *************
@ -21,10 +21,10 @@ for the RTVM.
(refer to :ref:`the tables <hardware_setup>` for detailed information). (refer to :ref:`the tables <hardware_setup>` for detailed information).
- If you need to enable the serial port on KBL NUC, navigate to the - If you need to enable the serial port on KBL NUC, navigate to the
:ref:`troubleshooting <connect_serial_port>` to prepare the cable. :ref:`troubleshooting <connect_serial_port>` to prepare the cable.
- Follow below steps to install Clear Linux OS (Ver: 31670) onto both disks on the KBL NUC: - Follow below steps to install Clear Linux OS (Ver: 32030) onto both disks on the KBL NUC:
.. _Clear Linux OS Server image: .. _Clear Linux OS Server image:
https://download.clearlinux.org/releases/31670/clear/clear-31670-live-server.iso https://download.clearlinux.org/releases/32030/clear/clear-32030-live-server.iso
#. Create a bootable USB drive on Linux*: #. Create a bootable USB drive on Linux*:
@ -46,7 +46,7 @@ for the RTVM.
#. Unmount all the ``/dev/sdc`` partitions and burn the image onto the USB drive:: #. Unmount all the ``/dev/sdc`` partitions and burn the image onto the USB drive::
$ umount /dev/sdc* 2>/dev/null $ umount /dev/sdc* 2>/dev/null
$ sudo dd if=./clear-31670-live-server.iso of=/dev/sdc oflag=sync status=progress bs=4M $ sudo dd if=./clear-32030-live-server.iso of=/dev/sdc oflag=sync status=progress bs=4M
#. Plug in the USB drive to the KBL NUC and boot from USB. #. Plug in the USB drive to the KBL NUC and boot from USB.
#. Launch the Clear Linux OS installer boot menu. #. Launch the Clear Linux OS installer boot menu.
@ -131,7 +131,7 @@ Use the pre-installed industry ACRN hypervisor
.. code-block:: none .. code-block:: none
# ./acrn_quick_setup.sh -s 31670 -d -i # ./acrn_quick_setup.sh -s 32030 -d -i
.. note:: ``-i`` option means the industry scenario efi image will be used, e.g. .. note:: ``-i`` option means the industry scenario efi image will be used, e.g.
``acrn.nuc7i7dnb.industry.efi``. For the detailed usage of the ``acrn_quick_setup.sh`` script, ``acrn.nuc7i7dnb.industry.efi``. For the detailed usage of the ``acrn_quick_setup.sh`` script,
@ -189,15 +189,15 @@ Use the ACRN industry out-of-the-box image
#. Download the Service VM industry image:: #. Download the Service VM industry image::
# wget https://github.com/projectacrn/acrn-hypervisor/releases/download/acrn-2019w47.1-140000p/sos-industry-31670.img.xz # wget https://github.com/projectacrn/acrn-hypervisor/releases/download/acrn-2020w01.1-140000p/sos-industry-32030.img.xz
#. Decompress the .xz image:: #. Decompress the .xz image::
# xz -d sos-industry-31670.img.xz # xz -d sos-industry-32030.img.xz
#. Burn the Service VM image onto the SATA disk:: #. Burn the Service VM image onto the SATA disk::
# dd if=sos-industry-31670.img of=/dev/sda bs=4M oflag=sync status=progress # dd if=sos-industry-32030.img of=/dev/sda bs=4M oflag=sync status=progress
#. Configure the EFI firmware to boot the ACRN hypervisor by default: #. Configure the EFI firmware to boot the ACRN hypervisor by default:
@ -223,15 +223,15 @@ Install and launch the Preempt-RT VM
#. Download the Preempt-RT VM image:: #. Download the Preempt-RT VM image::
# wget https://github.com/projectacrn/acrn-hypervisor/releases/download/acrn-2019w47.1-140000p/preempt-rt-31670.img.xz # wget https://github.com/projectacrn/acrn-hypervisor/releases/download/acrn-2020w01.1-140000p/preempt-rt-32030.img.xz
#. Decompress the xz image:: #. Decompress the xz image::
# xz -d preempt-rt-31670.img.xz # xz -d preempt-rt-32030.img.xz
#. Burn the Preempt-RT VM image onto the NVMe disk:: #. Burn the Preempt-RT VM image onto the NVMe disk::
# dd if=preempt-rt-31670.img of=/dev/nvme0n1 bs=4M oflag=sync status=progress # dd if=preempt-rt-32030.img of=/dev/nvme0n1 bs=4M oflag=sync status=progress
#. Use the ``lspci`` command to ensure that the correct NVMe device IDs will #. Use the ``lspci`` command to ensure that the correct NVMe device IDs will
be used for the passthru before launching the script: be used for the passthru before launching the script:

11
doc/tutorials/acrn_ootb.rst
View File

@ -88,7 +88,7 @@ Step 1: Create a Service VM YAML file and script
{cmd: "${yamlDir}/service-os-post.sh ${chrootDir}"}, {cmd: "${yamlDir}/service-os-post.sh ${chrootDir}"},
] ]
version: 31670 version: 32030
.. note:: Update the version value to your target Clear Linux version. .. note:: Update the version value to your target Clear Linux version.
@ -205,7 +205,7 @@ Step 1: Create a Service VM YAML file and script
{cmd: "${yamlDir}/service-os-industry-post.sh ${chrootDir}"}, {cmd: "${yamlDir}/service-os-industry-post.sh ${chrootDir}"},
] ]
version: 31670 version: 32030
.. note:: Update the version value to your target Clear Linux version. .. note:: Update the version value to your target Clear Linux version.
@ -377,8 +377,8 @@ Step 3: Deploy the Service VM image
.. code-block:: none .. code-block:: none
$ wget https://download.clearlinux.org/releases/31670/clear/clear-31670-live-server.iso $ wget https://download.clearlinux.org/releases/32030/clear/clear-32030-live-server.iso
$ sudo dd if=clear-31670-live-server.iso of=/dev/sdb1 bs=4M oflag=sync status=progress $ sudo dd if=clear-32030-live-server.iso of=/dev/sdb1 bs=4M oflag=sync status=progress
#. Copy the ``sos.img`` or ``sos-industry.img`` to the U disk: #. Copy the ``sos.img`` or ``sos-industry.img`` to the U disk:
@ -460,6 +460,7 @@ Step 3: Deploy the Service VM image
# dd if=/mnt/sos-industry.img of=/dev/sda bs=4M oflag=sync status=progress # dd if=/mnt/sos-industry.img of=/dev/sda bs=4M oflag=sync status=progress
Note: With the above “size” settings in yaml, >100G SOS image will be generated and it will quite some time to write it into the disk.
#. Configure the EFI firmware to boot the ACRN hypervisor by default: #. Configure the EFI firmware to boot the ACRN hypervisor by default:
.. code-block:: none .. code-block:: none
@ -533,7 +534,7 @@ Step 1: Create a Preempt-RT image YAML file and script
language: en_US.UTF-8 language: en_US.UTF-8
kernel: kernel-lts2018-preempt-rt kernel: kernel-lts2018-preempt-rt
version: 31670 version: 32030
.. note:: Update the version value to your target Clear Linux version .. note:: Update the version value to your target Clear Linux version

7
doc/tutorials/using_windows_as_uos.rst
View File

@ -1,5 +1,6 @@
.. _using_windows_as_uos: .. _using_windows_as_uos:
Using Windows as Guest VM on ACRN Using Windows as Guest VM on ACRN
################################# #################################
This tutorial describes how to launch Windows as a Guest (WaaG) VM on the ACRN hypervisor. This tutorial describes how to launch Windows as a Guest (WaaG) VM on the ACRN hypervisor.
@ -14,6 +15,12 @@ The following Intel Kaby Lake NUCs are verified:
"NUC7i7DNHE", "DNKBLi7v.86A.0052.2018.0808.1344", "`link <https://downloadcenter.intel.com/download/28886?v=t>`__" "NUC7i7DNHE", "DNKBLi7v.86A.0052.2018.0808.1344", "`link <https://downloadcenter.intel.com/download/28886?v=t>`__"
"NUC7i5DNHE", "DNKBLi5v.86A.0060.2018.1220.1536", "`link <https://downloadcenter.intel.com/download/28885?v=t>`__" "NUC7i5DNHE", "DNKBLi5v.86A.0060.2018.1220.1536", "`link <https://downloadcenter.intel.com/download/28885?v=t>`__"
Verified version
****************
#. Clear Linux version: 32030
#. ACRN-hypervisor tag: v1.5 (acrn-2020w01.1-140000p)
#. ACRN-Kernel (Service VM kernel): 4.19.78-98.iot-lts2018-sos
ACRN Service VM Setup ACRN Service VM Setup
********************* *********************
You may refer to the steps in :ref:`kbl-nuc-sdc` for the You may refer to the steps in :ref:`kbl-nuc-sdc` for the