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

doc: fix correct use of Clear Linux OS

Browse Source 
Proper use of the Clear Linux name is with a noun, specifically "OS".
Also fixed some grammar edits along the way.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-01-30 15:05:21 -08:00 committed by David Kinder
parent fc887eade4
commit 0881bae738
17 changed files with 108 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/developer-guides/hld/hld-overview.rst
View File

@ -42,7 +42,7 @@ A typical In-Vehicle Infotainment (IVI) system would support:
- connection to IVI front system and mobile devices (cloud - connection to IVI front system and mobile devices (cloud
connectivity) connectivity)
ACRN supports guest OSes of Clear Linux and Android. OEMs can use the ACRN ACRN supports guest OSes of Clear Linux OS and Android. OEMs can use the ACRN
hypervisor and Linux or Android guest OS reference code to implement their own hypervisor and Linux or Android guest OS reference code to implement their own
VMs for a customized IC/IVI/RSE. VMs for a customized IC/IVI/RSE.

2
doc/developer-guides/hld/hld-security.rst
View File

@ -184,7 +184,7 @@ securely.
SOS Hardening SOS Hardening
------------- -------------
In project ACRN, the reference SOS is based on Clear Linux. Customers In project ACRN, the reference SOS is based on Clear Linux OS. Customers
may choose to use different open source OSes or their own proprietary OS may choose to use different open source OSes or their own proprietary OS
systems. To minimize the attack surfaces and achieve the goal of systems. To minimize the attack surfaces and achieve the goal of
"defense in depth", there are many common guidelines to ensure the "defense in depth", there are many common guidelines to ensure the

2
doc/developer-guides/primer.rst
View File

