clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-07-04 11:46:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #35 from 01org/usb-minimum-reqs

Browse Source 
Makes get started content modularized. Updates HW requirements.
This commit is contained in:
Rodrigo Caballero
2017-09-21 14:33:08 -05:00
committed by GitHub
parent 7d2118006e 86f8cc9c6e
commit aee95cd862
15 changed files with 547 additions and 278 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst
+102 -172
View File
@@ -3,108 +3,32 @@
Install Clear Linux host OS on bare metal
#########################################
These instructions will guide you through the installation of |CL| on bare
metal using a :ref:`bootable USB drive<create-usb>`.
This instruction set will guide you through the automatic installation of |CL|
on bare metal using a bootable USB drive.
Verify your system hardware is supported by |CLOSIA|. Review the
:ref:`list of supported processors <supported-hardware>` and
:ref:`instructions to run a compatibility check <compatibility-check>`.
.. include:: ../compatibility-check.rst
:Start-after: compatibility-check:
.. note::
.. include:: ../bootable-usb/bootable-usb-linux.rst
:Start-after: bootable-usb-linux:
:end-before: download-cl-image
The steps of this installation guide were tested using a NUC6i5SYH
Intel® NUC. Visit the `NUC6i5SYH product page`_ for detailed information.
.. include:: ../bootable-usb/bootable-usb-linux.rst
:Start-after: download-cl-image:
:end-before: verify-checksum
.. _create-usb:
.. include:: ../bootable-usb/bootable-usb-linux.rst
:Start-after: verify-checksum:
:end-before: copy-usb-linux
Create a Clear Linux bootable USB drive
=======================================
This procedure was created on an Ubuntu 16.04-based system where the USB
drive is identified as :file:`/dev/sdb`. Make sure to map your correct USB
device for this process. We recommend you use an 8GB USB drive or larger.
Copying the |CL| image onto the USB drive formats the drive as a UEFI boot
device. Therefore, the contents of the USB drive will be destroyed during the
creation of the bootable USB drive. Make sure to save anything stored in the
drive before proceeding.
.. _download-clear-linux-image:
Download the Latest Clear Linux Image
-------------------------------------
Get the latest available |CL| installer image that you want to install
to your system by using your web browser and downloading the latest
:file:`clear-[release]-installer.img.xz` file from
https://download.clearlinux.org/image/ where `[release]` is the release
number of the current image that is available in this directory listing.
This example uses release 10980 so we will download the
:file:`clear-10980-installer.img.xz` image file and, optionally, the
:file:`clear-10980-installer.img.xz-SHA512SUMS` file needed to verify the
download.
To verify the download, follow these steps:
1. Go to the directory with the downloaded files.
2. To verify the integrity of the file, enter the following commands:
.. code-block:: console
sha512sum ./clear-10980-installer.img.xz | diff ./clear-10980-installer.img.xz-SHA512SUMS -
If the files differ, the diff command outputs the difference to the console,
otherwise, diff does not have any output to the console and returns you to
the command prompt.
.. _copy-image:
Copy the Clear Linux image to a USB drive
-----------------------------------------
This example assumes that the USB drive is connected to your system as
:file:`/dev/sdb` and is not mounted.
To ensure the device is not mounted, enter the following command:
.. code-block:: console
umount /dev/sdb
To log in as root, simply enter:
.. code-block:: console
su
Once prompted, enter your root password. Alternatively you can enter:
.. code-block:: console
sudo -s
In this case you would enter your user password when prompted.
To extract the downloaded image file and put it on the USB drive, enter the
following command:
.. code-block:: console
xzcat clear-10980-installer.img.xz | dd of=/dev/sdb
.. note::
These commands only work in the directory containing the downloaded file.
The decompression and copy of the image file takes some time to complete.
Once the image has been decompressed and copied to the USB drive, you can
remove the USB drive from the system and move it to your target system.
.. include:: ../bootable-usb/bootable-usb-linux.rst
:Start-after: copy-usb-linux:
:end-before: usb-next
.. _install-on-target:
Install Clear Linux on your target system
=========================================
*****************************************
The USB drive that was created in the previous step has been formatted as a
UEFI boot device. Our target system has a hard drive installed containing a
@@ -113,65 +37,65 @@ with DHCP.
Follow these steps to install |CL| on the target system:
1. Insert the USB drive into an available USB slot.
#. Insert the USB drive into an available USB slot.
2. Power on the system.
#. Power on the system.
3. Open the system BIOS setup menu, normally by pressing the F2 key. Your
#. Open the system BIOS setup menu, normally by pressing the F2 key. Your
BIOS setup menu entry point may vary.
4. In the setup menu, enable the UEFI boot and set the USB drive as the first
#. In the setup menu, enable the UEFI boot and set the USB drive as the first
option in the device boot order.
5. Save these settings and exit.
#. Save these settings and exit.
6. Reboot the target system and the |CL| Installer menu will start.
#. Reboot the target system and the |CL| Installer menu will start.
.. note::
.. note::
Use the arrow keys, space bar, and enter key to navigate the menu of the
|CL| Installer.
Use the arrow keys, space bar, and enter key to navigate the menu of the
|CL| Installer.
7. In this tutorial, we will enable telemetrics and select the `Automatic`
#. In this tutorial, we will enable telemetrics and select the `Automatic`
installation type.
The primary drive to install |CL| onto is :file:`/dev/sdb` since the
target system identifies the USB drive as :file:`/dev/sda`.
The primary drive to install |CL| onto is :file:`/dev/sdb` since the
target system identifies the USB drive as :file:`/dev/sda`.
8. Follow the instructions to begin the installation.
#. Follow the instructions to begin the installation.
The installation is completed in the following stages:
The installation is completed in the following stages:
.. code-block:: console
.. code-block:: console
Reading configuration
Validating configuration
Creating partitions
Creating file systems
Setting up mount points
Starting swupd. May take several minutes
Cleaning up
Successful installation
Reading configuration
Validating configuration
Creating partitions
Creating file systems
Setting up mount points
Starting swupd. May take several minutes
Cleaning up
Successful installation
Once complete, an `<OK>` prompt appears in the dialog box, letting you know
that you have successfully installed |CL| onto your system.
Once complete, an `<OK>` prompt appears in the dialog box, letting you know
that you have successfully installed |CL| onto your system.
9. Press enter once the <OK> prompt appears. The following dialog box takes
#. Press enter once the <OK> prompt appears. The following dialog box takes
its place:
.. code-block:: console
.. code-block:: console
Successful installation, the system will be rebooted
Successful installation, the system will be rebooted
<OK>
<OK>
10. Press enter, remove the USB drive from the system, and the system will
#. Press enter, remove the USB drive from the system, and the system will
reboot running |CL|.
.. _initial-setup:
Clear Linux initial setup after installation
============================================
********************************************
Your newly installed |CL| boots on your target system and presents a full
screen console requesting `Login:`. |CL| is designed to install with minimal
@@ -179,11 +103,13 @@ software overhead. Therefore, some housekeeping and package installations
must occur before you have a full-featured |CL| operating system.
Set up your root and user accounts
----------------------------------
==================================
1. At the initial login prompt, enter: root
2. Once you are prompted, enter a new password
3. Re-enter the password to verify it.
#. At the initial login prompt, enter: root
#. Once you are prompted, enter a new password
#. Re-enter the password to verify it.
You have set your root password and are logged in with root privileges.
@@ -201,7 +127,7 @@ Remain logged in as the root user because there are some other things to do
before we can fully enable your new user space.
Software installation and updates
---------------------------------
=================================
|CL| has a unique application and architecture to add and update applications
and to perform system updates called software update utility or `swupd`.
@@ -231,7 +157,7 @@ We provide the full list of bundles and packages installed with the
list to view the manifest of the bundle.
Finish setting up your new user
-------------------------------
===============================
Before logging off as root and logging into your new user account, we must
enable the :command:`sudo` command for your new `<userid>`.
@@ -240,83 +166,86 @@ To be able to execute all applications with root privileges, we must add the
`<userid>` to the `wheel group`_ and enable the wheel group in the
:file:`/etc/sudoers` file.
1. To add `<userid>` to the wheel group, enter the following command:
#. To add `<userid>` to the wheel group, enter the following command:
.. code-block:: console
usermod -G wheel -a <userid>
2. To open the :file:`/etc/sudoers` file, enter the following command:
#. To open the :file:`/etc/sudoers` file, enter the following command:
.. code-block:: console
vi /etc/sudoers
.. note::
.. note::
Normally, we would use the visudo script to edit the :file:`/etc/sudoers`
file to safely modify the contents of the file. In this instance, the file
does not exist yet. Therefore, we create the initial instance of the file.
Normally, we would use the visudo script to edit the :file:`/etc/sudoers`
file to safely modify the contents of the file. In this instance, the file
does not exist yet. Therefore, we create the initial instance of the file.
3. In the vi\* editor window, press the :kbd:`o` to open a new line.
#. In the vi\* editor window, press the :kbd:`o` to open a new line.
4. Add the following line to the file:
#. Add the following line to the file:
.. code-block:: console
%wheel ALL=(ALL) ALL
5. To save the changes to the file and exit vi, press the :kbd:`ESC` key
#. To save the changes to the file and exit vi, press the :kbd:`ESC` key
followed by the :kbd:`:` and :kbd:`x` keys.
.. important::
.. important::
Creating the file logged as the root user keeps the permissions of the
file with the root user.
Creating the file logged as the root user keeps the permissions of the
file with the root user.
Now, we can log out of root and into our new <userid>.
Now, we can log out of root and into our new <userid>.
To log off as root, enter :command:`exit`.
#. To log off as root, enter :command:`exit`.
The command should bring you back to the `Login:` prompt.
The command should bring you back to the `Login:` prompt.
Enter your new `<userid>` and the password you created earlier.
#. Enter your new `<userid>` and the password you created earlier.
You should now be in the home directory of `<userid>`. The bundle
`os-clr-on-clr`_ contains the majority of applications that a developer or
system administrator would want but it does not include a graphical user
interface. The `desktop` bundle includes the Gnome Desktop Manager and
additional supporting applications.
You should now be in the home directory of `<userid>`. The bundle
`os-clr-on-clr`_ contains the majority of applications that a developer or
system administrator would want but it does not include a graphical user
interface. The `desktop` bundle includes the Gnome Desktop Manager and
additional supporting applications.
To test the :command:`sudo` command and ensure we set it up correctly, we can
install the Gnome Desktop Manager (gdm) and start it.
Install a GUI
=============
To install Gnome using swupd, enter the following command:
#. To test the :command:`sudo` command and ensure we set it up correctly, we
can install the Gnome Desktop Manager (gdm) and start it.
.. code-block:: console
#. To install Gnome using swupd, enter the following command:
sudo swupd bundle-add desktop
.. code-block:: console
To start the Gnome Desktop Manager, enter the following command:
sudo swupd bundle-add desktop
.. code-block:: console
#. To start the Gnome Desktop Manager, enter the following command:
systemctl start gdm
.. code-block:: console
You will be prompted to authenticate your user. Enter the password for
`<userid>` and the Gnome Desktop should start as shown in figure 1:
systemctl start gdm
.. figure:: figures/gnomedt.png
:alt: Gnome Desktop
You will be prompted to authenticate your user. Enter the password for
`<userid>` and the Gnome Desktop should start as shown in figure 1:
Figure 1: :guilabel:`Gnome Desktop`
.. figure:: figures/gnomedt.png
:alt: Gnome Desktop
To start the Gnome Desktop each time you start your system, enter
the following command:
Figure 1: :guilabel:`Gnome Desktop`
.. code-block:: console
#. To start the Gnome Desktop each time you start your system, enter
the following command:
systemctl enable gdm
.. code-block:: console
systemctl enable gdm
**Congratulations!**
@@ -333,16 +262,13 @@ Additionally, you performed the following basic setup for your system:
* Installed a GUI using those `sudo` privileges.
Next steps
==========
**********
With your system now running |CL| many paths are open for you.
Visit our :ref:`tutorials` page for examples on using your |CL|
system.
.. _`NUC6i5SYH product page`:
http://www.intel.com/content/www/us/en/nuc/nuc-kit-nuc6i5syh.html
.. _`information about swupd`:
https://clearlinux.org/features/software-update
@@ -354,3 +280,7 @@ system.
.. _`wheel group`:
https://en.wikipedia.org/wiki/Wheel_(Unix_term)
.. _image: https://download.clearlinux.org/image
.. _releases: https://download.clearlinux.org/releases
source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst
+132
View File
@@ -0,0 +1,132 @@
.. _bootable-usb-linux:
Create a bootable USB drive on Linux
************************************
Follow these instructions to create a bootable |CLOSIA| USB drive.
Use an **8GB** or larger USB drive.
Alternative instructions for other operating systems are available:
* :ref:`bootable-usb-mac`
* :ref:`bootable-usb-windows`
.. _download-cl-image:
Download the latest Clear Linux image
=====================================
#. Go to the Clear Linux `image`_ repository and download the desired type:
* Live image: `clear-<version>-live.img.xz`
* Installer image: `clear-<version>-installer.img.xz`
For older versions, see the `releases`_ page.
#. Although not required, it is recommended to download the corresponding
checksum file (designated with `-SHA512SUMS` at the end of the filename) for
the image in order to verify its integrity.
.. _verify-checksum:
Verify the integrity of the download (recommended)
==================================================
#. Start a terminal emulator.
#. Go to the directory with the downloaded files.
#. To verify the integrity of the image, enter the following (a live image
is used as example):
.. code-block:: console
$ sha512sum ./clear-<version>-live.img.xz | diff ./clear-<version>-live.img.xz-SHA512SUMS -
If the checksum of the downloaded image is different than the original
checksum, the differences will displayed. An empty output indicates a match.
.. _copy-usb-linux:
Burn the Clear Linux image onto a USB drive
===========================================
.. caution::
Backup important data before proceeding. The process of burning an image
onto the USB drive completely formats the
USB drive and any existing content will be destroyed.
#. Open a terminal emulator and get root privilege.
.. code-block:: console
$ sudo -s
#. Plug in the USB drive.
#. Identify the USB drive using the `lsblk` command. This shows all drives
attached to the system, including the primary hard disk. In the example
output below, there are 4 drives (`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and
`/dev/sdd`) attached, where `/dev/sda` is primary drive in this case. The
remaining are 3 USB drives. The output also shows the mounted partitions
(under the `MOUNTPOINT` column) for each drive.
.. code-block:: console
# lsblk
Example output:
.. code-block:: console
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
sdd 8:48 1 15G 0 disk
├─sdd2 8:50 1 5G 0 part /run/media/user1/960c184f-3bb7-42b7-bcaf-0c1282
├─sdd3 8:51 1 8G 0 part /run/media/user1/704f3382-b26d-4f34-af1b-cb9aab
└─sdd1 8:49 1 2G 0 part
sdb 8:16 1 14.8G 0 disk
└─sdb1 8:17 1 14.8G 0 part /run/media/user1/PATRIOT_USB
sdc 8:32 1 7.3G 0 disk
└─sdc1 8:33 1 7.3G 0 part /run/media/user1/LINUX MINT
sda 8:0 0 335.4G 0 disk
├─sda4 8:4 0 28G 0 part
├─sda2 8:2 0 3.7G 0 part [SWAP]
├─sda7 8:7 0 6G 0 part /home
├─sda5 8:5 0 1G 0 part /boot
├─sda3 8:3 0 954M 0 part /boot/efi
├─sda1 8:1 0 28G 0 part
├─sda8 8:8 0 30G 0 part /
└─sda6 8:6 0 7.9G 0 part [SWAP]
#. Before an image can be burned onto a USB drive, it should be un-mounted.
Some Linux distros may automatically mount a USB drive when it is plugged
in. To unmount, use the `umount` command followed by the device
identifier/partition. For example: From the above `lsblk` output,
`/dev/sdd` has 2 mounted partitions.
.. code-block:: console
# umount /dev/sdd2
# umount /dev/sdd3
#. Extract the downloaded image file and burn it onto the USB drive (`/dev/sdd`
is used as an example).
.. code-block:: console
# xzcat clear-<version>-live.img.xz | dd of=/dev/sdd bs=4M status=progress
.. _usb-next:
Next steps
----------
With a bootable |CL| USB drive, you can:
* :ref:`bare-metal-install`
* :ref:`boot-live-image`
* :ref:`multi-boot`
.. _image: https://download.clearlinux.org/image
.. _releases: https://download.clearlinux.org/releases
source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst
+91
View File
@@ -0,0 +1,91 @@
.. _bootable-usb-mac:
Create a bootable USB drive on macOS
************************************
Follow these instructions to create a bootable |CLOSIA| USB drive.
Use an **8GB** or larger USB drive.
Alternative instructions for other operating systems are available:
* :ref:`bootable-usb-linux`
* :ref:`bootable-usb-windows`
.. include:: bootable-usb-linux.rst
:Start-after: download-cl-image:
:end-before: verify-checksum
Verify the integrity of the download (recommended)
==================================================
#. Start the Terminal app.
#. Go to the directory with the downloaded files.
#. To verify the integrity of the image, enter the following commands:
.. code-block:: console
$ shasum -a512 ./clear-<version>-live.img.xz | diff ./clear-<version>-live.img.xz-SHA512SUMS -
If the checksum of the downloaded image is different than the original's,
the differences will displayed. Otherwise, an empty output indicates a match.
Burn the Clear Linux image onto a USB drive
===========================================
.. caution::
Backup important data before proceeding. The process of burning an image
onto the USB drive completely formats the
USB drive and any existing content will be destroyed.
#. Launch the Terminal application.
#. Uncompress the |CL| image.
.. code-block:: console
$ gunzip clear-<version>-live.img.xz
#. Plug in a USB drive and get its identifier. See Figure 1.
.. code-block:: console
$ diskutil list
.. figure:: figures/bootable-usb-mac-1.png
:alt: Get USB drive identifier
#. Unmount the USB drive identified in the previous step (using `/dev/disk2`
as the example)
.. code-block:: console
$ diskutil umountDisk /dev/disk2
#. Burn the image onto the drive.
.. code-block:: console
$ sudo dd if=/path/to/clear-<version>-live.img of=/dev/rdisk2 bs=4m
* Adding an ‘r’ in front of the disk identifier should help speed up the
imaging process.
* Use `<CTL>-T` to check imaging progress.
#. Eject the USB drive.
.. code-block:: console
$ diskutil eject /dev/disk2
Next steps
----------
With a bootable |CL| USB drive, you can:
* :ref:`bare-metal-install`
* :ref:`boot-live-image`
* :ref:`multi-boot`
.. _releases: https://download.clearlinux.org/releases
.. _image: https://download.clearlinux.org/image
source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst
+63
View File
@@ -0,0 +1,63 @@
.. _bootable-usb-windows:
Create a bootable USB drive on Windows
**************************************
Follow these instructions to create a bootable |CLOSIA| USB drive.
Use an **8GB** or larger USB drive.
Alternative instructions for other operating systems are available:
* :ref:`bootable-usb-mac`
* :ref:`bootable-usb-linux`
.. include:: bootable-usb-linux.rst
:Start-after: download-cl-image:
:end-before: verify-checksum
Verify the integrity of the download (recommended)
==================================================
#. Start Command-Prompt.
#. Go to the directory with the downloaded files.
#. To verify the integrity of the image, enter the following commands:
.. code-block:: console
C:\> CertUtil -hashfile ./clear-<version>-live.img.xz | findstr -v file
Compare the output with the original checksum to make sure they match.
Burn the Clear Linux image onto a USB drive
===========================================
.. caution::
Backup important data before proceeding. The process of burning an image
onto the USB drive completely formats the
USB drive and any existing content will be destroyed.
#. Download the `Rufus`_ tool to burn the image onto a USB drive.
#. Plug in the USB drive.
#. Select the |CL| image file and ensure that “Create a bootable disk using DD
Image” is checked. See Figure 1.
.. figure:: figures/bootable-usb-windows-1.png
:alt: Burn image onto USB drive
#. Click Start.
Next steps
----------
With a bootable |CL| USB drive, you can:
* :ref:`bare-metal-install`
* :ref:`boot-live-image`
* :ref:`multi-boot`
.. _Rufus: http://rufus.akeo.ie/
.. _releases: https://download.clearlinux.org/releases
.. _image: https://download.clearlinux.org/image
source/clear-linux/get-started/bootable-usb/bootable-usb.rst
+14
View File
@@ -0,0 +1,14 @@
.. _bootable-usb:
Create a bootable Clear Linux USB drive
#######################################
Instructions to create a |CLOSIA| USB drive vary depending on the system you are
using. See below for step-by-step instructions catered to your system:
.. toctree::
:maxdepth: 1
bootable-usb-linux
bootable-usb-windows
bootable-usb-mac
source/clear-linux/get-started/bootable-usb/figures/bootable-usb-mac-1.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 116 KiB

source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-1.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 93 KiB

source/clear-linux/get-started/compatibility-check.rst
+48 -24
View File
@@ -1,37 +1,61 @@
.. _compatibility-check:
Check system compatibility with Clear Linux OS for Intel® Architecture
######################################################################
Check processor and EFI firmware compatibility with Clear Linux\*
*****************************************************************
If you’re unsure whether your system will be capable of running
|CL|\* OS for Intel® Architecture, you can determine ahead of time by
downloading and running the simple clear-linux-check-config.sh script locally
on your target system if it is already running a Linux distribution.
On a system that is currently running a Linux operating system, follow the
instructions below to determine if your system's processor and EFI firmware is
capable of running |CLOSIA|. Otherwise,
:ref:`run Clear Linux as a Live image <live-image>` and then perform the steps
below.
This script is available in the current download directory at clearlinux.org
and checks the hardware capabilities of your system to determine whether it
will work with the latest release of |CL|. To run the clear-linux-
check- config.sh script, enter the following commands on your target system:
.. note::
This does not check other system components (for example: storage and
graphics) for compatibility with |CL|.
.. code-block:: console
#. Download the `clear-linux-check-config.sh`_ file.
curl -O https://download.clearlinux.org/current/clear-linux-check-config.sh
chmod +x clear-linux-check-config.sh
./clear-linux-check-config.sh host
If a browser is not available, use:
The script will print a list of test results similar to the output below. All
items should return a 'SUCCESS' status and if it does, your target system
fully supports installing and running |CL|.
.. code-block:: console
.. code-block:: console
$ curl -O https://download.clearlinux.org/current/clear-linux-check-config.sh
Checking if host is capable of running |CL|\* OS for Intel®
Architecture
#. Make the script executable.
SUCCESS: Intel CPU
.. code-block:: console
SUCCESS: 64-bit CPU (lm)
$ chmod +x clear-linux-check-config.sh
SUCCESS: Streaming SIMD Extension v4.1 (sse4_1)
#. Run the script.
SUCCESS: EFI Firmware
#. Check to see if the host's processor and EFI firmware is capable of
running |CL|.
.. code-block:: console
$ ./clear-linux-check-config.sh host
#. Check to see if the host is capable of running |CL| in a container.
.. code-block:: console
$ ./clear-linux-check-config.sh container
The script will print 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|.
.. code-block:: console
Checking if host is capable of running Clear Liunx* OS for Intel® Architecture
SUCCESS: Intel CPU
SUCCESS: 64-bit CPU (lm)
SUCCESS: Streaming SIMD Extension v4.1 (sse4_1)
SUCCESS: EFI Firmware
.. _clear-linux-check-config.sh: https://download.clearlinux.org/current/clear-linux-check-config.sh
source/clear-linux/get-started/get-started.rst
+2 -1
View File
@@ -14,8 +14,9 @@ information and instructions on how to complete pre-install tasks.
.. toctree::
:maxdepth: 1
../reference/system-requirements
bare-metal-install/bare-metal-install
virtual-machine-install/virtual-machine-install
live-image
compatibility-check
../reference/supported-hardware
bootable-usb/bootable-usb
source/clear-linux/get-started/live-image.rst
+37 -27
View File
@@ -3,41 +3,51 @@
Install Clear Linux as a live image
###################################
This option is a great way to try a live |CL| environment without writing
to your computer's hard disk.
A live image contains the complete |CLOSIA| operating system and resides
on a bootable media such as a USB drive or in a virtual machine
(see :ref:`virtual-machine-install`). This is a
great way to use |CL| without modifying your computer's hard disk.
Use the live image to boot the OS in a VM, or you can create a bootable
USB drive and boot from USB.
.. include:: bootable-usb/bootable-usb-linux.rst
:Start-after: bootable-usb-linux:
:end-before: download-cl-image
Be aware, however, that if you do **not** manually configure the install and
instead use the auto-install, it will repartition ``/dev/sda``.
This image also enables telemetry by default; see the `telemetry`_ feature
page for more details.
Download the latest Clear Linux Live image
******************************************
Download the latest Clear Linux Live Image
------------------------------------------
#. Get the latest |CL| Live image from the `image`_ page. Look for
`clear-<version>-live.img.xz`.
Download the ``clear-[version_number]-live.img.xz``
image in the `current`_ version's download directory.
For older versions, see the `releases`_ page.
For older versions, see our `releases`_ page.
#. Although not required, it is recommended to download the corresponding
checksum file (designated with `-SHA512SUMS` at the end of the filename) for
the image in order to verify its integrity.
.. include:: bare-metal-install/bare-metal-install.rst
:Start-after: create-usb:
:end-before: download-clear-linux-image
.. include:: bootable-usb/bootable-usb-linux.rst
:Start-after: verify-checksum:
:end-before: verify-checksum-on-macos
This example uses release 10980 so we will download the
:file:`clear-10980-installer.img.xz` image file.
.. include:: bootable-usb/bootable-usb-linux.rst
:Start-after: copy-usb-linux:
:end-before: usb-next
.. include:: bare-metal-install/bare-metal-install.rst
:Start-after: copy-image:
:end-before: install-on-target
.. _boot-live-image:
**Congratulations!**
Boot the Clear Linux Live image
*******************************
You are now ready to boot from USB and kick the tires on your live |CL|
environment.
#. Configure the BIOS/UEFI firmware settings of the target system:
* Enable `Intel® Virtualization Technology (Intel® VT)`_
* Enable `Intel® Virtualization Technology for Directed I/O (Intel® VT-d)`_
* Disable `Secure Boot`
#. Plug the imaged USB drive in and boot it up.
#. Log in as `root` and set a password.
.. _`releases`: https://download.clearlinux.org/releases
.. _`image`: https://download.clearlinux.org/image
.. _`Intel® Virtualization Technology (Intel® VT)`: http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
.. _`Intel® Virtualization Technology for Directed I/O (Intel® VT-d)`: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices>`
.. _telemetry: https://clearlinux.org/features/telemetry
.. _releases: https://download.clearlinux.org/releases
.. _current: http://download.clearlinux.org/current
source/clear-linux/reference/compatible-kernels.rst
+6 -6
View File
@@ -12,7 +12,7 @@ Kernel native
The *kernel-native* bundle focuses on the bare metal platforms. It is
optimized for fast booting and performs best on the Intel® architectures
described on the :ref:`supported hardware list<supported-hardware>`. The
described on the :ref:`supported hardware list<system-requirements>`. The
optimization patches are found in our `Linux`_ GitHub\* repo.
Kernel Container
@@ -21,7 +21,7 @@ Kernel Container
The *kernel-container* bundle contains the kernel used by the
`Intel® Clear Containers`_ project. This kernel is optimized for
fast booting and performs best on |CC| running on the Intel® architectures
described on the :ref:`supported hardware list<supported-hardware>`.
described on the :ref:`supported hardware list<system-requirements>`.
The optimization patches are found in our `Linux-Container`_ GitHub repo.
.. _vm-kernels:
@@ -32,7 +32,7 @@ Kernel LTS
The *kernel-lts* bundle focuses on the bare metal platforms but uses the
latest :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast
booting and performs best on the Intel® architectures described on the
:ref:`supported hardware list<supported-hardware>`. Additionally, this
:ref:`supported hardware list<system-requirements>`. Additionally, this
kernel includes the VirtualBox\* kernel modules, see our
:ref:`instructions on using Virtualbox<virtualbox>` for more information.
The optimization patches are found in our `Linux-LTS`_ GitHub repo.
@@ -43,7 +43,7 @@ Kernel KVM
The *kernel-kvm* bundle focuses on the Linux
:abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast booting
and performs best on Virtual Machines running on the Intel® architectures
described on the :ref:`supported hardware list<supported-hardware>`.
described on the :ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS
on top of *qemu/kvm*. Use this kernel with **cloud orchestrators** using
*qemu/kvm* internally as their **hypervisor**.
@@ -57,7 +57,7 @@ Kernel Hyper-V\*
The *kernel-hyperv* bundle focuses on running Linux on Microsoft\*
Hyper-V. It is optimized for fast booting and performs best on Virtual
Machines running on the Intel® architectures described on the
:ref:`supported hardware list<supported-hardware>`.
:ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
projects such as Microsoft `Azure`_\*. This kernel can be used as a stand
alone Linux VM, see our :ref:`instructions on using Hyper-V<hyper-v>` for
@@ -71,7 +71,7 @@ The *kernel-hyperv-lts* bundle focuses on running Linux on Microsoft
Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel. It
is optimized for fast booting and performs best on Virtual
Machines running on the Intel® architectures described on the
:ref:`supported hardware list<supported-hardware>`.
:ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
projects such as Microsoft `Azure`_. This kernel can be used as a stand
alone Linux VM, see our :ref:`instructions on using Hyper-V<hyper-v>` for
source/clear-linux/reference/reference.rst
+1 -1
View File
@@ -12,4 +12,4 @@ regarding the |CL| project and the |CL| features.
bundle-commands
bundles/available-bundles
compatible-kernels
supported-hardware
system-requirements
source/clear-linux/reference/supported-hardware.rst
-46
View File
@@ -1,46 +0,0 @@
.. _supported-hardware:
Supported hardware
##################
Clear Linux\* OS for Intel® Architecture can run on all Intel® 64bit
processors which support UEFI\* and SSE\* v4.1 streaming SIMD\* instructions.
The following processor families can run |CL|:
* 2nd Generation, or later, Intel® Core™ processor family.
* Intel® Xeon® Processor E3
* Intel® Xeon® Processor E5
* Intel® Xeon® Processor E7
* Intel® Atom™ processor C2000 product family for servers -- Q3 2013 version
or later.
* Intel® Atom™ processor E3800 series -- Q4 2013 version or later.
If you're unsure whether your system will be capable of running Clear Linux\*
OS for Intel® Architecture, you can check the hardware capabilities of your
system to determine whether it will work with the latest release:
.. toctree::
:maxdepth: 1
../get-started/compatibility-check.rst
.. note::
Only a system running a Linux distribution can run the compatibility
check. There are two alternative options:
* Install and run a Linux distribution directly on your system.
* Run a live image from a USB stick.
Disclaimers
===========
Intel, Xeon, Intel Atom, and Intel Core are trademarks of Intel Corporation
or its subsidiaries in the U.S. and/or other countries.
.. _clear-linux-check-config.sh:
http://download.clearlinux.org/current/clear-linux-check-config.sh
.. _current:
http://download.clearlinux.org/current
source/clear-linux/reference/system-requirements.rst
+43
View File
@@ -0,0 +1,43 @@
.. _system-requirements:
Recommended minimum system requirements
#######################################
Clear Linux\* OS for Intel® Architecture can run on very minimal hardware.
For example, it can run on a system with a single core CPU, 128MB of memory,
and 600MB of disk space.
Different use cases and applications will require different configurations.
For general |CL| use, in addition to a supported processor, the recommended
minimum requirements include:
* Processors:
Clear Linux\* OS for Intel® Architecture can run on any Intel® 64bit
processors which support UEFI\* and SSE\* v4.1 streaming SIMD\*
instructions.
The following processor families have been verified to run |CL|:
* 2nd Generation, or later, Intel® Core™ processor family.
* Intel® Xeon® Processor E3
* Intel® Xeon® Processor E5
* Intel® Xeon® Processor E7
* Intel® Atom™ processor C2000 product family for servers -- Q3 2013
version or later.
* Intel® Atom™ processor E3800 series -- Q4 2013 version or later.
To help determine if a processor is supported, you can run a
:ref:`compatibility check<compatibility-check>` or go to
http://ark.intel.com and check for these features:
* Instruction Set = 64-bit
* Instruction Set Extensions = SSE 4.1
* Memory: 4GB RAM
* Hard Disk: 20GB HDD
* Network: Active Internet connection
* Graphics: Intel HD Graphics (required if running a GUI desktop)
source/clear-linux/tutorials/multi-boot/multi-boot.rst
+8 -1
View File
@@ -76,6 +76,13 @@ installation of the tested operating systems.
Install the Clear Linux OS
**************************
#. Create a bootable USB drive of the |CL| installer using one of the methods
below.
* :ref:`bootable-usb-linux`
* :ref:`bootable-usb-mac`
* :ref:`bootable-usb-windows`
#. Start the |CL| installer and follow the prompts.
#. On the *Choose Installation Type* screen, choose *Manual (Advanced)*,
@@ -844,7 +851,7 @@ The installation of a new operating system or an upgrade of an existing
operating system can result in making the |CL| Systemd-Boot no
longer the default boot loader. To restore it, follow the steps below.
#. Boot the |CL| installer from a USB thumb drive. See :ref:`create-usb`.
#. Boot the |CL| installer from a USB thumb drive. See :ref:`bootable-usb`.
#. At the introduction screen, press :kbd:`Control+Alt+F2` to bring up the
|CL| console. See Figure 37.