doc: update docs and images to match scenario names

Update the docs and images referencing ``industry`` and ``logical_partition`` scenarios to
``shared`` and ``partioned``.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2021-09-30 14:49:35 -07:00 committed by David Kinder
parent 8ccb0d3e74
commit e03f0045dc
21 changed files with 25 additions and 20 deletions

View File

@ -8,7 +8,7 @@ Getting Started Guide
This guide will help you get started with ACRN. We'll show how to prepare a
build environment on your development computer. Then we'll walk through the
steps to set up a simple ACRN configuration on a target system. The
configuration is based on the ACRN predefined **industry** scenario and consists
configuration is based on the ACRN predefined **shared** scenario and consists
of an ACRN hypervisor, Service VM, and one User VM, as illustrated in this
figure:
@ -437,7 +437,7 @@ To generate a scenario configuration file and launch script:
.. image:: ./images/gsg_config_scenario_default.png
:class: drop-shadow
#. In the dialog box, select **industry** as the default scenario setting and
#. In the dialog box, select **shared** as the default scenario setting and
then click **OK**.
.. image:: ./images/gsg_config_scenario_load.png
@ -461,7 +461,7 @@ To generate a scenario configuration file and launch script:
.. image:: ./images/gsg_config_scenario_save.png
:class: drop-shadow
#. Confirm that ``industry.xml`` appears in the directory
#. Confirm that ``shared.xml`` appears in the directory
``/home/<username>/acrn-work``.
#. Generate the launch script:
@ -472,7 +472,7 @@ To generate a scenario configuration file and launch script:
.. image:: ./images/gsg_config_launch_default.png
:class: drop-shadow
#. In the dialog box, select **industry_launch_6uos** as the default launch
#. In the dialog box, select **shared_launch_6uos** as the default launch
setting and click **OK**.
.. image:: ./images/gsg_config_launch_load.png
@ -506,7 +506,7 @@ Build ACRN
.. code-block:: bash
cd ~/acrn-work/acrn-hypervisor
make -j $(nproc) BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml
make -j $(nproc) BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/shared.xml
make targz-pkg
The build typically takes a few minutes. By default, the build results are

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

@ -319,7 +319,8 @@ Project ACRN provides some predefined sample scenarios to illustrate how you
can define your own configuration scenarios.
* **Industry** is a traditional computing, memory, and device resource sharing
* **Shared** (called **Industry** in previous releases) is a traditional
computing, memory, and device resource sharing
model among VMs. The ACRN hypervisor launches the Service VM. The Service VM
then launches any post-launched User VMs and provides device and resource
sharing mediation through the Device Model. The Service VM runs the native
@ -331,7 +332,7 @@ can define your own configuration scenarios.
:align: center
:name: arch-shared-example
ACRN High-Level Architecture Industry (Shared) Example
ACRN High-Level Architecture Shared Example
Virtualization is especially important in industrial environments because of
device and application longevity. Virtualization enables factories to

View File

@ -76,19 +76,19 @@ Example of a command to build the debug version:
.. code-block:: none
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/shared.xml
Example of a command to build the release version:
.. code-block:: none
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml RELEASE=y
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/shared.xml RELEASE=y
Example of a command to build the release version (hypervisor only):
.. code-block:: none
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml RELEASE=y hypervisor
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/shared.xml RELEASE=y hypervisor
Example of a command to build the release version of the Device Model and tools:
@ -101,13 +101,13 @@ Example of a command to put the built files in the specified directory
.. code-block:: none
make O=build-nuc BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml
make O=build-nuc BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/shared.xml
Example of a command that specifies ``iasl`` compiler:
.. code-block:: none
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/industry.xml ASL_COMPILER=/usr/local/bin/iasl
make BOARD=~/acrn-work/my_board.xml SCENARIO=~/acrn-work/shared.xml ASL_COMPILER=/usr/local/bin/iasl
ACRN uses XML files to summarize board characteristics and scenario settings.
The ``BOARD`` and ``SCENARIO`` variables accept board/scenario names as well
@ -171,7 +171,7 @@ files manually (``scenario.xml``) and then building the hypervisor:
.. code-block:: none
make BOARD=nuc7i7dnb SCENARIO=industry hvdefconfig
make BOARD=nuc7i7dnb SCENARIO=shared hvdefconfig
vim build/hypervisor/.scenario.xml
#(Modify the XML file per your needs)
make

View File

@ -152,7 +152,7 @@ The default scheduler is **SCHED_BVT**.
Example
*******
Use the following settings to support this configuration in the industry scenario:
Use the following settings to support this configuration in the shared scenario:
+---------+--------+-------+-------+
|pCPU0 |pCPU1 |pCPU2 |pCPU3 |

View File

@ -205,7 +205,7 @@ How to Test
#. Refer to the :ref:`enable_s5` section to set up the S5 environment for the User VMs.
.. note:: RT-Linux's UUID must use ``495ae2e5-2603-4d64-af76-d4bc5a8ec0e5``. Also, the
industry EFI image is required for launching the RT-Linux VM.
shared EFI image is required for launching the RT-Linux VM.
.. note:: Use the ``systemctl status life_mngr.service`` command to ensure the service is working on the LaaG or RT-Linux:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

@ -1,13 +1,13 @@
.. _using_partition_mode_on_nuc:
Getting Started Guide for ACRN Logical Partition Mode
#####################################################
Getting Started Guide for ACRN Partitioned Mode
###############################################
The ACRN hypervisor supports a logical partition scenario in which the User
The ACRN hypervisor supports a partitioned scenario in which the User
OS, running in a pre-launched VM, can bypass the ACRN
hypervisor and directly access isolated PCI devices. The following
guidelines provide step-by-step instructions on how to set up the ACRN
hypervisor logical partition scenario on Intel NUC while running two
hypervisor partitioned scenario on Intel NUC while running two
pre-launched VMs.
.. contents::
@ -20,6 +20,10 @@ Validated Versions
- Ubuntu version: **18.04**
- ACRN hypervisor tag: **v2.6**
.. note:: After the v2.6 release, the ``logical_partition`` scenario
was renamed to ``partitioned``, affecting the file names used in this
guide (validated with v2.6).
Prerequisites
*************

View File

@ -104,6 +104,6 @@ then add it to the grub menu:
``uart=bdf@0x101`` for port 2
``uart=bdf@0x101`` is preferred for the industry scenario; otherwise, it can't
``uart=bdf@0x101`` is preferred for the shared scenario; otherwise, it can't
input in the Hypervisor console after the Service VM boots up.
There is no such limitation for the hybrid or hybrid_rt scenarios.