mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-08-09 12:08:30 +00:00
doc: terminology cleanup in GSG
- Replace SOS or Service OS with Service VM - Replace UOS or User OS with User VM - Capitalize ACRN Configurator and Board Inspector - Clean up some of the grammar Signed-off-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
parent
21615ee2f3
commit
4ea23b1292
@ -163,10 +163,10 @@ To set up the ACRN build environment on the development computer:
|
|||||||
cd ~/acrn-work
|
cd ~/acrn-work
|
||||||
git clone https://github.com/projectacrn/acrn-hypervisor.git
|
git clone https://github.com/projectacrn/acrn-hypervisor.git
|
||||||
cd acrn-hypervisor
|
cd acrn-hypervisor
|
||||||
git checkout v2.6
|
git checkout v2.7
|
||||||
|
|
||||||
cd ..
|
cd ..
|
||||||
git clone --depth 1 --branch release_2.6 https://github.com/projectacrn/acrn-kernel.git
|
git clone --depth 1 --branch release_2.7 https://github.com/projectacrn/acrn-kernel.git
|
||||||
|
|
||||||
.. _gsg-board-setup:
|
.. _gsg-board-setup:
|
||||||
|
|
||||||
@ -180,7 +180,7 @@ information extracted from the target system. The file is used to configure the
|
|||||||
ACRN hypervisor, because each hypervisor instance is specific to your target
|
ACRN hypervisor, because each hypervisor instance is specific to your target
|
||||||
hardware.
|
hardware.
|
||||||
|
|
||||||
You use the **board inspector tool** to generate the board
|
You use the **Board Inspector tool** to generate the board
|
||||||
configuration file.
|
configuration file.
|
||||||
|
|
||||||
.. important::
|
.. important::
|
||||||
@ -192,7 +192,7 @@ configuration file.
|
|||||||
Install OS on the Target
|
Install OS on the Target
|
||||||
============================
|
============================
|
||||||
|
|
||||||
The target system needs Ubuntu 18.04 to run the board inspector tool.
|
The target system needs Ubuntu 18.04 to run the Board Inspector tool.
|
||||||
|
|
||||||
To install Ubuntu 18.04:
|
To install Ubuntu 18.04:
|
||||||
|
|
||||||
@ -248,7 +248,7 @@ Configure Target BIOS Settings
|
|||||||
Generate a Board Configuration File
|
Generate a Board Configuration File
|
||||||
=========================================
|
=========================================
|
||||||
|
|
||||||
#. On the target system, install the board inspector dependencies:
|
#. On the target system, install the Board Inspector dependencies:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -281,7 +281,7 @@ Generate a Board Configuration File
|
|||||||
|
|
||||||
GRUB_CMDLINE_LINUX_DEFAULT="quiet splash idle=nomwait iomem=relaxed intel_idle.max_cstate=0 intel_pstate=disable"
|
GRUB_CMDLINE_LINUX_DEFAULT="quiet splash idle=nomwait iomem=relaxed intel_idle.max_cstate=0 intel_pstate=disable"
|
||||||
|
|
||||||
These settings allow the board inspector tool to
|
These settings allow the Board Inspector tool to
|
||||||
gather important information about the board.
|
gather important information about the board.
|
||||||
|
|
||||||
#. Save and close the file.
|
#. Save and close the file.
|
||||||
@ -293,7 +293,7 @@ Generate a Board Configuration File
|
|||||||
sudo update-grub
|
sudo update-grub
|
||||||
reboot
|
reboot
|
||||||
|
|
||||||
#. Copy the board inspector tool folder from the development computer to the
|
#. Copy the Board Inspector tool folder from the development computer to the
|
||||||
target via USB disk as follows:
|
target via USB disk as follows:
|
||||||
|
|
||||||
a. Move to the development computer.
|
a. Move to the development computer.
|
||||||
@ -311,7 +311,7 @@ Generate a Board Configuration File
|
|||||||
Confirm that only one disk name appears. You'll use that disk name in
|
Confirm that only one disk name appears. You'll use that disk name in
|
||||||
the following steps.
|
the following steps.
|
||||||
|
|
||||||
#. Copy the board inspector tool folder from the acrn-hypervisor source code to the USB disk:
|
#. Copy the Board Inspector tool folder from the acrn-hypervisor source code to the USB disk:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -322,7 +322,7 @@ Generate a Board Configuration File
|
|||||||
|
|
||||||
#. Insert the USB disk into the target system.
|
#. Insert the USB disk into the target system.
|
||||||
|
|
||||||
#. Copy the board inspector tool from the USB disk to the target:
|
#. Copy the Board Inspector tool from the USB disk to the target:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -330,13 +330,13 @@ Generate a Board Configuration File
|
|||||||
disk="/media/$USER/"$(ls /media/$USER)
|
disk="/media/$USER/"$(ls /media/$USER)
|
||||||
cp -r $disk/board_inspector ~/acrn-work
|
cp -r $disk/board_inspector ~/acrn-work
|
||||||
|
|
||||||
#. On the target, load the ``msr`` driver, used by the board inspector:
|
#. On the target, load the ``msr`` driver, used by the Board Inspector:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
sudo modprobe msr
|
sudo modprobe msr
|
||||||
|
|
||||||
#. Run the board inspector tool ( ``board_inspector.py``)
|
#. Run the Board Inspector tool ( ``board_inspector.py``)
|
||||||
to generate the board configuration file. This
|
to generate the board configuration file. This
|
||||||
example uses the parameter ``my_board`` as the file name.
|
example uses the parameter ``my_board`` as the file name.
|
||||||
|
|
||||||
@ -380,7 +380,7 @@ Generate a Board Configuration File
|
|||||||
Generate a Scenario Configuration File and Launch Scripts
|
Generate a Scenario Configuration File and Launch Scripts
|
||||||
*********************************************************
|
*********************************************************
|
||||||
|
|
||||||
You use the **ACRN configurator** to generate scenario configuration files and
|
You use the **ACRN Configurator** to generate scenario configuration files and
|
||||||
launch scripts.
|
launch scripts.
|
||||||
|
|
||||||
A **scenario configuration file** is an XML file that holds the parameters of
|
A **scenario configuration file** is an XML file that holds the parameters of
|
||||||
@ -388,18 +388,18 @@ a specific ACRN configuration, such as the number of VMs that can be run,
|
|||||||
their attributes, and the resources they have access to.
|
their attributes, and the resources they have access to.
|
||||||
|
|
||||||
A **launch script** is a shell script that is used to configure and create a
|
A **launch script** is a shell script that is used to configure and create a
|
||||||
User VM. Each User VM has its own launch script.
|
post-launched User VM. Each User VM has its own launch script.
|
||||||
|
|
||||||
To generate a scenario configuration file and launch scripts:
|
To generate a scenario configuration file and launch scripts:
|
||||||
|
|
||||||
#. On the development computer, install ACRN configurator dependencies:
|
#. On the development computer, install ACRN Configurator dependencies:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
cd ~/acrn-work/acrn-hypervisor/misc/config_tools/config_app
|
cd ~/acrn-work/acrn-hypervisor/misc/config_tools/config_app
|
||||||
sudo pip3 install -r requirements
|
sudo pip3 install -r requirements
|
||||||
|
|
||||||
#. Launch the ACRN configurator:
|
#. Launch the ACRN Configurator:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -407,7 +407,7 @@ To generate a scenario configuration file and launch scripts:
|
|||||||
|
|
||||||
#. Your web browser should open the website `<http://127.0.0.1:5001/>`__
|
#. Your web browser should open the website `<http://127.0.0.1:5001/>`__
|
||||||
automatically, or you may need to visit this website manually.
|
automatically, or you may need to visit this website manually.
|
||||||
The ACRN configurator is supported on Chrome and Firefox.
|
The ACRN Configurator is supported on Chrome and Firefox.
|
||||||
|
|
||||||
#. Click the **Import Board XML** button and browse to the board configuration
|
#. Click the **Import Board XML** button and browse to the board configuration
|
||||||
file ``my_board.xml`` previously generated. When it is successfully
|
file ``my_board.xml`` previously generated. When it is successfully
|
||||||
@ -461,9 +461,10 @@ To generate a scenario configuration file and launch scripts:
|
|||||||
.. image:: ./images/gsg_config_launch_default.png
|
.. image:: ./images/gsg_config_launch_default.png
|
||||||
:class: drop-shadow
|
:class: drop-shadow
|
||||||
|
|
||||||
#. In the dialog box, select **shared_launch_6uos** as the default launch
|
#. In the dialog box, select **shared_launch_6user_vm** as the default launch
|
||||||
setting and click **OK**. Because our sample ``shared`` scenario defines six
|
setting and click **OK**. Because our sample ``shared`` scenario defines
|
||||||
User VMs, we're using this ``shared_launch_6uos`` launch XML configuration.
|
six User VMs, we're using this ``shared_launch_6user_vm`` launch XML
|
||||||
|
configuration.
|
||||||
|
|
||||||
.. image:: ./images/gsg_config_launch_load.png
|
.. image:: ./images/gsg_config_launch_load.png
|
||||||
:class: drop-shadow
|
:class: drop-shadow
|
||||||
@ -480,10 +481,10 @@ To generate a scenario configuration file and launch scripts:
|
|||||||
.. image:: ./images/gsg_config_launch_save.png
|
.. image:: ./images/gsg_config_launch_save.png
|
||||||
:class: drop-shadow
|
:class: drop-shadow
|
||||||
|
|
||||||
#. Confirm that ``launch_uos_id3.sh`` appears in the expected output
|
#. Confirm that ``launch_user_vm_id3.sh`` appears in the expected output
|
||||||
directory::
|
directory::
|
||||||
|
|
||||||
ls ~/acrn-work/my_board/output/launch_uos_id3.sh
|
ls ~/acrn-work/my_board/output/launch_user_vm_id3.sh
|
||||||
|
|
||||||
#. Close the browser and press :kbd:`CTRL` + :kbd:`C` to terminate the
|
#. Close the browser and press :kbd:`CTRL` + :kbd:`C` to terminate the
|
||||||
``acrn_configurator.py`` program running in the terminal window.
|
``acrn_configurator.py`` program running in the terminal window.
|
||||||
@ -510,7 +511,7 @@ Build ACRN
|
|||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
cd ~/acrn-work/acrn-kernel
|
cd ~/acrn-work/acrn-kernel
|
||||||
cp kernel_config_uefi_sos .config
|
cp kernel_config_service_vm .config
|
||||||
make olddefconfig
|
make olddefconfig
|
||||||
make -j $(nproc) targz-pkg
|
make -j $(nproc) targz-pkg
|
||||||
|
|
||||||
@ -525,19 +526,20 @@ Build ACRN
|
|||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
disk="/media/$USER/"$(ls /media/$USER)
|
disk="/media/$USER/"$(ls /media/$USER)
|
||||||
cp linux-5.10.52-acrn-sos-x86.tar.gz $disk/
|
cp linux-5.10.65-acrn-service-vm-x86.tar.gz $disk/
|
||||||
cp ~/acrn-work/acrn-hypervisor/build/hypervisor/acrn.bin $disk/
|
cp ~/acrn-work/acrn-hypervisor/build/hypervisor/acrn.bin $disk/
|
||||||
cp ~/acrn-work/acrn-hypervisor/build/hypervisor/serial.conf $disk/
|
cp ~/acrn-work/acrn-hypervisor/build/hypervisor/serial.conf $disk/
|
||||||
cp ~/acrn-work/my_board/output/launch_uos_id3.sh $disk/
|
cp ~/acrn-work/my_board/output/launch_user_vm_id3.sh $disk/
|
||||||
cp ~/acrn-work/acpica-unix-20210105/generate/unix/bin/iasl $disk/
|
cp ~/acrn-work/acpica-unix-20210105/generate/unix/bin/iasl $disk/
|
||||||
cp ~/acrn-work/acrn-hypervisor/build/acrn-2.6-unstable.tar.gz $disk/
|
cp ~/acrn-work/acrn-hypervisor/build/acrn-2.7-unstable.tar.gz $disk/
|
||||||
sync && sudo umount $disk/
|
sync && sudo umount $disk/
|
||||||
|
|
||||||
Even though our sample default scenario defines six User VMs, we're only
|
Even though our sample default scenario defines six User VMs, we're only
|
||||||
going to launch one of them, so we'll only need the one launch script.
|
going to launch one of them, so we'll only need the one launch script.
|
||||||
|
|
||||||
.. note:: The :file:`serial.conf` is only generated if non standard vUARTs (not COM1~COM4)
|
.. note:: The :file:`serial.conf` is only generated if non-standard
|
||||||
are configured for Service VM in scenario XML file.
|
vUARTs (not COM1-COM4)
|
||||||
|
are configured for the Service VM in the scenario XML file.
|
||||||
|
|
||||||
#. Insert the USB disk you just used into the target system and run these
|
#. Insert the USB disk you just used into the target system and run these
|
||||||
commands to copy the tar files locally:
|
commands to copy the tar files locally:
|
||||||
@ -545,25 +547,25 @@ Build ACRN
|
|||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
disk="/media/$USER/"$(ls /media/$USER)
|
disk="/media/$USER/"$(ls /media/$USER)
|
||||||
cp $disk/linux-5.10.52-acrn-sos-x86.tar.gz ~/acrn-work
|
cp $disk/linux-5.10.65-acrn-service-vm-x86.tar.gz ~/acrn-work
|
||||||
cp $disk/acrn-2.6-unstable.tar.gz ~/acrn-work
|
cp $disk/acrn-2.7-unstable.tar.gz ~/acrn-work
|
||||||
|
|
||||||
#. Extract the Service VM files onto the target system:
|
#. Extract the Service VM files onto the target system:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
cd ~/acrn-work
|
cd ~/acrn-work
|
||||||
sudo tar -zxvf linux-5.10.52-acrn-sos-x86.tar.gz -C / --keep-directory-symlink
|
sudo tar -zxvf linux-5.10.65-acrn-service-vm-x86.tar.gz -C / --keep-directory-symlink
|
||||||
|
|
||||||
This tar extraction replaces parts of the Ubuntu installation we installed
|
This tar extraction replaces parts of the Ubuntu installation we installed
|
||||||
and used for running the board inspector, with the Linux kernel we built
|
and used for running the Board Inspector, with the Linux kernel we built
|
||||||
based on the board and scenario configuration.
|
based on the board and scenario configuration.
|
||||||
|
|
||||||
#. Extract the ACRN tools and images:
|
#. Extract the ACRN tools and images:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
sudo tar -zxvf acrn-2.6-unstable.tar.gz -C / --keep-directory-symlink
|
sudo tar -zxvf acrn-2.7-unstable.tar.gz -C / --keep-directory-symlink
|
||||||
|
|
||||||
#. Copy a few additional ACRN files to the expected locations:
|
#. Copy a few additional ACRN files to the expected locations:
|
||||||
|
|
||||||
@ -573,7 +575,7 @@ Build ACRN
|
|||||||
sudo cp $disk/acrn.bin /boot/acrn
|
sudo cp $disk/acrn.bin /boot/acrn
|
||||||
sudo cp $disk/serial.conf /etc
|
sudo cp $disk/serial.conf /etc
|
||||||
sudo cp $disk/iasl /usr/sbin/
|
sudo cp $disk/iasl /usr/sbin/
|
||||||
cp $disk/launch_uos_id3.sh ~/acrn-work
|
cp $disk/launch_user_vm_id3.sh ~/acrn-work
|
||||||
sudo umount $disk/
|
sudo umount $disk/
|
||||||
|
|
||||||
.. rst-class:: numbered-step
|
.. rst-class:: numbered-step
|
||||||
@ -581,9 +583,10 @@ Build ACRN
|
|||||||
Install ACRN
|
Install ACRN
|
||||||
************
|
************
|
||||||
|
|
||||||
In the following steps, you will install serial configuration tool and configure GRUB on the target system.
|
In the following steps, you will install the serial configuration tool and
|
||||||
|
configure GRUB on the target system.
|
||||||
|
|
||||||
#. Install serial configuration tool in the target system as follows:
|
#. Install the serial configuration tool in the target system as follows:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -640,15 +643,15 @@ In the following steps, you will install serial configuration tool and configure
|
|||||||
|
|
||||||
#. Add the ACRN Service VM to the GRUB boot menu:
|
#. Add the ACRN Service VM to the GRUB boot menu:
|
||||||
|
|
||||||
a. Edit the GRUB 40_custom file. The following command uses ``vi``, but
|
a. Edit the GRUB ``40_custom`` file. The following command uses ``vi``, but
|
||||||
you can use any text editor.
|
you can use any text editor.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
sudo vi /etc/grub.d/40_custom
|
sudo vi /etc/grub.d/40_custom
|
||||||
|
|
||||||
#. Add the following text at the end of the file. Replace ``<UUID>`` and
|
#. Add the following text at the end of the file. Replace ``UUID`` and
|
||||||
``<PARTUUID>`` with the output from the previous step.
|
``PARTUUID`` with the output from the previous step.
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
:emphasize-lines: 6,8
|
:emphasize-lines: 6,8
|
||||||
@ -661,12 +664,10 @@ In the following steps, you will install serial configuration tool and configure
|
|||||||
search --no-floppy --fs-uuid --set "UUID"
|
search --no-floppy --fs-uuid --set "UUID"
|
||||||
echo 'loading ACRN...'
|
echo 'loading ACRN...'
|
||||||
multiboot2 /boot/acrn/acrn.bin root=PARTUUID="PARTUUID"
|
multiboot2 /boot/acrn/acrn.bin root=PARTUUID="PARTUUID"
|
||||||
module2 /boot/vmlinuz-5.10.52-acrn-sos Linux_bzImage
|
module2 /boot/vmlinuz-5.10.65-acrn-service-vm Linux_bzImage
|
||||||
}
|
}
|
||||||
|
|
||||||
#. Save and close the file.
|
Example:
|
||||||
|
|
||||||
#. Correct example image
|
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
@ -678,9 +679,11 @@ In the following steps, you will install serial configuration tool and configure
|
|||||||
search --no-floppy --fs-uuid --set "3cac5675-e329-4cal-b346-0a3e65f99016"
|
search --no-floppy --fs-uuid --set "3cac5675-e329-4cal-b346-0a3e65f99016"
|
||||||
echo 'loading ACRN...'
|
echo 'loading ACRN...'
|
||||||
multiboot2 /boot/acrn/acrn.bin root=PARTUUID="03db7f45-8a6c-454b-adf7-30343d82c4f4"
|
multiboot2 /boot/acrn/acrn.bin root=PARTUUID="03db7f45-8a6c-454b-adf7-30343d82c4f4"
|
||||||
module2 /boot/vmlinuz-5.10.52-acrn-sos Linux_bzImage
|
module2 /boot/vmlinuz-5.10.65-acrn-service-vm Linux_bzImage
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#. Save and close the file.
|
||||||
|
|
||||||
#. Make the GRUB menu visible when
|
#. Make the GRUB menu visible when
|
||||||
booting and make it load the Service VM kernel by default:
|
booting and make it load the Service VM kernel by default:
|
||||||
|
|
||||||
@ -770,7 +773,7 @@ Launch the User VM
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
vi ~/acrn-work/launch_uos_id3.sh
|
vi ~/acrn-work/launch_user_vm_id3.sh
|
||||||
|
|
||||||
#. Look for the line that contains the term ``virtio-blk`` and replace the
|
#. Look for the line that contains the term ``virtio-blk`` and replace the
|
||||||
existing image file path with your ISO image file path. In the following
|
existing image file path with your ISO image file path. In the following
|
||||||
@ -796,10 +799,10 @@ Launch the User VM
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
sudo chmod +x ~/acrn-work/launch_uos_id3.sh
|
sudo chmod +x ~/acrn-work/launch_user_vm_id3.sh
|
||||||
sudo chmod +x /usr/bin/acrn-dm
|
sudo chmod +x /usr/bin/acrn-dm
|
||||||
sudo chmod +x /usr/sbin/iasl
|
sudo chmod +x /usr/sbin/iasl
|
||||||
sudo ~/acrn-work/launch_uos_id3.sh
|
sudo ~/acrn-work/launch_user_vm_id3.sh
|
||||||
|
|
||||||
#. It will take a few seconds for the User VM to boot and start running the
|
#. It will take a few seconds for the User VM to boot and start running the
|
||||||
Ubuntu image. Confirm that you see the console of the User VM on the Service
|
Ubuntu image. Confirm that you see the console of the User VM on the Service
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Binary file not shown.
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Binary file not shown.
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 48 KiB |
Loading…
Reference in New Issue
Block a user