clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-08-26 18:36:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update compatibility-check (#1183)

Browse Source 
Closes #1076

Signed-off-by: Bun K Tan <bun.k.tan@intel.com>
This commit is contained in:
bktan8
2020-06-02 20:24:03 -07:00
committed by GitHub
parent b42486ccb3
commit b3bbfbb1ca
1 changed files with 59 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/get-started/compatibility-check.rst
+59 -23
View File
@@ -1,57 +1,49 @@
.. _compatibility-check:
Check processor and EFI firmware compatibility
##############################################
Check Processor Compatibility
#############################
Before installing |CL-ATTR|, check your host system's processor and EFI firmware
compatibility. To check compatibility, choose one of the following paths:
* From a system with a Linux\* OS installed, follow the instructions to :ref:`check-compatibility-steps`.
* From a non-Linux OS, first :ref:`bare-metal-install-desktop` and then follow
the instructions to :ref:`check-compatibility-steps`.
Before installing |CL-ATTR|, check your host system's processor compatibility using one of
the following options:
.. note::
This does not check other system components (for example: storage and
graphics) for compatibility with |CL|.
.. _check-compatibility-steps:
Check compatibility
*******************
Option 1: Use the :command:`clear-linux-check-config.sh` script on an existing Linux system
*******************************************************************************************
#. Download the `clear-linux-check-config.sh`_ file.
If a browser is not available, use:
.. code-block:: console
.. code-block:: bash
curl -O https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
#. Make the script executable.
.. code-block:: console
.. code-block:: bash
chmod +x clear-linux-check-config.sh
#. Run the script.
#. Check to see if the host's processor and EFI firmware is capable of
running |CL|.
#. Check to see if the host's processor is capable of running |CL|.
.. code-block:: console
.. code-block:: bash
./clear-linux-check-config.sh host
#. Check to see if the host is capable of running |CL| in a container.
.. code-block:: console
.. code-block:: bash
./clear-linux-check-config.sh container
The script prints a list of test results similar to the output below.
All items should return a `SUCCESS` status. This example indicates the
host's processor and EFI firmware support running |CL|.
host's processor supports running |CL|.
.. code-block:: console
@@ -61,8 +53,52 @@ Check compatibility
SUCCESS: Supplemental Streaming SIMD Extensions 3 (ssse3)
SUCCESS: Streaming SIMD Extension v4.1 (sse4_1)
SUCCESS: Streaming SIMD Extensions v4.2 (sse4_2)
SUCCESS: Advanced Encryption Standard instruction set (aes)
SUCCESS: Carry-less Multiplication extensions (pclmulqdq)
SUCCESS: EFI Firmware
.. _clear-linux-check-config.sh: https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
Option 2: Use a |CL| live image on a non-Linux system
=====================================================
#. `Download`_ either the `Desktop` or `Server` version of the live image ISO.
#. Follow the instruction to :ref:`bootable-usb`.
#. Boot up the |CL| live image on the USB.
#. Check compatibility as follows:
* *Desktop version:*
a. Open a terminal.
#. Check compatibility.
.. code-block:: bash
sudo clr-installer --system-check
* *Server version:*
a. Log in as `root` and set a password.
#. Check compatibility.
.. code-block:: bash
clr-installer --system-check
Expected output for a compatible host processor:
.. code-block:: console
Checking for required CPU feature: lm [success]
Checking for required CPU feature: sse4_2 [success]
Checking for required CPU feature: sse4_1 [success]
Checking for required CPU feature: pclmulqdq [success]
Checking for required CPU feature: ssse3 [success]
Success: System is compatible
.. _clear-linux-check-config.sh:
https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
.. _Download:
https://clearlinux.org/downloads