@ -90,7 +90,7 @@ ACRN Device Model source tree
files are used to generate the :ref:`acrn_apis` documentation) files are used to generate the :ref:`acrn_apis` documentation)
**samples/** **samples/**
scripts (included in the Clear Linux build) for setting up the network scripts (included in the Clear Linux OS build) for setting up the network
and launching the User OS on the platform. and launching the User OS on the platform.
ACRN Tools source tree ACRN Tools source tree

4
doc/faq.rst
View File

@ -17,8 +17,8 @@ What hardware does ACRN support?
ACRN runs on Intel Apollo Lake and Kaby Lake boards, as documented in ACRN runs on Intel Apollo Lake and Kaby Lake boards, as documented in
our :ref:`hardware` documentation. our :ref:`hardware` documentation.
Clear Linux* fails to boot on my NUC Clear Linux* OS fails to boot on my NUC
************************************ ***************************************
If you're following the :ref:`getting_started` documentation and the NUC If you're following the :ref:`getting_started` documentation and the NUC
fails to boot, here are some options to try: fails to boot, here are some options to try:

55
doc/getting-started/apl-nuc.rst
View File

@ -37,33 +37,33 @@ complete this setup.
.. note:: .. note::
Please refer to Release Note for the Clear Linux version number, and Please refer to the ACRN :ref:`release_notes` for the Clear Linux OS
you will need to adjust the instruction below to reference the version version number tested with a specific ACRN release. Adjust the
number of Clear Linux you are using. Below document will use version instruction below to reference the appropriate version number of Clear
27230 as example. Linux OS (we use version 27230 as an example).
#. Download the compressed Clear installer image from #. Download the compressed Clear Linux OS installer image from
https://download.clearlinux.org/releases/27230/clear/clear-27230-installer.img.xz https://download.clearlinux.org/releases/27230/clear/clear-27230-installer.img.xz
and follow the `Clear Linux installation guide and follow the `Clear Linux OS installation guide
<https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install>`__ <https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install>`__
as a starting point for installing Clear Linux onto your platform. Follow the recommended as a starting point for installing Clear Linux OS onto your platform. Follow the recommended
options for choosing an **Manual (Advanced)** installation type, and using the platform's options for choosing an **Manual (Advanced)** installation type, and using the platform's
storage as the target device for installation (overwriting the existing data storage as the target device for installation (overwriting the existing data
and creating three partitions on the platform's storage drive). and creating three partitions on the platform's storage drive).
High-level steps should be: High-level steps should be:
#. Install Clear on a NUC using the "Manual (Advanced)" option. #. Install Clear Linux OS on a NUC using the "Manual (Advanced)" option.
#. Use default partition scheme for storage #. Use default partition scheme for storage
#. Name the host "clr-sos-guest" #. Name the host "clr-sos-guest"
#. Add an administrative user "clear" with "sudoers" privilege #. Add an administrative user "clear" with "sudoers" privilege
#. Add these additional bundles "editors", "user-basic", "desktop-autostart", "network-basic" #. Add these additional bundles "editors", "user-basic", "desktop-autostart", "network-basic"
#. For network, choose “DHCP” #. For network, choose “DHCP”
#. After installation is complete, boot into Clear Linux, login as #. After installation is complete, boot into Clear Linux OS, login as
**clear**, and set a password. **clear**, and set a password.
#. Clear Linux is set to automatically update itself. We recommend that you disable #. Clear Linux OS is set to automatically update itself. We recommend that you disable
this feature to have more control over when the updates happen. Use this command this feature to have more control over when the updates happen. Use this command
to disable the autoupdate feature: to disable the autoupdate feature:
@ -72,26 +72,26 @@ complete this setup.
$ sudo swupd autoupdate --disable $ sudo swupd autoupdate --disable
.. note:: .. note::
The Clear Linux installer will automatically check for updates and install the The Clear Linux OS installer will automatically check for updates and install the
latest version available on your system. If you wish to use a specific version latest version available on your system. If you wish to use a specific version
(such as 27230), you can achieve that after the installation has completed using (such as 27230), you can achieve that after the installation has completed using
``sudo swupd verify --fix --picky -m 27230`` ``sudo swupd verify --fix --picky -m 27230``
#. If you have an older version of Clear Linux already installed #. If you have an older version of Clear Linux OS already installed
on your hardware, use this command to upgrade Clear Linux on your hardware, use this command to upgrade Clear Linux OS
to version 27230 (or newer): to version 27230 (or newer):
.. code-block:: none .. code-block:: none
$ sudo swupd update -m 27230 # or newer version $ sudo swupd update -m 27230 # or newer version
#. Use the ``sudo swupd bundle-add`` command and add these Clear Linux bundles: #. Use the ``sudo swupd bundle-add`` command and add these Clear Linux OS bundles:
.. code-block:: none .. code-block:: none
$ sudo swupd bundle-add service-os kernel-iot-lts2018 $ sudo swupd bundle-add service-os kernel-iot-lts2018
.. table:: Clear Linux bundles .. table:: Clear Linux OS bundles
:widths: auto :widths: auto
:name: CL-bundles :name: CL-bundles
@ -125,7 +125,7 @@ partition. Follow these steps:
loaderx64.efi loaderx64.efi
.. note:: .. note::
On Clear Linux, the EFI System Partion (e.g.: ``/dev/sda1``) is mounted under ``/boot`` by default On Clear Linux OS, the EFI System Partion (e.g.: ``/dev/sda1``) is mounted under ``/boot`` by default
The Clear Linux project releases updates often, sometimes The Clear Linux project releases updates often, sometimes
twice a day, so make note of the specific kernel versions (*iot-lts2018 and *iot-lts2018-sos*) listed on your system, twice a day, so make note of the specific kernel versions (*iot-lts2018 and *iot-lts2018-sos*) listed on your system,
as you will need them later. as you will need them later.
@ -138,7 +138,7 @@ partition. Follow these steps:
(NVMe). (NVMe).
#. Put the ``acrn.efi`` hypervisor application (included in the Clear #. Put the ``acrn.efi`` hypervisor application (included in the Clear
Linux release) on the EFI partition with: Linux OS release) on the EFI partition with:
.. code-block:: none .. code-block:: none
@ -158,8 +158,8 @@ partition. Follow these steps:
.. note:: .. note::
Be aware that a Clearlinux update that includes a kernel upgrade will Be aware that a Clear Linux OS update that includes a kernel upgrade will
reset the boot option changes you just made. A Clearlinux update could reset the boot option changes you just made. A Clear Linux OS update could
happen automatically (if you have not disabled it as described above), happen automatically (if you have not disabled it as described above),
if you later install a new bundle to your system, or simply if you if you later install a new bundle to your system, or simply if you
decide to trigger an update manually. Whenever that happens, decide to trigger an update manually. Whenever that happens,
@ -171,7 +171,7 @@ partition. Follow these steps:
1. ``bootloader=``: this sets the EFI executable to be loaded once the hypervisor 1. ``bootloader=``: this sets the EFI executable to be loaded once the hypervisor
is up and running. This is typically the bootloader of the Service OS and the is up and running. This is typically the bootloader of the Service OS and the
default value is to use the Clearlinux bootloader, i.e.: default value is to use the Clear Linux OS bootloader, i.e.:
``\EFI\org.clearlinux\bootloaderx64.efi``. ``\EFI\org.clearlinux\bootloaderx64.efi``.
#. ``uart=``: this tells the hypervisor where the serial port (UART) is found or #. ``uart=``: this tells the hypervisor where the serial port (UART) is found or
whether it should be disabled. There are three forms for this parameter: whether it should be disabled. There are three forms for this parameter:
@ -209,7 +209,8 @@ partition. Follow these steps:
| options | Options to pass to the Service OS kernel (kernel parameters) | | options | Options to pass to the Service OS kernel (kernel parameters) |
+-----------+----------------------------------------------------------------+ +-----------+----------------------------------------------------------------+
A starter acrn.conf configuration file is included in the Clear Linux release and is A starter acrn.conf configuration file is included in the Clear Linux
OS release and is
also available in the acrn-hypervisor/hypervisor GitHub repo as `acrn.conf also available in the acrn-hypervisor/hypervisor GitHub repo as `acrn.conf
<https://github.com/projectacrn/acrn-hypervisor/blob/master/efi-stub/clearlinux/acrn.conf>`__ <https://github.com/projectacrn/acrn-hypervisor/blob/master/efi-stub/clearlinux/acrn.conf>`__
as shown here: as shown here:
@ -234,7 +235,7 @@ partition. Follow these steps:
It is also possible to use the device name directly, e.g. ``root=/dev/sda3`` It is also possible to use the device name directly, e.g. ``root=/dev/sda3``
#. Add a timeout period for Systemd-Boot to wait, otherwise it will not #. 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 present the boot menu and will always boot the base Clear Linux OS
.. code-block:: none .. code-block:: none
@ -257,13 +258,13 @@ partition. Follow these steps:
Reboot Into Firmware Interface Reboot Into Firmware Interface
#. After booting up the ACRN hypervisor, the Service OS will be launched #. After booting up the ACRN hypervisor, the Service OS will be launched
automatically by default, and the Clear Linux desktop will be showing with user "clear", automatically by default, and the Clear Linux OS desktop will be showing with user "clear",
(or you can login remotely with an "ssh" client). (or you can login remotely with an "ssh" client).
If there is any issue which makes the GNOME desktop doesn't show successfully, then the system will go to If there is any issue which makes the GNOME desktop doesn't show successfully, then the system will go to
shell console. shell console.
#. From ssh client, login as user "clear" using the password you set previously when #. From ssh client, login as user "clear" using the password you set previously when
you installed Clear Linux. you installed Clear Linux OS.
#. After rebooting the system, check that the ACRN hypervisor is running properly with: #. After rebooting the system, check that the ACRN hypervisor is running properly with:
@ -290,7 +291,7 @@ automatically enabled after a system restart.
Set up Reference UOS Set up Reference UOS
==================== ====================
#. On your platform, download the pre-built reference Clear Linux UOS #. On your platform, download the pre-built reference Clear Linux OS UOS
image version 27230 (or newer) into your (root) home directory: image version 27230 (or newer) into your (root) home directory:
.. code-block:: none .. code-block:: none
@ -301,7 +302,7 @@ Set up Reference UOS
$ curl https://download.clearlinux.org/releases/27230/clear/clear-27230-kvm.img.xz -o uos.img.xz $ curl https://download.clearlinux.org/releases/27230/clear/clear-27230-kvm.img.xz -o uos.img.xz
.. note:: .. note::
In case you want to use or try out a newer version of Clear Linux as the UOS, you can In case you want to use or try out a newer version of Clear Linux OS as the UOS, you can
download the latest from http://download.clearlinux.org/image. Make sure to adjust the steps 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). described below accordingly (image file name and kernel modules version).
@ -326,7 +327,7 @@ Set up Reference UOS
A sample `launch_uos.sh A sample `launch_uos.sh
<https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/devicemodel/samples/nuc/launch_uos.sh>`__ <https://raw.githubusercontent.com/projectacrn/acrn-hypervisor/master/devicemodel/samples/nuc/launch_uos.sh>`__
is included in the Clear Linux release, and is included in the Clear Linux OS release, and
is also available in the acrn-hypervisor/devicemodel GitHub repo (in the samples is also available in the acrn-hypervisor/devicemodel GitHub repo (in the samples
folder) as shown here: folder) as shown here:

2
doc/getting-started/building-from-source.rst
View File

@ -16,7 +16,7 @@ each with their own way to install development tools:
ACRN uses ``menuconfig``, a python3 text-based user interface (TUI) for ACRN uses ``menuconfig``, a python3 text-based user interface (TUI) for
configuring hypervisor options and using python's ``kconfiglib`` library. configuring hypervisor options and using python's ``kconfiglib`` library.
* On a Clear Linux development system, install the necessary tools: * On a Clear Linux OS development system, install the necessary tools:
.. code-block:: none .. code-block:: none

2
doc/release_notes_0.1.rst
View File

@ -71,7 +71,7 @@ Known Issues
:acrn-issue:`663` - Black screen displayed after booting SOS/UOS :acrn-issue:`663` - Black screen displayed after booting SOS/UOS
The ``weston`` display server, window manager, and compositor used by ACRN The ``weston`` display server, window manager, and compositor used by ACRN
(from Clear Linux) may not have been properly installed and started. (from Clear Linux OS) may not have been properly installed and started.
**Workaround** is described in ACRN GitHub issue :acrn-issue:`663`. **Workaround** is described in ACRN GitHub issue :acrn-issue:`663`.
:acrn-issue:`677` - SSD Disk ID not consistent between SOS/UOS :acrn-issue:`677` - SSD Disk ID not consistent between SOS/UOS

2
doc/release_notes_0.2.rst
View File

@ -133,7 +133,7 @@ Fixed Issues
* :acrn-issue:`721` - DM for IPU mediation * :acrn-issue:`721` - DM for IPU mediation
* :acrn-issue:`707` - Issues found with instructions for using Ubuntu as SOS * :acrn-issue:`707` - Issues found with instructions for using Ubuntu as SOS
* :acrn-issue:`706` - Invisible mouse cursor in UOS * :acrn-issue:`706` - Invisible mouse cursor in UOS
* :acrn-issue:`424` - Clear Linux desktop GUI of SOS fails to launch * :acrn-issue:`424` - Clear Linux OS desktop GUI of SOS fails to launch
Known Issues Known Issues

3
doc/release_notes_0.3.rst
View File

@ -138,7 +138,8 @@ Known Issues
After SOS boots up with both "desktop" and "soft-defined-cockpit" bundles installed After SOS boots up with both "desktop" and "soft-defined-cockpit" bundles installed
or without any, there's no output on SOS screen. or without any, there's no output on SOS screen.
**Impact:** Cannot access SOS. **Impact:** Cannot access SOS.
**Workaround:** Only install "desktop" bundle, then enable and start weston in Native Clear Linux, **Workaround:** Only install "desktop" bundle, then enable and start
weston in Native Clear Linux OS,
and then reboot to SOS. The issues will be fixed in the next release. and then reboot to SOS. The issues will be fixed in the next release.
:acrn-issue:`1795` - [KBL NUC] SOS fails to get IP address :acrn-issue:`1795` - [KBL NUC] SOS fails to get IP address

4
doc/release_notes_0.5.rst
View File

@ -55,7 +55,7 @@ now supports APL UP2 board with slim Bootloader (SBL) firmware.
Slim Bootloader is a modern, flexible, light-weither, open source Slim Bootloader is a modern, flexible, light-weither, open source
reference boot loader with key benefits such as being fast, small, reference boot loader with key benefits such as being fast, small,
customizable, and secure. An end-to-end reference build with customizable, and secure. An end-to-end reference build with
ACRN hypervisor, Clear Linux as SOS, and Clear Linux as UOS has been ACRN hypervisor, Clear Linux OS as SOS, and Clear Linux OS as UOS has been
verified on UP2/SBL board. See the :ref:`using-sbl-up2` documentation verified on UP2/SBL board. See the :ref:`using-sbl-up2` documentation
for step-by-step instructions. for step-by-step instructions.
@ -95,7 +95,7 @@ for step-by-step instructions.
- :acrn-issue:`2079` - Replace banned API with permitted API function in a crn device-model - :acrn-issue:`2079` - Replace banned API with permitted API function in a crn device-model
- :acrn-issue:`2120` - Optimize trusty logic to meet MISRA-C rules - :acrn-issue:`2120` - Optimize trusty logic to meet MISRA-C rules
- :acrn-issue:`2145` - Reuse linux common virtio header file for virtio - :acrn-issue:`2145` - Reuse linux common virtio header file for virtio
- :acrn-issue:`2170` - For UEFI based hardware platforms, one ClearLinux E2E build binary can be used for all platform's installation - :acrn-issue:`2170` - For UEFI based hardware platforms, one Clear Linux OS E2E build binary can be used for all platform's installation
- :acrn-issue:`2187` - Complete the cleanup of unbounded APIs usage - :acrn-issue:`2187` - Complete the cleanup of unbounded APIs usage
Fixed Issues Fixed Issues

26
doc/tutorials/agl-vms.rst
View File

@ -24,7 +24,7 @@ meter, the In-Vehicle Infotainment (IVI) system, and the rear seat
entertainment (RSE). For the software, there are three VMs running on entertainment (RSE). For the software, there are three VMs running on
top of ACRN: top of ACRN:
* Clear Linux runs as the service OS (SOS) to control the cluster meter, * Clear Linux OS runs as the service OS (SOS) to control the cluster meter,
* an AGL instance runs as a user OS (UOS) controlling the IVI display, and * an AGL instance runs as a user OS (UOS) controlling the IVI display, and
* a second AGL UOS controls the RSE display. * a second AGL UOS controls the RSE display.
@ -111,9 +111,9 @@ The demo setup uses these software components and versions:
* - ACRN hypervisor * - ACRN hypervisor
- 0.3 - 0.3
- `ACRN project <https://github.com/projectacrn/acrn-hypervisor>`_ - `ACRN project <https://github.com/projectacrn/acrn-hypervisor>`_
* - Clear Linux * - Clear Linux OS
- 26200 - 26200
- `Clear Linux installer image - `Clear Linux OS installer image
<https://download.clearlinux.org/releases/26200/clear/clear-26200-installer.img.xz>`_ <https://download.clearlinux.org/releases/26200/clear/clear-26200-installer.img.xz>`_
* - AGL * - AGL
- Funky Flounder (6.02) - Funky Flounder (6.02)
@ -126,34 +126,34 @@ The demo setup uses these software components and versions:
Service OS Service OS
========== ==========
#. Download the compressed Clear installer image from #. Download the compressed Clear Linux OS installer image from
https://download.clearlinux.org/releases/26200/clear/clear-26200-installer.img.xz https://download.clearlinux.org/releases/26200/clear/clear-26200-installer.img.xz
and follow the `Clear Linux installation guide and follow the `Clear Linux OS installation guide
<https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install>`_ <https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install>`_
as a starting point for installing Clear Linux onto your platform. as a starting point for installing Clear Linux OS onto your platform.
Follow the recommended options for choosing an Automatic installation Follow the recommended options for choosing an Automatic installation
type, and using the platform’s storage as the target device for type, and using the platform’s storage as the target device for
installation (overwriting the existing data and creating three installation (overwriting the existing data and creating three
partitions on the platform’s storage drive). partitions on the platform’s storage drive).
#. After installation is complete, boot into Clear Linux, login as #. After installation is complete, boot into Clear Linux OS, login as
root, and set a password. root, and set a password.
#. Clear Linux is set to automatically update itself. We recommend that #. Clear Linux OS is set to automatically update itself. We recommend that
you disable this feature to have more control over when the updates you disable this feature to have more control over when the updates
happen. Use this command (as root) to disable the autoupdate feature:: happen. Use this command (as root) to disable the autoupdate feature::
# swupd autoupdate --disable # swupd autoupdate --disable
#. This demo setup uses a specific release version (26200) of Clear #. This demo setup uses a specific release version (26200) of Clear
Linux which has been verified to work with ACRN. In case you Linux OS which has been verified to work with ACRN. In case you
unintentionally update or change the Clear Linux version, you can unintentionally update or change the Clear Linux OS version, you can
fix it again using:: fix it again using::
# swupd verify --fix --picky -m 26200 # swupd verify --fix --picky -m 26200
#. Use the ``swupd bundle-add`` command and add needed Clear Linux #. Use the ``swupd bundle-add`` command and add needed Clear Linux
bundles:: OS bundles::
# swupd bundle-add openssh-server sudo network-basic \ # swupd bundle-add openssh-server sudo network-basic \
kernel-iot-lts2018 os-clr-on-clr os-core-dev \ kernel-iot-lts2018 os-clr-on-clr os-core-dev \
@ -186,7 +186,7 @@ Service OS
#. Build ACRN. In this demo we use the ACRN v0.3 release. #. Build ACRN. In this demo we use the ACRN v0.3 release.
Open a terminal window in Clear Linux desktop, create a workspace, Open a terminal window in Clear Linux OS desktop, create a workspace,
install needed tools, clone the ACRN Hypervisor repo source, and build ACRN:: install needed tools, clone the ACRN Hypervisor repo source, and build ACRN::
$ mkdir workspace $ mkdir workspace
@ -229,7 +229,7 @@ Service OS
$ sudo clr-boot-manager update $ sudo clr-boot-manager update
#. Reboot the system, choose "ACRN Hypervisor" and launch Clear Linux #. Reboot the system, choose "ACRN Hypervisor" and launch Clear Linux OS
SOS. If the EFI boot order is not right, use :kbd:`F10` SOS. If the EFI boot order is not right, use :kbd:`F10`
on boot up to enter the EFI menu and choose "ACRN Hypervisor". on boot up to enter the EFI menu and choose "ACRN Hypervisor".

75
doc/tutorials/building_uos_from_clearlinux.rst
View File

@ -1,40 +1,39 @@
.. _build UOS from Clearlinux: .. _build UOS from Clearlinux:
Building UOS from Clear Linux Building UOS from Clear Linux OS
############################# ################################
This document builds on the :ref:`getting_started`, This document builds on the :ref:`getting_started`,
and explains how to build UOS from Clear Linux. and explains how to build UOS from Clear Linux OS.
Build UOS image in Clear Linux native
*************************************
In order to build out the image of UOS, Build UOS image in Clear Linux OS
follow these steps to build a UOS image from Clear Linux: *********************************
#. In Clear Linux native, install ``ister`` (a template-based Follow these steps to build a UOS image from Clear Linux OS:
installer for Linux) included in the Clear Linux bundle
#. In Clear Linux OS, install ``ister`` (a template-based
installer for Linux) included in the Clear Linux OS bundle
``os-installer``. ``os-installer``.
For more information about ``ister``, For more information about ``ister``,
please visit https://github.com/bryteise/ister. please visit https://github.com/bryteise/ister.
.. code-block:: none .. code-block:: none
$ sudo swupd bundle-add os-installer $ sudo swupd bundle-add os-installer
#. After installation is complete, use ``ister.py`` to #. After installation is complete, use ``ister.py`` to
generate the image for UOS with the configuration in generate the image for UOS with the configuration in
``uos-image.json``: ``uos-image.json``:
.. code-block:: none .. code-block:: none
$ cd ~ $ cd ~
$ sudo ister.py -t uos-image.json $ sudo ister.py -t uos-image.json
An example of the configuration file ``uos-image.json``: An example of the configuration file ``uos-image.json``:
.. code-block:: none .. code-block:: none
{ {
"DestinationType" : "virtual", "DestinationType" : "virtual",
"PartitionLayout" : [ { "disk" : "uos.img", "PartitionLayout" : [ { "disk" : "uos.img",
@ -76,17 +75,17 @@ follow these steps to build a UOS image from Clear Linux:
} }
.. note:: .. note::
To generate the image with a specified version, To generate the image with a specified version,
please modify the ``"Version"`` argument, please modify the ``"Version"`` argument,
and we can set ``"Version": 26550`` instead of and we can set ``"Version": 26550`` instead of
``"Version": "latest"`` for example. ``"Version": "latest"`` for example.
Here we will use ``"Version": 26550`` for example, Here we will use ``"Version": 26550`` for example,
and the UOS image called ``uos.img`` will be generated and the UOS image called ``uos.img`` will be generated
after successful installation. An example output log is: after successful installation. An example output log is:
.. code-block:: none .. code-block:: none
Reading configuration Reading configuration
Validating configuration Validating configuration
Creating virtual disk Creating virtual disk
@ -98,19 +97,19 @@ follow these steps to build a UOS image from Clear Linux:
Installing 9 bundles (and dependencies)... Installing 9 bundles (and dependencies)...
Verifying version 26550 Verifying version 26550
Downloading packs... Downloading packs...
Extracting emacs pack for version 26550 Extracting emacs pack for version 26550
Extracting vim pack for version 26550 Extracting vim pack for version 26550
... ...
Cleaning up Cleaning up
Successful installation Successful installation
#. On your target device, boot the system and select "The ACRN Service OS", as shown below: #. On your target device, boot the system and select "The ACRN Service OS", as shown below:
.. code-block:: console .. code-block:: console
:emphasize-lines: 1 :emphasize-lines: 1
=> The ACRN Service OS => The ACRN Service OS
Clear Linux OS for Intel Architecture (Clear-linux-iot-lts2018-4.19.0-19) Clear Linux OS for Intel Architecture (Clear-linux-iot-lts2018-4.19.0-19)
Clear Linux OS for Intel Architecture (Clear-linux-iot-lts2018-sos-4.19.0-19) Clear Linux OS for Intel Architecture (Clear-linux-iot-lts2018-sos-4.19.0-19)
@ -136,24 +135,24 @@ Start the User OS (UOS)
default-iot-lts2018 -> org.clearlinux.iot-lts2018.4.19.0-26 default-iot-lts2018 -> org.clearlinux.iot-lts2018.4.19.0-26
install.d install.d
org.clearlinux.iot-lts2018.4.19.0-26 org.clearlinux.iot-lts2018.4.19.0-26
#. Adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh`` #. Adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh``
script to match your installation. script to match your installation.
These are the couple of lines you need to modify: These are the couple of lines you need to modify:
.. code-block:: none .. code-block:: none
-s 3,virtio-blk,~/uos.img \ -s 3,virtio-blk,~/uos.img \
-k /mnt/usr/lib/kernel/default-iot-lts2018 \ -k /mnt/usr/lib/kernel/default-iot-lts2018 \
.. note:: .. note::
UOS image ``uos.img`` is in the directory ``~/`` UOS image ``uos.img`` is in the directory ``~/``
and UOS kernel ``default-iot-lts2018`` is in ``/mnt/usr/lib/kernel/``. and UOS kernel ``default-iot-lts2018`` is in ``/mnt/usr/lib/kernel/``.
#. You are now all set to start the User OS (UOS): #. You are now all set to start the User OS (UOS):
.. code-block:: none .. code-block:: none
$ sudo /usr/share/acrn/samples/nuc/launch_uos.sh $ sudo /usr/share/acrn/samples/nuc/launch_uos.sh
You are now watching the User OS booting up! You are now watching the User OS booting up!

2
doc/tutorials/docbuild.rst
View File

@ -137,7 +137,7 @@ Our documentation processing has been tested to run with:
Depending on your Linux version, install the needed tools: Depending on your Linux version, install the needed tools:
* For Clear Linux: follow the :ref:`getting-started-apl-nuc` to install * For Clear Linux OS: follow the :ref:`getting-started-apl-nuc` to install
all the tools required all the tools required
* For Ubuntu use: * For Ubuntu use:

6
doc/tutorials/skl-nuc.rst
View File

@ -21,7 +21,7 @@ Software Configuration
<https://github.com/projectacrn/acrn-hypervisor/releases/tag/acrn-2018w39.6-140000p>`_ <https://github.com/projectacrn/acrn-hypervisor/releases/tag/acrn-2018w39.6-140000p>`_
* `acrn-kernel tag acrn-2018w39.6-140000p * `acrn-kernel tag acrn-2018w39.6-140000p
<https://github.com/projectacrn/acrn-kernel/releases/tag/acrn-2018w39.6-140000p>`_ <https://github.com/projectacrn/acrn-kernel/releases/tag/acrn-2018w39.6-140000p>`_
* Clear Linux: version: 25130 (UOS and SOS use this version) * Clear Linux OS: version: 25130 (UOS and SOS use this version)
Source code patches are provided in `skl-patches-for-acrn.tar file Source code patches are provided in `skl-patches-for-acrn.tar file
<../_static/downloads/skl-patches-for-acrn.tar>`_ to work around or add support for <../_static/downloads/skl-patches-for-acrn.tar>`_ to work around or add support for
@ -40,7 +40,7 @@ Please follow the :ref:`getting-started-apl-nuc`, with the following changes:
1. Set up a Clear Linux Operating System 1. Set up a Clear Linux Operating System
Clear Linux will update to the latest version during installation. Clear Linux OS will update to the latest version during installation.
Run this command (as root) to roll back to version 25130, using the Run this command (as root) to roll back to version 25130, using the
``–x`` switch to ignore version mismatch:: ``–x`` switch to ignore version mismatch::
@ -72,7 +72,7 @@ Please follow the :ref:`getting-started-apl-nuc`, with the following changes:
# cp build/devicemodel/acrn-dm /usr/bin/acrn-dm # cp build/devicemodel/acrn-dm /usr/bin/acrn-dm
#. Put the new ``acrn.efi`` hypervisor application (included in the #. Put the new ``acrn.efi`` hypervisor application (included in the
Clear Linux release) on the EFI partition (as root):: Clear Linux OS release) on the EFI partition (as root)::
# mount /dev/nvme0n1p1 /mnt # mount /dev/nvme0n1p1 /mnt
# mkdir /mnt/EFI/acrn # mkdir /mnt/EFI/acrn

4
doc/tutorials/static-ip.rst
View File

@ -12,7 +12,7 @@ address. You need ``root`` privileges to make these changes to the system.
ACRN Network Setup ACRN Network Setup
****************** ******************
The ACRN Service OS is based on `Clear Linux`_ and it uses `systemd-networkd`_ The ACRN Service OS is based on `Clear Linux OS`_ and it uses `systemd-networkd`_
to set up the Service OS networking. A few files are responsible for setting up the to set up the Service OS networking. A few files are responsible for setting up the
ACRN bridge (``acrn-br0``), the TAP device (``acrn_tap0``), and how these are all ACRN bridge (``acrn-br0``), the TAP device (``acrn_tap0``), and how these are all
connected. Those files are installed in ``/usr/lib/systemd/network`` connected. Those files are installed in ``/usr/lib/systemd/network``
@ -72,7 +72,7 @@ of the configuration you are trying to set up, the modifications you have made t
the output of ``journalctl -b -u systemd-networkd`` so we can best assist you. the output of ``journalctl -b -u systemd-networkd`` so we can best assist you.
.. _systemd-networkd: https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html .. _systemd-networkd: https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html
.. _Clear Linux: https://clearlinux.org .. _Clear Linux OS: https://clearlinux.org
.. _systemd-network: https://www.freedesktop.org/software/systemd/man/systemd.network.html .. _systemd-network: https://www.freedesktop.org/software/systemd/man/systemd.network.html
.. _ACRN-users mailing list: https://lists.projectacrn.org/g/acrn-users .. _ACRN-users mailing list: https://lists.projectacrn.org/g/acrn-users
.. _ACRN hypervisor issues: https://github.com/projectacrn/acrn-hypervisor/issues .. _ACRN hypervisor issues: https://github.com/projectacrn/acrn-hypervisor/issues

10
doc/tutorials/using_partition_mode_on_up2.rst
View File

@ -20,9 +20,9 @@ Prerequisites
************* *************
In this tutorial two Linux privileged VMs are started by the ACRN hypervisor. In this tutorial two Linux privileged VMs are started by the ACRN hypervisor.
To set up the Linux root filesystems for each VM, follow the Clear Linux To set up the Linux root filesystems for each VM, follow the Clear Linux OS
`bare metal installation guide <https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install#bare-metal-install>`_ `bare metal installation guide <https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install#bare-metal-install>`_
to install Clear Linux on a **SATA disk** and a **USB flash disk** prior the setup, to install Clear Linux OS on a **SATA disk** and a **USB flash disk** prior the setup,
as the two privileged VMs will mount the root filesystems via the SATA controller as the two privileged VMs will mount the root filesystems via the SATA controller
and the USB controller respectively. and the USB controller respectively.
@ -73,12 +73,12 @@ Build kernel and modules for partition mode UOS
.. code-block:: none .. code-block:: none
# Mount the Clear Linux root filesystem on the SATA disk # Mount the Clear Linux OS root filesystem on the SATA disk
$ sudo mount /dev/sda3 /mnt $ sudo mount /dev/sda3 /mnt
$ sudo cp -r <kernel-modules-folder-built-in-step1>/lib/modules/* /mnt/lib/modules $ sudo cp -r <kernel-modules-folder-built-in-step1>/lib/modules/* /mnt/lib/modules
$ sudo umount /mnt $ sudo umount /mnt
# Mount the Clear Linux root filesystem on the USB flash disk # Mount the Clear Linux OS root filesystem on the USB flash disk
$ sudo mount /dev/sdb3 /mnt $ sudo mount /dev/sdb3 /mnt
$ sudo cp -r <path-to-kernel-module-folder-built-in-step1>/lib/modules/* /mnt/lib/modules $ sudo cp -r <path-to-kernel-module-folder-built-in-step1>/lib/modules/* /mnt/lib/modules
$ sudo umount /mnt $ sudo umount /mnt
@ -257,7 +257,7 @@ Enable partition mode in ACRN hypervisor
#. Optionally, configure the ``.bootargs`` kernel command line arguments #. Optionally, configure the ``.bootargs`` kernel command line arguments
The kernel command line arguments used to boot the privileged VMs are The kernel command line arguments used to boot the privileged VMs are
hardcoded as ``/dev/sda3`` to meet the Clear Linux automatic installation. hardcoded as ``/dev/sda3`` to meet the Clear Linux OS automatic installation.
In case you plan to use your customized root In case you plan to use your customized root
filesystem, you may optionally edit the ``root=`` parameter specified filesystem, you may optionally edit the ``root=`` parameter specified
in the ``.bootargs`` field of the ``.vm_desc_array`` structure, to in the ``.bootargs`` field of the ``.vm_desc_array`` structure, to

14
doc/tutorials/using_ubuntu_as_sos.rst
View File

@ -4,7 +4,7 @@ Using Ubuntu as the Service OS
############################## ##############################
This document builds on the :ref:`getting_started`, and explains how to use This document builds on the :ref:`getting_started`, and explains how to use
Ubuntu instead of using `Clear Linux`_ as the Service OS with the ACRN Ubuntu instead of using `Clear Linux OS`_ as the Service OS with the ACRN
hypervisor. (Note that different OSes can be used for the Service and User OS.) hypervisor. (Note that different OSes can be used for the Service and User OS.)
In the following instructions we'll build on material in the In the following instructions we'll build on material in the
:ref:`getting-started-apl-nuc`. :ref:`getting-started-apl-nuc`.
@ -133,13 +133,13 @@ Install the Service OS kernel
You can download latest Service OS kernel from You can download latest Service OS kernel from
`<https://download.clearlinux.org/releases/current/clear/x86_64/os/Packages/>`_ `<https://download.clearlinux.org/releases/current/clear/x86_64/os/Packages/>`_
1. The latest Service OS kernel from the latest Clear Linux release 1. The latest Service OS kernel from the latest Clear Linux OS release
from this area: from this area:
https://download.clearlinux.org/releases/current/clear/x86_64/os/Packages. Look for an https://download.clearlinux.org/releases/current/clear/x86_64/os/Packages. Look for an
``.rpm`` file named ``linux-iot-lts2018-sos-<kernel-version>-<build-version>.x86_64.rpm``. ``.rpm`` file named ``linux-iot-lts2018-sos-<kernel-version>-<build-version>.x86_64.rpm``.
While we recommend using the "current" (latest) release of Clear Linux, you can download While we recommend using the "current" (latest) release of Clear Linux OS, you can download
a specific Clear Linux release from an area with that release number, e.g.: a specific Clear Linux release from an area with that release number, e.g.:
https://download.clearlinux.org/releases/26440/clear/x86_64/os/Packages/linux-iot-lts2018-sos-4.19.0-22.x86_64.rpm https://download.clearlinux.org/releases/26440/clear/x86_64/os/Packages/linux-iot-lts2018-sos-4.19.0-22.x86_64.rpm
#. Download and extract the latest Service OS kernel(this guide is based on 26440 as the current example) #. Download and extract the latest Service OS kernel(this guide is based on 26440 as the current example)
@ -230,9 +230,9 @@ You can download latest Service OS kernel from
Prepare the User OS (UOS) Prepare the User OS (UOS)
************************* *************************
For the User OS, we are using the same `Clear Linux`_ release version as the Service OS. For the User OS, we are using the same `Clear Linux OS`_ release version as the Service OS.
* Download the Clear Linux image from `<https://download.clearlinux.org>`_ * Download the Clear Linux OS image from `<https://download.clearlinux.org>`_
.. code-block:: none .. code-block:: none
@ -347,4 +347,4 @@ Please refer to :ref:`getting-started-apl-nuc` for enabling the
USB keyboard and mouse for the UOS. USB keyboard and mouse for the UOS.
.. _Clear Linux: https://clearlinux.org .. _Clear Linux OS: https://clearlinux.org