mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-09-23 01:37:44 +00:00
doc: fix correct use of Clear Linux OS
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
committed by
David Kinder
David Kinder
parent
fc887eade4
commit
0881bae738
@@ -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
|
||||
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
|
||||
* a second AGL UOS controls the RSE display.
|
||||
|
||||
@@ -111,9 +111,9 @@ The demo setup uses these software components and versions:
|
||||
* - ACRN hypervisor
|
||||
- 0.3
|
||||
- `ACRN project <https://github.com/projectacrn/acrn-hypervisor>`_
|
||||
* - Clear Linux
|
||||
* - Clear Linux OS
|
||||
- 26200
|
||||
- `Clear Linux installer image
|
||||
- `Clear Linux OS installer image
|
||||
<https://download.clearlinux.org/releases/26200/clear/clear-26200-installer.img.xz>`_
|
||||
* - AGL
|
||||
- Funky Flounder (6.02)
|
||||
@@ -126,34 +126,34 @@ The demo setup uses these software components and versions:
|
||||
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
|
||||
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>`_
|
||||
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
|
||||
type, and using the platform’s storage as the target device for
|
||||
installation (overwriting the existing data and creating three
|
||||
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.
|
||||
|
||||
#. 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
|
||||
happen. Use this command (as root) to disable the autoupdate feature::
|
||||
|
||||
# swupd autoupdate --disable
|
||||
|
||||
#. This demo setup uses a specific release version (26200) of Clear
|
||||
Linux which has been verified to work with ACRN. In case you
|
||||
unintentionally update or change the Clear Linux version, you can
|
||||
Linux OS which has been verified to work with ACRN. In case you
|
||||
unintentionally update or change the Clear Linux OS version, you can
|
||||
fix it again using::
|
||||
|
||||
# swupd verify --fix --picky -m 26200
|
||||
|
||||
#. Use the ``swupd bundle-add`` command and add needed Clear Linux
|
||||
bundles::
|
||||
OS bundles::
|
||||
|
||||
# swupd bundle-add openssh-server sudo network-basic \
|
||||
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.
|
||||
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::
|
||||
|
||||
$ mkdir workspace
|
||||
@@ -229,7 +229,7 @@ Service OS
|
||||
$ 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`
|
||||
on boot up to enter the EFI menu and choose "ACRN Hypervisor".
|
||||
|
||||
|
||||
@@ -1,40 +1,39 @@
|
||||
.. _build UOS from Clearlinux:
|
||||
|
||||
Building UOS from Clear Linux
|
||||
#############################
|
||||
Building UOS from Clear Linux OS
|
||||
################################
|
||||
|
||||
This document builds on the :ref:`getting_started`,
|
||||
and explains how to build UOS from Clear Linux.
|
||||
|
||||
Build UOS image in Clear Linux native
|
||||
*************************************
|
||||
This document builds on the :ref:`getting_started`,
|
||||
and explains how to build UOS from Clear Linux OS.
|
||||
|
||||
In order to build out the image of UOS,
|
||||
follow these steps to build a UOS image from Clear Linux:
|
||||
Build UOS image in Clear Linux OS
|
||||
*********************************
|
||||
|
||||
#. In Clear Linux native, install ``ister`` (a template-based
|
||||
installer for Linux) included in the Clear Linux bundle
|
||||
Follow these steps to build a UOS image from Clear Linux OS:
|
||||
|
||||
#. In Clear Linux OS, install ``ister`` (a template-based
|
||||
installer for Linux) included in the Clear Linux OS bundle
|
||||
``os-installer``.
|
||||
For more information about ``ister``,
|
||||
For more information about ``ister``,
|
||||
please visit https://github.com/bryteise/ister.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
$ sudo swupd bundle-add os-installer
|
||||
|
||||
#. After installation is complete, use ``ister.py`` to
|
||||
generate the image for UOS with the configuration in
|
||||
|
||||
#. After installation is complete, use ``ister.py`` to
|
||||
generate the image for UOS with the configuration in
|
||||
``uos-image.json``:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
$ cd ~
|
||||
|
||||
$ cd ~
|
||||
$ sudo ister.py -t uos-image.json
|
||||
|
||||
|
||||
An example of the configuration file ``uos-image.json``:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
||||
{
|
||||
"DestinationType" : "virtual",
|
||||
"PartitionLayout" : [ { "disk" : "uos.img",
|
||||
@@ -76,17 +75,17 @@ follow these steps to build a UOS image from Clear Linux:
|
||||
}
|
||||
|
||||
.. note::
|
||||
To generate the image with a specified version,
|
||||
please modify the ``"Version"`` argument,
|
||||
and we can set ``"Version": 26550`` instead of
|
||||
To generate the image with a specified version,
|
||||
please modify the ``"Version"`` argument,
|
||||
and we can set ``"Version": 26550`` instead of
|
||||
``"Version": "latest"`` for example.
|
||||
|
||||
Here we will use ``"Version": 26550`` for example,
|
||||
and the UOS image called ``uos.img`` will be generated
|
||||
|
||||
Here we will use ``"Version": 26550`` for example,
|
||||
and the UOS image called ``uos.img`` will be generated
|
||||
after successful installation. An example output log is:
|
||||
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
||||
Reading configuration
|
||||
Validating configuration
|
||||
Creating virtual disk
|
||||
@@ -98,19 +97,19 @@ follow these steps to build a UOS image from Clear Linux:
|
||||
Installing 9 bundles (and dependencies)...
|
||||
Verifying version 26550
|
||||
Downloading packs...
|
||||
|
||||
|
||||
Extracting emacs pack for version 26550
|
||||
|
||||
|
||||
Extracting vim pack for version 26550
|
||||
...
|
||||
Cleaning up
|
||||
Successful installation
|
||||
|
||||
|
||||
#. On your target device, boot the system and select "The ACRN Service OS", as shown below:
|
||||
|
||||
.. code-block:: console
|
||||
:emphasize-lines: 1
|
||||
|
||||
|
||||
=> 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-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
|
||||
install.d
|
||||
org.clearlinux.iot-lts2018.4.19.0-26
|
||||
|
||||
#. Adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh``
|
||||
script to match your installation.
|
||||
|
||||
#. Adjust the ``/usr/share/acrn/samples/nuc/launch_uos.sh``
|
||||
script to match your installation.
|
||||
These are the couple of lines you need to modify:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
||||
-s 3,virtio-blk,~/uos.img \
|
||||
-k /mnt/usr/lib/kernel/default-iot-lts2018 \
|
||||
|
||||
.. note::
|
||||
UOS image ``uos.img`` is in the directory ``~/``
|
||||
and UOS kernel ``default-iot-lts2018`` is in ``/mnt/usr/lib/kernel/``.
|
||||
|
||||
|
||||
#. You are now all set to start the User OS (UOS):
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
|
||||
$ sudo /usr/share/acrn/samples/nuc/launch_uos.sh
|
||||
|
||||
|
||||
You are now watching the User OS booting up!
|
||||
|
||||
@@ -137,7 +137,7 @@ Our documentation processing has been tested to run with:
|
||||
|
||||
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
|
||||
|
||||
* For Ubuntu use:
|
||||
|
||||
@@ -21,7 +21,7 @@ Software Configuration
|
||||
<https://github.com/projectacrn/acrn-hypervisor/releases/tag/acrn-2018w39.6-140000p>`_
|
||||
* `acrn-kernel 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
|
||||
<../_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
|
||||
|
||||
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
|
||||
``–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
|
||||
|
||||
#. 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
|
||||
# mkdir /mnt/EFI/acrn
|
||||
|
||||
@@ -12,7 +12,7 @@ address. You need ``root`` privileges to make these changes to the system.
|
||||
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
|
||||
ACRN bridge (``acrn-br0``), the TAP device (``acrn_tap0``), and how these are all
|
||||
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.
|
||||
|
||||
.. _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
|
||||
.. _ACRN-users mailing list: https://lists.projectacrn.org/g/acrn-users
|
||||
.. _ACRN hypervisor issues: https://github.com/projectacrn/acrn-hypervisor/issues
|
||||
|
||||
@@ -20,9 +20,9 @@ Prerequisites
|
||||
*************
|
||||
|
||||
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>`_
|
||||
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
|
||||
and the USB controller respectively.
|
||||
|
||||
@@ -73,12 +73,12 @@ Build kernel and modules for partition mode UOS
|
||||
|
||||
.. 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 cp -r <kernel-modules-folder-built-in-step1>/lib/modules/* /mnt/lib/modules
|
||||
$ 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 cp -r <path-to-kernel-module-folder-built-in-step1>/lib/modules/* /mnt/lib/modules
|
||||
$ sudo umount /mnt
|
||||
@@ -257,7 +257,7 @@ Enable partition mode in ACRN hypervisor
|
||||
#. Optionally, configure the ``.bootargs`` kernel command line arguments
|
||||
|
||||
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
|
||||
filesystem, you may optionally edit the ``root=`` parameter specified
|
||||
in the ``.bootargs`` field of the ``.vm_desc_array`` structure, to
|
||||
|
||||
@@ -4,7 +4,7 @@ Using Ubuntu as the Service OS
|
||||
##############################
|
||||
|
||||
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.)
|
||||
In the following instructions we'll build on material in the
|
||||
:ref:`getting-started-apl-nuc`.
|
||||
@@ -133,13 +133,13 @@ Install the Service OS kernel
|
||||
You can download latest Service OS kernel from
|
||||
`<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:
|
||||
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``.
|
||||
|
||||
While we recommend using the "current" (latest) release of Clear Linux, you can download
|
||||
a specific Clear Linux release from an area with that release number, e.g.:
|
||||
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.:
|
||||
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)
|
||||
@@ -230,9 +230,9 @@ You can download latest Service OS kernel from
|
||||
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
|
||||
|
||||
@@ -347,4 +347,4 @@ Please refer to :ref:`getting-started-apl-nuc` for enabling the
|
||||
USB keyboard and mouse for the UOS.
|
||||
|
||||
|
||||
.. _Clear Linux: https://clearlinux.org
|
||||
.. _Clear Linux OS: https://clearlinux.org
|
||||
|
||||
Reference in New Issue
Block a user