Revise to incorporate new GUI installer and screenshots. (#477)

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Creates live desktop installation instructions based on clear-29180-0502-live-desktop.iso.
- Renames dir from bare-metal-install-beta to bare-metal-install-desktop
- Creates and assigns new screenshots for UI
- Re-links default ref from tutorials, etc. to bare-metal-install-desktop

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revise per developer feedback on PR.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revises Finish Installation steps. Correct scale Figures 1-3.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>

Revises intro para.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
michael vincerra
2019-05-09 14:27:21 -07:00
committed by GitHub
parent 5b20941aeb
commit 5ff59f975d
69 changed files with 479 additions and 922 deletions
@@ -1,845 +0,0 @@
.. _bare-metal-install-beta:
Install |CL-ATTR| from the live desktop beta image
##################################################
The live desktop beta image allows you to boot |CL-ATTR| into a GNOME
desktop without modifying the host system. Using the live image, you can
explore the possibilities of developing with |CL|.
You can also launch the installer to install |CL| on your target system.
If you proceed with installation, this document assumes you follow the
`Recommended options`_.
.. contents:: :local:
:depth: 1
System requirements
*******************
Assure that your target system supports the installation:
* :ref:`system-requirements`
* :ref:`compatibility-check`
Preliminary steps
*****************
#. `Navigate to the image directory`_.
#. Download the file :file:`clear-<release number>-live-desktop-beta.img.xz`
.. note::
<release-number> is the latest |CL| auto-numbered release.
#. Follow your OS instructions to create a bootable USB drive.
* :ref:`bootable-usb`
.. _install-on-target-start:
Install from live image
***********************
After you've downloaded and burned the live desktop image on a
USB drive, follow these steps.
#. Insert the USB drive into an available USB slot.
#. Power on the system.
#. Open the system BIOS setup menu by pressing the :kbd:`F2` key.
.. note::
Your BIOS setup menu entry point may vary.
#. In the setup menu, enable the UEFI boot and set the USB drive as the
first option in the device boot order.
#. Save these settings and exit.
#. Reboot the target system.
.. _install-on-target-end:
Launch the installer
====================
#. After the |CL| live desktop image boots, select the :guilabel:`Activities` menu in the upper left.
#. Select the icon, :guilabel:`Install Clear Linux OS`, shown in Figure 1.
.. figure:: figures/bare-metal-install-beta-1.png
:scale: 50 %
:alt: Install Clear Linux OS icon
Figure 1: Install Clear Linux OS icon
#. Upon selecting the icon, the installer is launched, as shown in Figure 2.
.. figure:: figures/bare-metal-install-beta-2.png
:scale: 50 %
:alt: Clear Linux OS Installer
Figure 2: Clear Linux OS Installer
.. _incl-bare-metal-beta-start:
Minimum installation requirements
*********************************
To fulfill minimum installation requirements, complete the
`Required options`_. We also encourage you to install `Recommended options`_ for a full desktop experience. `Advanced options`_ are optional.
.. note::
* The :kbd:`Install` button is **only highlighted after** you complete
`Required options`_.
* You must choose whether or not to participate in :ref:`telem-guide`
before you can finish installation.
* You may `Test Network Settings`_ before installation
`Configure Network Interfaces`_. Assure a *Success* message appears before installation.
Main Menu
*********
The |CL| Installer Main Menu appears as shown in Figure 3.
.. figure:: figures/bare-metal-install-beta-3.png
:scale: 100%
:alt: Clear Linux OS Installer Main Menu
Figure 3: Clear Linux OS Installer Main Menu
The |CL| Installer Main Menu has two tabs: :guilabel:`[R] Required options`
and :guilabel:`[A] Advanced options`. Navigate between tabs using the arrow
keys or these shortcut keys:
* :kbd:`Shift+A` for :guilabel:`[A] Advanced options`
* :kbd:`Shift+R` for :guilabel:`[R] Required options`
To meet the minimum requirements, enter your choices in the
:guilabel:`Required options`. After confirmation, your selections appear
beside the :guilabel:`>>` chevron, below the menu options.
Navigation
**********
* Select :kbd:`Tab` or :kbd:`Up/Down` arrows to highlight your choice.
* Select :kbd:`Enter` or :kbd:`Spacebar` to confirm your choice.
* Select :kbd:`Cancel` or :kbd:`Esc` to cancel your choice.
Required options
****************
Choose Timezone
===============
#. From the Main Menu, select :guilabel:`Choose Timezone`.
#. Select :kbd:`Enter` to continue.
#. In :guilabel:`Select System Timezone`, navigate to
the desired timezone.
#. Use :kbd:`Tab` to navigate to :guilabel:`Confirm`.
#. Select :kbd:`Enter` to :kbd:`Confirm`.
.. note::
Select :guilabel:`Cancel` to restore the previously defined value and
return to the Main Menu.
.. figure:: figures/bare-metal-install-beta-4.png
:scale: 100%
:alt: Select System Timezone
Figure 4: Select System Timezone
Choose Language
===============
#. From the Main Menu, select :guilabel:`Choose Language`.
#. Select :kbd:`Enter`.
#. In :guilabel:`Select System Language`, navigate to your desired language.
#. Select :kbd:`Tab` to highlight :kbd:`Confirm`.
#. Select :kbd:`Enter` to :kbd:`Confirm`.
.. note::
Select :guilabel:`Cancel` to restore the previously defined value and return to the Main Menu.
.. figure:: figures/bare-metal-install-beta-5.png
:scale: 100%
:alt: Select System Language
Figure 5: Select System Language
Configure the Keyboard
======================
#. From the Main Menu, select :guilabel:`Configure the Keyboard`.
#. Select :kbd:`Enter`.
#. In :guilabel:`Select Keyboard`, navigate to the desired option.
#. In :guilabel:`Test keyboard`, type text to assure that the keys map to
your keyboard.
#. Select :kbd:`Tab` to highlight :guilabel:`Confirm`.
#. Select :kbd:`Enter` to :kbd:`Confirm`.
.. note::
Select :guilabel:`Cancel` to restore the previously defined value and return to the Main Menu.
.. figure:: figures/bare-metal-install-beta-6.png
:scale: 100%
:alt: Select Keyboard menu
Figure 6: Select Keyboard menu
Configure Installation Media
============================
#. From the Main Menu, select :guilabel:`Configure Installation Media`.
#. Choose an installation method: `Safe Installation`_;
`Destructive Installation`_; or `Advanced Configuration`_
.. figure:: figures/bare-metal-install-beta-7.png
:scale: 100%
:alt: Select Installation Media
Figure 7: Select Installation Media
Safe Installation
-----------------
Use this method to safely install |CL| on media with available space,
or alongside existing partitions, and accept the recommended partitioning
schema. If an unallocated partition exists with enough space, safe
installation is allowed.
If a warning message appears that no media or space is available:
- Verify that target media has enough unallocated disk space
- Confirm target media is properly connected or mounted
- Review the size of existing partitions on the target media:
- Linux\* OS: :command:`lsblk -a`
- Windows\* OS: :command:`diskpart`, then :command:`list disk`
- macOS\* platform: :command:`diskutil list`
Destructive Installation
------------------------
Use this method to destroy the contents of the target device, install |CL|,
and accept the recommended partitioning schema. If no safe options exist,
:guilabel:`Destructive Installation` will appear by default.
.. note::
From the :guilabel:`Select Installation Media` menu, select
:guilabel:`Enable Encryption` to encrypt the root filesystem for either option above. See also `Disk encryption`_ for more information.
Partition minimum requirements
-------------------------------
To add partitions manually, see `Advanced configuration`_ below and create
partitions per requirements in Table 1.
.. list-table:: **Table 1. Disk Partition Setup: Minimum requirements**
:widths: 33, 33, 33
:header-rows: 1
* - FileSystem
- Mount Point
- Minimum size
* - ``VFAT``
- /boot
- 150M
* - ``swap``
-
- 256MB
* - ``root``
- /
- *Size depends upon use case/desired bundles.*
Advanced Configuration
----------------------
Use this method to manually configure partitions. Partitions
must meet `Partition minimum requirements`_.
You may also choose `Disk encryption`_ during partitioning.
.. note::
Advanced Configuration is available in the installer versions 1.2.0 and above.
#. In :guilabel:`Advanced Configuration`, press
:kbd:`Enter` to activate editing.
.. figure:: figures/bare-metal-install-beta-8.png
:scale: 100%
:alt: Advanced configuration menu
Figure 8: Advanced configuration menu
#. Choose one of these options:
:guilabel:`Auto Partition`
#. Select this option to accept the recommended partitioning schema.
#. Navigate to and press :guilabel:`Confirm`.
#. Continue with installation configuration.
:guilabel:`Manual Partition`
#. Continue below.
Manual Partition
----------------
We provide a simple example below.
#. Navigate to the unallocated media (e.g.,`sdb1`) until highlighted.
#. Select :guilabel:`Enter` to edit the partition.
#. The :guilabel:`Partition Setup` menu appears, shown in Figure 9.
.. note::
After adding the first partition, select :guilabel:`Free Space` to add another partition.
root partition
--------------
We configure the `root` partition as shown in Figure 9.
.. figure:: figures/bare-metal-install-beta-9.png
:scale: 100%
:alt: root partition
Figure 9: root partition
boot partition
--------------
We configure the `boot` partition as shown in Figure 10.
.. figure:: figures/bare-metal-install-beta-10.png
:scale: 100%
:alt: boot partition
Figure 10: boot partition
swap partition
--------------
#. In the :guilabel:`File System` pulldown menu, we select `swap`, and
enter its label. We enter the minimum required size (e.g., 256M).
.. figure:: figures/bare-metal-install-beta-11.png
:scale: 100%
:alt: swap partition
Figure 11: swap partition
#. Next, navigate to :guilabel:`Confirm` and press :guilabel:`Enter`,
shown in Figure 12.
.. figure:: figures/bare-metal-install-beta-12.png
:scale: 100%
:alt: Final configuration of disk partitions
Figure 12: Final configuration of disk partitions
#. You may skip to the `Telemetry`_ section below.
Disk encryption
===============
For greater security, disk encryption is supported using LUKS for the
any partition except `/boot` on |CL|. To encrypt the root partition, see the
example below. Encryption is optional.
Encryption Passphrase
---------------------
|CL| uses a single passphrase for encrypted partitions. Additional or
different keys may be configured post-installation using the ``cryptsetup``
tool.
#. Optional: Select :guilabel:`[X] Encrypt` to encrypt the root partition,
as shown in Figure 13.
.. figure:: figures/bare-metal-install-beta-13.png
:scale: 100%
:alt: Encrypt partition
Figure 13: Encrypt partition
#. The :guilabel:`Encryption Passphrase` dialogue appears.
.. note::
Minimum length is 8 characters. Maximum length is 94 characters.
.. figure:: figures/bare-metal-install-beta-14.png
:scale: 100%
:alt: Encryption Passphrase
Figure 14: Encryption Passphrase
#. Enter the same passphrase in the first and second field.
#. Navigate to :guilabel:`Confirm` and press :kbd:`Enter`.
.. note::
:guilabel:`Confirm` is only highlighted if passphrases match.
Telemetry
=========
To fulfill :guilabel:`Required options`, choose whether to participate in
the `telemetry option`_. :ref:`telem-guide` is a |CL| feature that reports
failures and crashes to the |CL| development team for improvements. For more
detailed information, visit our :ref:`telemetry-about` page.
#. In the Main Menu, navigate to :guilabel:`Telemetry` and select
:kbd:`Enter`.
#. Select :kbd:`Tab` to highlight your choice.
#. Select :kbd:`Enter` to confirm.
.. figure:: figures/bare-metal-install-beta-15.png
:scale: 100%
:alt: Enable Telemetry
Figure 15: Enable Telemetry
Recommended options
*******************
After you complete the `Required options`_, we highly recommend completing
a few `Advanced options`_ at minimum:
* `Bundle Selection`_ Add basic utlities and tools:
* :file:`desktop-autostart`
* :file:`user-basic`
* `User Manager`_ Assign a new user with administrative rights
* `Assign Hostname`_ Simplify your development environment
This document assumes you follow these additional steps.
Skip to finish installation
===========================
After selecting values for all :guilabel:`Required options`, you may skip
to `Finish installation`_.
Otherwise, continue below. In the Main Menu, select
:guilabel:`Advanced options` for additional configuration.
Advanced options
****************
Configure Network Interfaces
============================
By default, |CL| is configured to automatically detect the host network
interface using DHCP. However, if you want to use a static IP address or if
you do not have a DHCP server on your network, follow these instructions to
manually configure the network interface. Otherwise, default network
interface settings are automatically applied.
.. note::
If DHCP is available, no user selection may be required.
#. Navigate to :guilabel:`Configure Network Interfaces` and
select :kbd:`Enter`.
#. Navigate to the network :guilabel:`interface` you wish to change.
#. When the desired :guilabel:`interface` is highlighted, select
:guilabel:`Enter` to edit.
.. note:: Multiple network interfaces may appear.
.. figure:: figures/bare-metal-install-beta-16.png
:scale: 100%
:alt: Configure Network Interfaces
Figure 16: Configure Network Interfaces
#. Notice :guilabel:`Automatic / dhcp` is selected by default (at bottom).
Optional: Navigate to the checkbox :guilabel:`Automatic / dhcp` and select
:kbd:`Spacebar` to deselect.
.. figure:: figures/bare-metal-install-beta-17.png
:scale: 100%
:alt: Network interface configuration
Figure 17: Network interface configuration
#. Navigate to the appropriate fields and assign the desired
network configuration.
#. To save settings, navigate to :guilabel:`Confirm` and select
:kbd:`Enter`.
.. note::
To revert to previous settings, navigate to the :guilabel:`Cancel`
and select :kbd:`Enter`.
#. Upon confirming network configuration, the :guilabel:`Testing Networking`
dialogue appears. Assure the result shows success. If a failure occurs,
your changes will not be saved.
#. Upon confirmation, you are returned to :guilabel:`Network interface`
settings.
#. Navigate to and select :guilabel:`Main Menu`.
Optional: Skip to `Finish installation`_.
Proxy
=====
|CL| automatically attempts to detect proxy settings, as described in
`Autoproxy`_. If you need to manually assign proxy settings, follow this
instruction.
#. From the Advanced options menu, navigate to :guilabel:`Proxy`, and
select :kbd:`Enter`.
#. Navigate to the field :guilabel:`HTTPS Proxy`.
.. figure:: figures/bare-metal-install-beta-18.png
:scale: 100%
:alt: Configure the network proxy
Figure 18: Configure the network proxy
#. Enter the desired proxy address and port using conventional syntax,
such as: \http://address:port.
#. Navigate to :guilabel:`Confirm` and select :kbd:`Enter`.
#. To revert to previous settings, navigate to :guilabel:`Cancel`
and select :guilabel:`Cancel`.
Optional: Skip to `Finish installation`_.
Test Network Settings
=====================
To manually assure network connectivity before installing |CL|,
select :guilabel:`Test Network Settings` and select :guilabel:`Enter`.
A progress bar appears as shown in Figure 19.
.. figure:: figures/bare-metal-install-beta-19.png
:scale: 100%
:alt: Testing Networking dialogue
Figure 19: Testing Networking dialogue
.. note::
Any changes made to network settings are automatically tested
during configuration.
Optional: Skip to `Finish installation`_.
Bundle Selection
================
#. On the Advanced menu, select :guilabel:`Bundle Selection`
#. Navigate to the desired bundle using :kbd:`Tab` or :kbd:`Up/Down` arrows.
#. Select :kbd:`Spacebar` to select the checkbox for each desired bundle.
#. We recommend adding :file:`desktop-autostart` and :file:`user-basic`.
.. figure:: figures/bare-metal-install-beta-20.png
:scale: 100%
:alt: Bundle Selection
Figure 20: Bundle Selection
.. note::
The default bundle choices and selections differ between the
:file:`clear-<XXXXX>.live-desktop-beta.img` and the
:file:`clear-<XXXXX>.installer.img`.
#. Select :kbd:`Confirm` or :kbd:`Cancel`.
You are returned to the :guilabel:`Advanced options` menu.
Optional: Skip to `Finish installation`_.
User Manager
============
Add New User
------------
#. In Advanced Options, select :guilabel:`User Manager`.
#. Select :guilabel:`Add New User` as shown in Figure 21.
.. figure:: figures/bare-metal-install-beta-21.png
:scale: 100%
:alt: Add New User, User Name
Figure 21: Add New User
#. Optional: Enter a :guilabel:`User Name`.
.. note:
The User Name must be alphanumeric and can include spaces, commas, or hyphens. Maximum length is 64 characters.
.. figure:: figures/bare-metal-install-beta-22.png
:scale: 100%
:alt: User Name
Figure 22: User Name
#. Enter a :guilabel:`Login`.
.. note::
The User Login must be alphanumeric and can include hyphens and underscores. Maximum length is 31 characters.
#. Enter a :guilabel:`Password`.
.. note:
Minimum length is 8 characters. Maximum length is 255 characters.
#. In :guilabel:`Retype`, enter the same password.
#. Optional: Navigate to the :guilabel:`Administrative` checkbox and select
:kbd:`Spacebar` to assign administrative rights to the user.
.. note::
Selecting this option enables sudo privileges for the user.
.. figure:: figures/bare-metal-install-beta-23.png
:scale: 100%
:alt: Administrative rights
Figure 23: Administrative rights
#. Select :kbd:`Confirm`.
.. note::
If desired, select :guilabel:`Reset` to reset the form.
#. In :guilabel:`User Manager`, navigate to :guilabel:`Confirm`.
#. With :guilabel:`Confirm` highlighted, select :kbd:`Enter`.
Modify / Delete User
--------------------
#. In User Manager, select :guilabel:`Tab` to highlight the user, as shown
in Figure 24.
#. Select :kbd:`Enter` to modify the user.
.. figure:: figures/bare-metal-install-beta-24.png
:scale: 100%
:alt: Modify User
Figure 24: Modify User
#. Modify user details as desired.
Optional: To delete the user, navigate to the :guilabel:`Delete`
button and select :kbd:`Enter`
#. Navigate to :kbd:`Confirm` until highlighted.
.. note::
Optional: Select :guilabel:`Reset` to rest the form.
#. Select :guilabel:`Confirm` to save the changes you made.
You are returned to the User Manager menu.
Optional: Skip to `Finish installation`_.
Kernel Command Line
===================
For advanced users, |CL| provides the ability to add or remove kernel
arguments. If you want to append a new argument, enter the argument here.
This argument will be used every time you install or update a
new kernel.
#. In Advanced Options, select :guilabel:`Tab` to highlight
:guilabel:`Kernel Command Line`.
#. Select :kbd:`Enter`.
#. To add or remove arguments, choose one of the following options.
.. figure:: figures/bare-metal-install-beta-25.png
:scale: 100%
:alt: kernel command line
Figure 25: kernel command line
#. To add arguments, enter the argument in :guilabel:`Add Extra Arguments`.
#. To remove an existing argument, enter the argument in
:guilabel:`Remove Arguments`.
#. Select :kbd:`Confirm`.
Optional: Skip to `Finish installation`_.
Kernel Selection
================
#. Select a kernel option. By default, the latest kernel release is
selected. Native kernel is shown in Figure 26.
#. To select a differnt kernel, navigate to it using :guilabel:`Tab`.
.. figure:: figures/bare-metal-install-beta-26.png
:scale: 100%
:alt: Kernel selection
Figure 26: Kernel selection
#. Select :kbd:`Spacebar` to select the desired option.
#. Select :kbd:`Confirm`.
Optional: Skip to `Finish installation`_.
Swupd Mirror
============
If you have your own custom mirror of |CL|, you can add its URL.
#. In Advanced Options, select :guilabel:`Swupd Mirror`.
#. To add a local swupd mirror, enter a valid URL in :guilabel:`Mirror URL:`
#. Select :kbd:`Confirm`.
.. figure:: figures/bare-metal-install-beta-27.png
:scale: 100%
:alt: Swupd Mirror
Figure 27: Swupd Mirror
Optional: Skip to `Finish installation`_.
Assign Hostname
===============
#. In Advanced Options, select :guilabel:`Assign Hostname`.
#. In :guilabel:`Hostname`, enter the hostname only (excluding the domain).
.. note::
Hostname does not allow empty spaces. Hostname must start with an
alphanumeric character but may also contain hyphens. Maximum length of
63 characters.
.. figure:: figures/bare-metal-install-beta-28.png
:scale: 100%
:alt: Assign Hostname
Figure 28: Assign Hostname
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :kbd:`Confirm`.
Optional: Skip to `Finish installation`_.
Automatic OS Updates
====================
In the rare case that you need to disable automatic software updates,
follow the onscreen instructions shown in Figure 29.
#. In Advanced Options, select :guilabel:`Automatic OS Updates`.
#. Select the desired option.
.. figure:: figures/bare-metal-install-beta-29.png
:scale: 100%
:alt: Automatic OS Updates
Figure 29: Automatic OS Updates
You are returned to the :guilabel:`Main Menu`.
Finish installation
*******************
#. When you are satisfied with your installation configuration, navigate to
:guilabel:`Install` and select :kbd:`Enter`.
#. Select :guilabel:`reboot`.
.. note::
If you do not perform `Recommended options`_, upon rebooting, a
:file:`login:` prompt will appear. At the prompt, enter `root` and change your password immediately.
#. When the system reboots, remove any installation media present.
.. note::
Allow time for the graphical login to appear. This shows the administrative user that you created in `Recommended options`_.
#. Log in as the adminstrative user.
Next steps
**********
:ref:`enable-user-space`
.. _Navigate to the image directory: https://cdn.download.clearlinux.org/image/
.. _Autoproxy: https://clearlinux.org/features/autoproxy
.. _telemetry option: https://clearlinux.org/features/telemetry
Binary file not shown.

Before

Width:  |  Height:  |  Size: 663 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 537 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

@@ -0,0 +1,447 @@
.. _bare-metal-install-desktop:
Install |CL-ATTR| from the live desktop
#######################################
The live desktop allows you to boot |CL-ATTR| in a GNOME desktop without
modifying the host system, offering the chance to explore developing
on |CL|. Better yet, launch the |CL| installer to install on your target
system.
.. contents:: :local:
:depth: 1
System requirements
*******************
Assure that your target system supports the installation:
* :ref:`system-requirements`
* :ref:`compatibility-check`
Preliminary steps
*****************
#. `Visit our Downloads page`_.
#. Download the file :file:`clear-<release number>-live-desktop.iso`
.. note::
<release-number> is the latest |CL| auto-numbered release.
#. Follow your OS instructions to create a bootable USB drive.
* :ref:`bootable-usb`
.. _install-on-target-start:
Install from live image
***********************
After you download and burn the live desktop image on a USB drive, follow
these steps.
#. Insert the USB drive into an available USB slot.
#. Power on the system.
#. Open the system BIOS setup menu by pressing the :kbd:`F2` key.
Your BIOS setup menu entry point may vary.
#. In the setup menu, enable the UEFI boot and set the USB drive as the
first option in the device boot order.
#. Save these settings, e.g. :kbd:`F10`, and exit.
#. Reboot the target system.
#. Select :guilabel:`Clear Linux OS` in the boot menu, shown in Figure 1.
.. figure:: figures/bare-metal-install-desktop-01.png
:scale: 100%
:alt: Clear Linux OS in boot menu
Figure 1: Clear Linux OS in boot menu
.. _install-on-target-end:
Launch the |CL| installer
=========================
#. After the live desktop image boots, find the |CL| icon in
the :guilabel:`Activities` menu at left, shown in Figure 2.
#. Click the icon, :guilabel:`Install Clear Linux OS`.
.. figure:: figures/bare-metal-install-desktop-02.png
:scale: 100%
:alt: Install Clear Linux OS icon
Figure 2: Install Clear Linux OS icon
#. The installer is launched, as shown in Figure 3.
.. figure:: figures/bare-metal-install-desktop-03.png
:scale: 100%
:alt: |CL| Desktop Installer
Figure 3: |CL| OS Desktop Installer
#. In :guilabel:`Select Language`, select a language from the options, or
type your preferred language in the search bar.
#. Select :guilabel:`Next`.
.. _incl-bare-metal-beta-start:
Minimum installation requirements
*********************************
To fulfill minimum installation requirements, complete the
`Required options`_. We also recommend completing `Advanced options`_.
.. note::
* The :kbd:`Install` button is only highlighted **after** you complete
`Required options`_.
* Checkmarks indicate a selection has been made.
* An Internet connection is required. You may want to launch a browser
prior to installation to verify your Internet connection.
|CL| Desktop Installer
**********************
The |CL| Desktop Installer Main Menu appears as shown in Figure 4. To meet
the minimum requirements, enter values in all submenus for the
:guilabel:`Required options`. After you complete them, your selections appear
below submenus and a checkmark appears at right.
.. figure:: figures/bare-metal-install-desktop-04.png
:scale: 100%
:alt: Clear Linux OS Desktop Installer - Main Menu
Figure 4: Clear Linux OS Desktop Installer - Main Menu
Navigation
**********
* Use the :kbd:`mouse` to navigate or select options.
* Use :kbd:`Tab` key to navigate between :guilabel:`Required options`
and :guilabel:`Advanced options`
* Use :kbd:`Up` or :kbd:`Down` arrow keys to navigate submenu list.
* Select :kbd:`Confirm`, or :kbd:`Cancel` in submenus.
Required options
****************
Select Time Zone
================
#. From the Main Menu, select :guilabel:`Select Time Zone`. `UTC` is selected
by default.
#. In :guilabel:`Select Time Zone`, navigate to the desired time zone.
Or start typing the region and then city.
(.e.g., :file:`America/Los_Angeles`).
#. Select :guilabel:`Confirm`.
.. figure:: figures/bare-metal-install-desktop-05.png
:scale: 100%
:alt: Select System Timezone
Figure 5: Select System Time Zone
Select Keyboard
===============
#. From the Main Menu, select :guilabel:`Select Keyboard`.
#. Navigate to your desired keyboard layout. We select "us" for the
United States.
#. Select :guilabel:`Confirm`.
.. figure:: figures/bare-metal-install-desktop-06.png
:scale: 100%
:alt: Select Keyboard menu
Figure 6: Select Keyboard menu
Select Installation Media
=========================
#. From the Main Menu, select :guilabel:`Select Installation Media`.
#. Choose an installation method: `Safe Installation`_ or
`Destructive Installation`_.
.. figure:: figures/bare-metal-install-desktop-07.png
:scale: 100%
:alt: Select Installation Media
Figure 7: Select Installation Media
Safe Installation
-----------------
Use this method to safely install |CL| on media with available space, or
alongside existing partitions, and accept the `Default partition schema`_.
If enough free space exists, safe installation is allowed.
Destructive Installation
------------------------
Use this method to destroy the contents of the target device, install |CL| on it, and accept the `Default partition schema`_.
Disk encryption
===============
For greater security, disk encryption is supported using LUKS. Encryption is
optional.
#. To encrypt the root partition, select :guilabel:`Enable Encryption`,
as shown in Figure 8.
.. figure:: figures/bare-metal-install-desktop-08.png
:scale: 100%
:alt: Enable Encryption
Figure 8: Enable Encryption
#. When :guilabel:`Encryption Passphrase` appears, enter a passphrase.
.. figure:: figures/bare-metal-install-desktop-09.png
:scale: 100%
:alt: Encryption Passphrase
Figure 9: Encryption Passphrase
.. note::
Minimum length is 8 characters. Maximum length is 94 characters.
#. Enter the same passphrase in the second field.
#. Select :guilabel:`Confirm` in the dialogue box.
.. note::
:guilabel:`Confirm` is only highlighted if passphrases match.
#. Select :guilabel:`Confirm` in submenu.
Manage User
===========
#. In Required Options, select :guilabel:`Manage User`.
#. In :guilabel:`User Name`, enter a user name.
.. figure:: figures/bare-metal-install-desktop-10.png
:scale: 100%
:alt: Manage User
Figure 10: Manage User
#. In :guilabel:`Login`, create a login name. It must start with a letter
and can use numbers, hyphens, and underscores. Maximum length is 31
characters.
#. In :guilabel:`Password`, enter a password. Minimum length is
8 characters. Maximum length is 255 characters.
#. In :guilabel:`Confirm`, enter the same password.
.. note::
:guilabel:`Administrator` rights are selected by default.
For security purposes, the default user must be assigned as an
Administrator.
#. Select :kbd:`Confirm`.
.. note::
Select :guilabel:`Cancel` to return to the Main Menu.
Modify User
-----------
#. In Manager User, select :guilabel:`Manage User`.
#. Modify user details as desired.
#. Select :guilabel:`Confirm` to save the changes you made.
.. note::
Optional: Select :guilabel:`Cancel` to return to the Main Menu to
revert changes.
Optional: Skip to `Finish installation`_.
Telemetry
=========
Choose whether to participate in `telemetry`. :ref:`telem-guide` is a |CL|
feature that reports failures and crashes to the |CL| development
team for improvements. For more information, see :ref:`telemetry-about`.
#. From :guilabel:`Required Options`, select :guilabel:`Telemetry`.
#. Select :kbd:`Confirm`.
#. If you don't wish to participate, deselect :kbd:`Enable Telemetry`.
#. Select :kbd:`Confirm`.
.. figure:: figures/bare-metal-install-desktop-11.png
:scale: 100%
:alt: Enable Telemetry
Figure 11: Enable Telemetry
Advanced options
****************
After you complete the `Required options`_, we recommend completing
:guilabel:`Advanced options`--though they're not required. Doing so
customizes your development environment, so you're ready to go immediately
after reboot.
* `Bundle Selection`_
* `Assign Hostname`_
As for bundles, you can always add more later with :ref:`swupd-guide`.
Bundle Selection
================
#. On the Advanced menu, select :guilabel:`Bundle Selection`
#. Select your desired bundles.
.. figure:: figures/bare-metal-install-desktop-12.png
:scale: 100%
:alt: Bundle Selection
Figure 12: Bundle Selection
#. Select :kbd:`Confirm`.
#. View the bundles that you selected.
.. figure:: figures/bare-metal-install-desktop-13.png
:scale: 100%
:alt: Bundle Selections - Advanced Options
Figure 13: Bundle Selections - Advanced Options
Optional: Skip to `Finish installation`_.
Assign Hostname
===============
#. In Advanced Options, select :guilabel:`Assign Hostname`.
#. In :guilabel:`Hostname`, enter the hostname only (excluding the domain).
.. figure:: figures/bare-metal-install-desktop-14.png
:scale: 100%
:alt: Assign Hostname
Figure 14: Assign Hostname
.. note::
Hostname does not allow empty spaces. Hostname must start with an
alphanumeric character but may also contain hyphens. Maximum length of
63 characters.
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :kbd:`Confirm`.
Optional: Skip to `Finish installation`_.
Finish installation
*******************
#. When you are satisfied with your installation configuration, select
:guilabel:`Install`.
.. figure:: figures/bare-metal-install-desktop-15.png
:scale: 100%
:alt: Assign Hostname
Figure 15: Finish installation
.. note:
All checkmarks must be visible in :guilabel:`Required Options` for you to select :guilabel:`Install`.
#. If you do not enter a selection for all :guilabel:`Required Options`,
the :guilabel:`Install` button remains greyed out, as shown
in Figure 16. Return to `Required Options`_ and make selections.
.. figure:: figures/bare-metal-install-desktop-16.png
:scale: 100%
:alt: Required Options - Incomplete
Figure 16: Required Options - Incomplete
#. After installation is complete, select :guilabel:`Exit`.
#. Shut down the target system.
#. Remove the USB or any installation media.
#. Power on your system.
.. note::
Allow time for the graphical login to appear. A login prompt shows the administrative user that you created.
#. Log in as the adminstrative user.
Congratulations. You successfully installed |CL|.
Default partition schema
========================
Table 1 shows the defult partition schema with the exception of root,
which varies.
.. list-table:: **Table 1. Disk Partition Setup**
:widths: 33, 33, 33
:header-rows: 1
* - FileSystem
- Mount Point
- Minimum size
* - ``VFAT``
- /boot
- 150M
* - ``swap``
-
- 256MB
* - ``root``
- /
- *Size depends upon use case/desired bundles.*
Next steps
**********
:ref:`guides`
.. _Visit our downloads page: https://clearlinux.org/downloads
.. _Autoproxy: https://clearlinux.org/features/autoproxy
Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 214 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 100 KiB

@@ -6,7 +6,7 @@ Check processor and EFI firmware compatibility
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 |CL-ATTR|. Otherwise,
:ref:`run Clear Linux as a Live image <live-image>` and then perform the steps
:ref:`bare-metal-install-desktop` and then perform the steps
below.
.. note::
@@ -4,8 +4,8 @@ Get started
###########
The Get Started section will get you up and running fast with |CL-ATTR|. Use
these step-by-step instructions to guide you through the installation of |CL|
from bare metal to a live image.
these step-by-step instructions to guide you through the installing |CL|
from a live desktop or to a virtual machine.
Pre-install
***********
@@ -24,7 +24,6 @@ Install |CL|
.. toctree::
:maxdepth: 1
bare-metal-install-desktop/bare-metal-install-desktop
bare-metal-install-server/bare-metal-install-server
virtual-machine-install/virtual-machine-install
live-image
bare-metal-install-beta/bare-metal-install-beta
@@ -1,37 +0,0 @@
.. _live-image:
Install |CL-ATTR| as a live image
#################################
A live image contains the complete |CL-ATTR| 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.
To create a bootable USB drive with a live image, follow
:ref:`our step-by-step instructions<bootable-usb>` and use the latest |CL|
live image from the `image`_ directory. Look for the
:file:`clear-[version number]-live.img.xz` file.
.. _boot-live-image:
Boot the |CL| live image
************************
#. 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.
.. _create and enable user space: https://clearlinux.org/documentation/clear-linux/guides/maintenance/enable-user-space
.. _`image`: https://cdn.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
@@ -183,8 +183,8 @@ Install |CL| using the installer
.. image:: ./figures/vbox/vbox-start-vm.png
:alt: Starting a VirtualBox VM
#. A new window of the VM console will appear and boot into the |CL|
installer. Follow the steps in the `Install Clear Linux OS`_ to
#. A new window of the VM console will appear and boot into the |CL|
installer. Follow the steps in :ref:`bare-metal-install-desktop` to
install |CL| onto the VM virtual disk.
.. note::
@@ -268,8 +268,6 @@ virtual hard disk, which |CL| has been installed to.
.. _`Virtual Media Manager`: https://www.virtualbox.org/manual/ch05.html#vdis
.. _`Install Clear Linux OS`: https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install#install-cl-on-your-target-system\
.. _7zip: http://www.7-zip.org/
.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
@@ -361,8 +361,6 @@ Troubleshooting
.. _`Virtual Media Manager`: https://www.virtualbox.org/manual/ch05.html#vdis
.. _`Install Clear Linux OS`: https://clearlinux.org/documentation/clear-linux/get-started/bare-metal-install#install-cl-on-your-target-system\
.. _7zip: http://www.7-zip.org/
.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
@@ -269,7 +269,7 @@ challenges your monitoring systems, and business continuity plans.
.. _`mixin process`: https://clearlinux.org/documentation/clear-linux/guides/maintenance/mixin
.. _`mixer process`: https://clearlinux.org/documentation/clear-linux/guides/maintenance/mixer
.. _`downloads page`: https://cdn.download.clearlinux.org/image/
.. _`downloads page`: https://clearlinux.org/downloads/
.. _`containers page`: https://clearlinux.org/containers
.. _`systemd journal-remote service`: https://www.freedesktop.org/software/systemd/man/systemd-journal-remote.service.html
.. _`native telemetry solution`: https://clearlinux.org/features/telemetry
Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

@@ -14,14 +14,14 @@ owns in :file:`/usr`. Files outside of this path, such as /home/, /etc,
Prerequisites
*************
* :ref:`Download and install the live desktop image on a USB <bare-metal-install-beta>`
* :ref:`Download and install the live desktop image on a USB <bare-metal-install-desktop>`
Boot a live desktop image to fix target system
**********************************************
#. Boot the |CL| live desktop image.
.. include:: ../../get-started/bare-metal-install-beta/bare-metal-install-beta.rst
.. include:: ../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst
:start-after: install-on-target-start:
:end-before: install-on-target-end:
@@ -181,7 +181,8 @@ The :command:`telemctl journal` command gives you access to features and options
Set up a backend server to collect telemetry records
====================================================
For this example, start with a clean installation of |CL| on a new system using the :ref:`bare-metal-install-server` getting started guide and:
For this example, start with a clean installation of |CL| on a new system
using the :ref:`bare-metal-install-server` getting started guide and:
#. Join the :guilabel:`Stability Enhancement Program` to install and
enable the telemetrics components.
+1 -1
View File
@@ -42,7 +42,7 @@ Release notes
Prerequisites
*************
* |CL| installed on host system. :ref:`Install <bare-metal-install-server>`
* |CL| installed on host system. :ref:`Install <bare-metal-install-desktop>`
* `containers-basic` bundle
* `cloud-native-basic` bundle
@@ -14,7 +14,7 @@ Before you begin
This tutorial assumes you have installed |CL| on your host system.
For detailed instructions on installing |CL| on a bare metal system, visit
our :ref:`bare metal installation tutorial<bare-metal-install-server>`.
our :ref:`bare metal installation guide <bare-metal-install-desktop>`.
Install Flatpak on your host system
===================================
@@ -26,7 +26,6 @@ application, log in to your user account and enter the following command:
sudo swupd bundle-add desktop
Install and run the LibreOffice Flatpak image
=============================================
+4 -7
View File
@@ -20,13 +20,10 @@ libraries to deploy architecture-based optimizations to your application code.
Install and configure a |CL| host on bare metal
***********************************************
First, follow our guide to :ref:`bare-metal-install-server`.
Once the bare metal installation and initial configuration are complete,
add the `desktop-dev` bundle to the system.
`desktop-dev`: contains the necessary development tools like GCC and Perl\*.
First, follow our guide to :ref:`bare-metal-install-desktop`. Once the bare
metal installation and initial configuration are complete, add the
`desktop-dev` bundle to the system. `desktop-dev`: contains the necessary
development tools like GCC and Perl\*.
To install the bundles, run the following command in the :file:`$HOME`
directory:
+3 -3
View File
@@ -58,14 +58,14 @@ Install the OS on the edge device
*********************************
Start with a clean installation of |CL| on a new system, using the
:ref:`bare-metal-install-server`, found in :ref:`get-started`.
:ref:`bare-metal-install-desktop`, found in :ref:`get-started`.
Create user accounts
====================
After |CL| is installed, create two user accounts. Create an administrative
user in |CL| and create a user account for the Greengrass services to use (see
Greengrass user below).
user in |CL| and create a user account for the Greengrass services to use (
see Greengrass user below).
#. Create a new user and set a password for that user. Enter the following
commands as ``root``:
+1 -1
View File
@@ -14,7 +14,7 @@ Prerequisites
*************
Before following this tutorial, you should follow the
:ref:`bare-metal-install-server` to ensure you have installed |CL|.
:ref:`bare-metal-install-desktop` to ensure you have installed |CL|.
Before you install any new packages, update |CL| with the following command:
+1 -1
View File
@@ -13,7 +13,7 @@ Prerequisites
This tutorial assumes you have installed |CL| on your host system.
For detailed instructions on installing |CL| on a bare metal system, follow
the :ref:`bare metal installation tutorial<bare-metal-install-server>`.
the :ref:`bare metal installation tutorial<bare-metal-install-desktop>`.
If you have Clear Containers installed on your |CL| system, then follow the
:ref:`migrate Clear Containers to Kata Containers tutorial<kata_migration>`.
@@ -26,7 +26,7 @@ Prerequisites
This tutorial assumes you have already installed |CL|. For detailed
instructions on installing |CL| on a bare metal system, follow the
:ref:`bare metal installation tutorial<bare-metal-install-server>`.
:ref:`bare metal installation tutorial<bare-metal-install-desktop>`.
Learn about the benefits of having an up-to-date system for cloud
orchestration on the :ref:`swupd-about` page.
@@ -13,9 +13,9 @@ on a bare-metal |CL| system.
Prerequisites
*************
This tutorial assumes you have installed |CL| on your host system. For detailed
instructions on installing |CL| on a bare metal system, follow the
:ref:`bare metal installation tutorial<bare-metal-install-server>`.
This tutorial assumes you have installed |CL| on your host system. For
detailed instructions on installing |CL| on a bare metal system, follow the
:ref:`bare metal installation tutorial<bare-metal-install-desktop>`.
Before you install any new packages, update |CL| with the following command:
+1 -1
View File
@@ -11,7 +11,7 @@ Prerequisites
*************
This tutorial assumes you have installed |CL| on your host system. For
detailed instructions, follow the steps in :ref:`bare-metal-install-server`.
detailed instructions, follow the steps in :ref:`bare-metal-install-desktop`.
Before you install any new packages, update |CL| with the following command:
+1 -1
View File
@@ -20,7 +20,7 @@ Prerequisites
This tutorial assumes you have installed |CL| on your host system.
For detailed instructions on installing |CL| on a bare metal system, visit
the :ref:`bare metal installation tutorial<bare-metal-install-server>`.
the :ref:`bare metal installation guide <bare-metal-install-desktop>`.
Before you install any new packages, update |CL| with the following command:
@@ -10,8 +10,8 @@ tutorial installs MariaDB\*, which is a drop-in replacement for MySQL\*.
In order to create a web server using |CL| as the host OS, your host system
must be running |CL|. This tutorial assumes you have installed |CL| on your
host system. For detailed instructions on installing |CL| on a bare metal system,
visit the :ref:`bare metal installation tutorial<bare-metal-install-server>`.
host system. For detailed instructions on installing |CL| on a bare metal
system, visit :ref:`bare-metal-install-desktop`.
This tutorial covers:
@@ -12,8 +12,8 @@ can add the WordPress components needed to host a WordPress website on your syst
Before you begin
****************
This tutorial assumes you have successfully completed
:ref:`bare-metal-install-server` and that you have :ref:`web-server-install`.
This tutorial assumes that you have successfully completed
:ref:`bare-metal-install-desktop` and you have :ref:`web-server-install`.
Create a WordPress server
*************************