Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme

This commit is contained in:
Kevin Putnam
2019-06-06 12:09:04 -07:00
104 changed files with 506 additions and 1475 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

@@ -0,0 +1,201 @@
.. _gce:
Launch |CL-ATTR| Compute Engine on Google\* Cloud Platform
##########################################################
This tutorial walks you through the steps to create a virtual machine
instance of |CL-ATTR| on `Google Cloud Platform`_ (GCP).
#. Sign in your Google account on the
`Google Cloud Console <https://console.cloud.google.com/>`_:
.. figure:: figures/gce/00-sign-in.png
:scale: 50 %
:alt: Sign in Google services
#. Google Cloud Platform uses **Projects** to manage resources.
Select or create a new project for hosting the |CL| VM.
.. note::
Reference the
`Quickstart Using a Linux VM <https://cloud.google.com/compute/docs/quickstart-linux>`_
guide to get familiar with the process of creating VM instances on GCP.
#. Navigate to the latest |CL|
`release folder <https://download.clearlinux.org/releases/current/clear/>`_
to view currently released ``gce`` image, and download the image archive
*clear-<release number>-gce.tar.gz*.
You don't need to uncompress the image archive, the intact file will
be uploaded to the Google Cloud Storage later.
#. Create a *Storage Bucket* for hosting the |CL| image source archive
downloaded in the previous step:
* Click the *Navigation menu* icon on the upper left screen menu.
* Select the *Storage* item from the side bar on the left. You will
be sent to the Storage Browser tool or the Cloud Storage overview page.
.. figure:: figures/gce/01-cloud-storage.png
:scale: 50 %
:alt: Browse Google Cloud Storage
.. note::
You may need to create a billing account and link to this project
before you create a bucket.
.. figure:: figures/gce/02-storage-browser.png
:scale: 50 %
:alt: Cloud Storage Broswer tool
* Click the ``CREATE BUCKET`` button to enter the bucket creation tool.
The bucket name must be unique as buckets in the Cloud Storage share
a single global namespace.
You can leave the rest of options as defaults, and select the
``Create`` button at the bottom to create a *Bucket*.
.. figure:: figures/gce/03-create-bucket.png
:scale: 50 %
:alt: Set an unique bucket name
#. Once the bucket is created, press the ``Upload files`` button
on the Bucket details page to upload the |CL| GCE image archive
to the named bucket:
.. figure:: figures/gce/04-bucket-created.png
:scale: 50 %
:alt: Cloud Storage bucket is available for storing objects
.. figure:: figures/gce/10-image-upload.png
:scale: 50 %
:alt: Uploading the image source archive file
.. figure:: figures/gce/11-bucket-uploaded.png
:scale: 50 %
:alt: Image archive imported complete
#. Browse the Compute Engine Image library page:
* Click the *Navigation menu* icon on the upper left screen menu.
* Hover mouse over the *Compute Engine* menu and select *Images*.
.. figure:: figures/gce/20-gce-image.png
:scale: 50 %
:alt: Go to Google Compute Engine Image library
#. On the Compute Engine Image library page, click the ``[+] CREATE IMAGE``
menu item to create a custom image:
.. figure:: figures/gce/20-image-library.png
:scale: 50 %
:alt: Create a Google Compute Engine image
#. In the VM image creation page, change the image source type to
*Cloud Storage file*.
#. Under :guilabel:`Cloud Storage file`, select :guilabel:`Browse`.
#. Locate the *clear-<release number>-gce.tar.gz*,
and click :guilabel:`Select`.
.. figure:: figures/gce/21-create-image.png
:scale: 50 %
:alt: Create the image using the imported image archive object
Accept all default options, and click the ``Create`` button
at the bottom to import the Clear Linux GCE image to the image library.
.. figure:: figures/gce/22-image-list.png
:scale: 50 %
:alt: Clear Linux Compute Engine image is created
#. After the |CL| image is imported, you can launch a VM instance running
|CL|:
* Click the *Navigation menu* icon on the upper left screen menu.
* Hover mouse over the *Compute Engine* menu group and select
the *VM instances* item.
.. figure:: figures/gce/30-vm-instances.png
:scale: 50 %
:alt: Go to VM instances catalog
#. If no VM instance was created in this project, you will be prompted to
create one.
#. Alternatively, click the ``CREATE INSTANCE`` button on the VM
instances page to create a VM instance.
.. figure:: figures/gce/30-vm-none.png
:scale: 50 %
:alt: Prompt for VM creation
.. figure:: figures/gce/30-vm-catalog.png
:scale: 50 %
:alt: List of VM instances
* In :guilabel:`Region`, decide on a region based on the
`Best practices for Compute Engine regions selection`_ .
* Under *Boot disk*, click the ``Change``.
.. figure:: figures/gce/30-create-vm.png
:scale: 50 %
:alt: Use custom image while creating Clear Linux VM instance
* Select the *Custom images* tab for using Clear Linux OS GCE image.
.. figure:: figures/gce/31-select-boot-disk.png
:scale: 50 %
:alt: Select Clear Linux boot disk to create a VM instance
* Scroll down to the bottom of the VM instance creation page,
expand the *Management, security, disks, networking, sole tenancy* group.
.. figure:: figures/gce/40-clear-vm-security.png
:scale: 50 %
:alt: Clear Linux requires setting up SSH keys
.. note::
|CL| does not allow SSH login with a root account by default.
As a result, you need to configure the VM instance with your
SSH public key, so that you are able to remote access to it.
Refer also to :ref:`security` for more details.
* Click the *Security* tab, copy and paste your SSH public key:
.. figure:: figures/gce/40-ssh-key.png
:scale: 50 %
:alt: Set SSH key for remote login
.. warning::
The username is assigned from characters preceding ``@`` in the
email address, included in the SSH key. The dot symbol "." is not
allowed, as it is an invalid character while creating user accounts
in |CL|.
* Click the ``Create`` button to create the |CL| VM.
#. The Clear Linux VM instance is created and offered a public IP address:
.. figure:: figures/gce/41-vm-created.png
:scale: 50 %
:alt: Clear Linux VM instance is created and started
#. You can now SSH login to the VM by using the IP address obtained in the
previous step, and the username associated with the SSH public key:
.. figure:: figures/gce/42-ssh-vm.png
:scale: 50 %
:alt: SSH log in to the Clear Linux VM
.. _Google Cloud Platform: https://cloud.google.com/
.. _Best practices for Compute Engine regions selection: https://cloud.google.com/solutions/best-practices-compute-engine-region-selection
@@ -3,11 +3,10 @@
Install |CL-ATTR| in a virtual machine
######################################
There are some considerations to make when installing |CL-ATTR| in a VM.
First, you need to decide which kernel to use. This document
will walk you through the available kernel options to help this decision. At
the end of this document, you will be able to select the set of installation
steps most suitable to you and install |CL| under a VM.
When installing |CL-ATTR| in a VM, consider which kernel to use. This
document walks you through the available kernel options to help this
decision. At the end of this document, select the type of installation most
suitable to your use case.
Compatible kernels
******************
@@ -28,13 +27,12 @@ appropriate set of step-by-step instructions to proceed.
.. toctree::
:maxdepth: 1
gce
kvm
virtualbox
virtualbox-cl-installer
vmware-esxi-install-cl
vmware-esxi-preconfigured-cl-image
vmw-player
vmw-player-preconf
hyper-v
virtualbox-cl-installer
../../guides/maintenance/increase-virtual-disk-size.rst
@@ -1,258 +1,394 @@
.. _virtualbox-cl-installer:
Install |CL-ATTR| as a VirtualBox\* Virtual Machine
###################################################
VirtualBox\* is a type 2 hypervisor from Oracle. This document explains how
to create a virtual machine on the `VirtualBox hypervisor`_ with |CL-ATTR|
as the guest operating system.
These instructions make use of the |CL| installer to create a brand new |CL|
installation. A preinstalled disk image is also available to get started
with |CL| faster. See: :ref:`virtualbox`
Install a |CL-ATTR| VM in VirtualBox\*
######################################
Oracle\* VirtualBox\* is a type 2 hypervisor. This document explains how to
create a virtual machine on the `VirtualBox hypervisor`_ with |CL-ATTR| as
the guest operating system. These instructions support use of the |CL|
live-server installer to create |CL| virtual machine (VM).
.. contents:: :local:
:depth: 2
:depth: 1
Prerequisites
*************
.. include:: virtualbox.rst
:start-after: vbox-prereqs-begin:
:end-before: vbox-prereqs-end:
Before continuing, assure you have:
#. Enabled virtualization, such as Intel®
`Virtualization Technology`_ (Intel® VT), on the host system from
EFI/BIOS.
#. Downloaded and installed |VB| **version 6.0 or greater** from
the `official VirtualBox website`_ per the `appropriate instructions`_
for your platform.
Download and extract the |CL| installer ISO image
*************************************************
Download and extract the |CL| installer ISO
*******************************************
The appropriate |CL| installer image needs to be downloaded and extracted.
#. Download the :file:`clear-<VERSION>-live-server.iso.xz` of
|CL| on the `downloads page`_.
.. note::
The :file:`installer.iso` is for limited use on special cases where ISO
image format is required, such as |VB|. The preferred installer for |CL|
for UEFI systems is the :file:`-installer.img`.
#. Validate the integrity of the downloaded image by checking the file hash
and signatures. Refer :ref:`validate-signatures` for detailed steps.
#. Download the **installer ISO** image (:file:`clear-<VERSION>-installer.iso.xz`) of
|CL|. On the `downloads page`_, this is listed as
**Clear Linux OS for Virtual Provisioning**.
You can also use this command to download from a terminal:
#. Decompress the downloaded image.
.. code-block:: bash
curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep installer.iso)
#. Validate the integrity of the downloaded image by checking the file hash
and signatures. Refer to the document on :ref:`validate-signatures` for
detailed steps.
#. Decompress the downloaded image. Uncompressed image size is ~ **5GB**.
- On Windows you can use `7zip`_ to extract the file by right-clicking the
- On Windows you can use `7zip`_ to extract the file by right-clicking the
file to *Extract Here* (in the same directory)
.. image:: ./figures/vbox/vbox-extract-cl-ISO.png
:alt: 7zip extract here command
.. figure:: figures/vbox/virtualbox-cl-installer-01.png
:scale: 100%
:alt: 7zip extract here command
Figure 1: 7zip extract here command
- On Linux :
.. code-block:: bash
xz -d clear-<VERSION>-installer.iso.xz
#. The originally downloaded compressed archive file
(:file:`clear-<VERSION>-installer.iso.xz`) can now be deleted.
xz -d clear-<VERSION>-live-server.iso.xz
#. Delete the originally downloaded compressed file.
Create a new |VB| virtual machine
*********************************
A new :abbr:`VM (Virtual Machine)` needs to be created in |VBM| for |CL| to be installed onto.
General instructions for creating a virtual machine and details about using
different settings are available on the
A new :abbr:`VM (Virtual Machine)` needs to be created in |VBM| where |CL|
will be installed. General instructions for creating a virtual machine and
details about using different settings are available on the
`VirtualBox manual section on Creating a VM`_.
#. Launch the |VBM| from your host system.
#. Click the *New* button to create a new VM.
#. Click the *New* button to create a new VM.
#. Choose :guilabel:`Expert mode`.
.. image:: ./figures/vbox/vbox-new-vm.png
:alt: Create a new VM in VirtualBox
#. In :guilabel:`Create Virtual Machine`, enter the following settings:
- **Name**: Choose name (e.g. ClearLinuxOS-VM).
- **Type**: Linux
- **Version**: **Linux 2.6 / 3.x / 4.x (64-bit)**
- **Hard disk**: `Create a virtual hard disk now`
- **Memory size default**: 2048 MB (Adjust appropriately.)
#. A *Create Virtual Machine* window will appear.
Select the following settings:
- Type: **Linux**
- Version: **Linux 2.6 / 3.x / 4.x (64-bit)**
- Memory size: **1024 MB** (this can be adjusted appropriately)
- Hard disk: **Create a virtual hard disk now**
.. note::
Later, if you want to change the amount of RAM allocated, power down your VM. Return to :file:`Settings > System` and change
:guilabel:`Base Memory` to the desired size.
.. image:: ./figures/vbox/vbox-create-vm-new-disk.png
:alt: Create a new VM in VirtualBox with a new disk
.. figure:: figures/vbox/virtualbox-cl-installer-02.png
:scale: 100%
:alt: Create Virtual Machine
Figure 2: Create Virtual Machine
#. Click the *Create* button.
#. Select :guilabel:`Create`.
#. A *Create Virtual Hard Disk* window will appear.
Select the following settings:
#. In :guilabel:`Create Virtual Hard Disk`, select:
- File size: **8.00 GB** (this can be adjusted appropriately)
- Hard disk file type: **VDI (Virtual Box Disk Image)**
- **File location**
- **File size**: **32.00 GB**. Adjust size to your needs.
- **Hard disk file type**: `VDI (VirtualBox Disk Image)`
- **Storage on physical hard disk**:`Dynamically allocated`
- Storage on physical hard disk: **Dynamically allocated**
.. figure:: figures/vbox/virtualbox-cl-installer-03.png
:scale: 100%
:alt: Create Virtual Hard Disk
.. image:: ./figures/vbox/vbox-create-disk.png
:alt: Create a new virtual hard disk in VirtualBox
Figure 3: Create Virtual Hard Disk
#. Click the *Create* button.
#. Click *Create*.
#. A new virtual machine will be created and appear in the |VBM|. Click
*Settings* to configure the |CL| VM.
A new virtual machine will be created and appear in the |VBM|.
.. image:: ./figures/vbox/vbox-vm-created.png
:alt: A VM selected in VirtualBox Manager
#. Click *Settings* to configure the |CL| VM.
#. A *VM - Settings* window will appear. Navigate to the *System* pane from
the left-hand and select the following setting:
#. In the left-hand menu, navigate to the :guilabel:`System` menu.
#. In the :guilabel:`Motherboard` tab, select the `Chipset` pulldown menu,
and then select :guilabel:`ICH9`. See Figure 4.
.. note::
You can select which chipset will be presented to the virtual machine.
Consult the `VM VirtualBox User Manual`_ for more details.
#. In :guilabel:`Enabled Features`, check these boxes:
- **Enable I/O APIC**
- **Enable EFI (special OSes only)**
.. image:: ./figures/vbox/vbox-vm-settings-EFI.png
:alt: Enable EFI on a VirtualBox VM settings
.. figure:: figures/vbox/virtualbox-cl-installer-04.png
:scale: 100%
:alt: Settings > System
.. note::
By default, only 1 virtual CPU is allocated to the new VM. Consider
increasing the number of virtual processors allocated to the virtual
machine under Settings --> System --> Processor for increased
performance.
Figure 4: Settings > System
.. note::
By default, only 1 virtual CPU is allocated to the new VM. Consider
increasing the number of virtual processors allocated to the virtual
machine under Settings > System > Processor for increased
performance.
#. Select :guilabel:`OK`.
Install |CL| on the |VB| VM
***************************
|CL| is ready to be installed.
Mount the installation ISO
==========================
At this point, the newly created VM has a blank virtual hard disk with no
operating system.The |CL| installer ISO needs to be mounted as a virtual
CD-ROM on the VM before powering the VM on.
#. From the *VM - Settings* window, navigate to the *Storage* pane from the
left-hand side.
The |CL| installer ISO needs to be mounted as a virtual CD-ROM on the VM
before powering the VM on.
#. From the middle *Storage Devices* column, click the blue CD disk labeled
*Empty* under the *Controller: IDE* from.
#. From the *ClearLinux-OS* :guilabel:`Settings` at left, select
:guilabel:`Storage`.
#. From the right-hand *Attributes* column, click the blue CD disk next to
the *Optical Drive* drop down menu and click *Choose Virtual Optical
#. From :guilabel:`Storage Devices`, middle column, click the blue
disk labeled *Empty*.
#. From the :guilabel:`Attributes` menu, click the blue CD disk next to
the *Optical Drive* drop down menu and click *Choose Virtual Optical
Disk File...*
.. image:: ./figures/vbox/vbox-vm-settings-mount-ISO.png
:alt: Mounting an ISO in VirtualBox VM Settings
.. figure:: figures/vbox/virtualbox-cl-installer-05.png
:scale: 100%
:alt: Choose Virtual Optical Disk Drive
#. A *choose a virtual optical disk file* browser window will appear.
Navigate to the extracted ISO file, select it, and click *Open*.
Figure 5: Choose Virtual Optical Disk Drive
.. image:: ./figures/vbox/vbox-vm-settings-browse-ISO.png
:alt: Mounting an ISO in VirtualBox VM Settings
#. Where there appears :guilabel:`Please choose a virtual optical disk file`,
select the ISO file and click *Open*.
#. Click *OK* to exit the *VM Settings* menu and return to the main
|VBM|.
.. figure:: figures/vbox/virtualbox-cl-installer-06.png
:scale: 100%
:alt: Mounting an ISO
Figure 6: Mounting an ISO
#. Select :guilabel:`OK` to exit and return to the main |VBM|.
Install |CL| using the installer
================================
Install |CL| with live-server installer
=======================================
#. Start the VM from the |VBM| by selecting the |CL| VM and
clicking *Start*
#. In the |VBM|, select virtual machine you created and click *Start*.
.. image:: ./figures/vbox/vbox-start-vm.png
:alt: Starting a VirtualBox VM
.. figure:: figures/vbox/virtualbox-cl-installer-07.png
:scale: 100%
:alt: Start the installer
#. 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.
Figure 7: Start the installer
.. note::
Do not choose a different kernel from the installer. **kernel-lts**, the
Long Term Support (LTS) kernel is required for |VB| driver compatibility.
.. note::
To release the mouse cursor from the VM console window, press the right
:kbd:`Ctrl` key on the keyboard.
#. After |CL| installation is complete, the VM will reboot and return to the
|CL| installer.
#. When :guilabel:`Clear Linux Installer` in boot manager appears,
select :kbd:`Enter`. Do not install the bundle `desktop-autostart`.
.. note::
To release the mouse cursor from the VM console window, press the right Ctrl key on the keyboard.
#. Follow the steps in :ref:`bare-metal-install-server` to
install |CL| onto the VM virtual disk. Note:
#. In :guilabel:`Configure Installation Media`, navigate top
VBOX HARDDISK, and then select :guilabel:`Confirm`.
Unmount the installation ISO
============================
#. In :guilabel:`Advanced options` > :guilabel:`Manage User`, create an
administrative user.
#. Do not install the bundle `desktop-autostart`.
#. When |CL| installation is complete, select :guilabel:`Exit`.
#. At the prompt, enter:
.. code-block:: bash
shutdown now
Unmount the ISO
===============
The |CL| installer ISO needs to be unmounted to allow the VM to boot from the
virtual hard disk, which |CL| has been installed to.
virtual hard disk.
#. Power off the |CL| VM.
.. image:: ./figures/vbox/vbox-shutdown-vm.png
:alt: Powering off a VirtualBox VM
#. Return to the |VBM|.
#. Click *Settings* to configure the |CL| VM.
.. image:: ./figures/vbox/vbox-vm-created.png
:alt: A VM selected in VirtualBox Manager
#. From the *VM - Settings* window, navigate to the *Storage* pane from the
#. From the *VM - Settings* window, navigate to the *Storage* pane from the
left-hand side.
#. From the middle *Storage Devices* column, click the blue CD disk labeled
*clear-<VERSION>-installer.iso* under the *Controller: IDE* from.
#. From the middle *Storage Devices* column, click the blue CD disk labeled
*clear-<VERSION>-live-server.iso* under the *Controller: IDE* from.
#. From the right-hand *Attributes* column, click the blue CD disk next to
the *Optical Drive* drop down menu and click *Remove Disk from Virtual
Drive*
#. From the *Attributes* column at right, in *Optical Drive*, select the
blue CD icon beside and click *Remove Disk from Virtual Drive*.
.. image:: ./figures/vbox/vbox-vm-settings-unmount-ISO.png
:alt: Unmounting an ISO in VirtualBox VM Settings
.. figure:: figures/vbox/virtualbox-cl-installer-08.png
:scale: 100%
:alt: Remove Disk from Virtual Drive
#. Click *OK* to exit the *VM Settings* menu and return to the main
Figure 8: Remove Disk from Virtual Drive
#. Click *OK* to exit the *VM Settings* menu and return to the main
|VBM|.
Install |VB| Linux Guest Additions
==================================
|CL| provides Linux Guest Additions drivers for full compatibility using an
install script in the **kernel-lts** (Long Term Support) bundle by |CL|.
#. From the |VBM| select the |CL| VM, and select :guilabel:`Start`.
.. include:: virtualbox.rst
:start-after: vbox-start-vm-and-lga-begin:
:end-before: vbox-start-vm-and-lga-end:
#. In the VM Console, log in as the administrative user previously created.
.. note::
A message may appear: "A kernel update is available: you may wish
to reboot the system."
To update the kernel, enter:
.. code-block:: bash
sudo reboot
.. include:: virtualbox.rst
:start-after: vbox-troubleshooting-begin:
:end-before: vbox-troubleshooting-end
At initial login, enter the administrative user's password and continue.
#. Validate the installed kernel is **kernel-lts** by checking the output
of the :command:`uname -r` command. It should end in **.lts** or **.lts2018**.
.. code-block:: bash
uname -r
<VERSION>.lts
.. |VB| replace:: VirtualBox
.. |VBM| replace:: VirtualBox Manager
If the running kernel is not **lts**: install the LTS kernel manually,
update the bootloader, and check again:
.. code-block:: bash
sudo swupd bundle-add kernel-lts
clr-boot-manager set-kernel $(basename $(realpath /usr/lib/kernel/default-lts))
clr-boot-manager update
reboot
#. Remove any kernel bundles that do not end in *-lts* or *kernel-install*
to simplify and avoid conflicts:
.. code-block:: bash
sudo swupd bundle-list | grep kernel
sudo swupd bundle-remove <NON-LTS-KERNEL>
#. In the VM Console top menu, click *Devices*, and select
*Insert Guest Additions CD image...* to mount the |VB| driver installation to the |CL| VM.
.. figure:: figures/vbox/virtualbox-cl-installer-09.png
:scale: 100%
:alt: Insert Guest Additions CD image
Figure 9: Insert Guest Additions CD image
#. If a dialogue appears, "VBx_GAs_6.0.8... Would you like to run it?",
select :guilabel:`Cancel`.
Instead, we provide a script to patch and install |VB| drivers on |CL|.
#. Open a Terminal and enter the script:
.. code-block:: bash
sudo install-vbox-lga
.. note::
Successful installation shows: "Guest Additions installation complete".
If drivers are already installed, don't re-install them.
#. Shut down the system. Select :guilabel:`Machine>ACPI Shutdown`.
.. figure:: figures/vbox/virtualbox-cl-installer-10.png
:scale: 100%
:alt: Powering off a VirtualBox VM
Figure 10: Powering off a VirtualBox VM
#. Select :guilabel:`Settings`, :guilabel:`Display`.
#. In :guilabel:`Graphics Controller`, select :guilabel:`VBoxSVGA`
to adjust screen size dynamically.
.. figure:: figures/vbox/virtualbox-cl-installer-11.png
:scale: 100%
:alt: Remove Disk from Virtual Drive
Figure 11: VirtualBox hardware acceleration error
#. In the |VBM|, select :guilabel:`Start`.
#. In the VM console, login and verify the |VB| drivers are loaded:
.. code-block:: bash
lsmod | grep ^vbox
You should see drivers loaded with names beginning with **vbox**:
(e.g., vboxvideo, vboxguest).
#. Add `desktop-autostart` for a full desktop experience.
.. code-block:: bash
sudo swupd bundle-add desktop-autostart
#. Reboot the VM and log in with the administrative user.
.. code-block:: bash
sudo reboot
The |CL| VM running on |VB| is ready to develop and explore.
Troubleshooting
***************
#. **Problem:** On a Microsoft\* Windows\* OS, |VB| encounters an error when
trying to start a VM indicating *VT-X/AMD-v hardware acceleration is not
available on your system.*
.. figure:: figures/vbox/virtualbox-cl-installer-12.png
:scale: 100%
:alt: Remove Disk from Virtual Drive
Figure 12: VirtualBox hardware acceleration error
**Solution:** First, double check the `Prerequisites`_ section to make
sure *Hardware accelerated virtualization* extensions have been enabled
in the host system's EFI/BIOS.
*Hardware accelerated virtualization*, may get disabled for |VB| when
another hypervisor, such as *Hyper-V* is enabled.
To disable *Hyper-V* execute this command in an
**Administrator: Command Prompt or Powershell**, and reboot the system:
.. code-block:: bash
bcdedit /set {current} hypervisorlaunchtype off
To enable Hyper-V again, execute this command in an
**Administrator: Command Prompt or Powershell**, and reboot the system:
.. code-block:: bash
bcdedit /set {current} hypervisorlaunchtype Auto
.. _appropriate instructions: https://www.virtualbox.org/manual/ch02.html
@@ -264,12 +400,8 @@ virtual hard disk, which |CL| has been installed to.
.. _`VirtualBox manual section on Creating a VM`: https://www.virtualbox.org/manual/UserManual.html#gui-createvm
.. _`VirtualBox manual section on Running a VM`: https://www.virtualbox.org/manual/ch01.html#intro-starting-vm-first-time
.. _`Virtual Media Manager`: https://www.virtualbox.org/manual/ch05.html#vdis
.. _7zip: http://www.7-zip.org/
.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
.. _`VirtualBox manual section on VBoxManage`: https://www.virtualbox.org/manual/ch08.html#vboxmanage-convertfromraw
.. _VM VirtualBox User Manual: https://docs.oracle.com/cd/E97728_01/E97727/html/settings-system.html
@@ -1,368 +0,0 @@
.. _virtualbox:
Run pre-configured |CL-ATTR| as a VirtualBox\* Virtual Machine
##############################################################
VirtualBox\* is a type 2 hypervisor from Oracle. This document explains how
to create a virtual machine on the `VirtualBox hypervisor`_ with |CL-ATTR|
as the guest operating system.
These instructions make use of a preinstalled |CL| disk image to setup a |CL|
virtual machine without manual installation. |CL| can also be installed from
scratch on a |VB| using the |CL| installed.
See: :ref:`virtualbox-cl-installer`
.. contents:: :local:
:depth: 2
.. _vbox-prereqs-begin:
Prerequisites
*************
Before continuing make sure that you have:
#. Enabled virtualization, such as Intel®
`Virtualization Technology`_ (Intel® VT), on the host system from
EFI/BIOS.
#. Downloaded and installed |VB| **version 6.0 or greater** from
the `official VirtualBox website`_ per the `appropriate instructions`_
for your platform.
.. _vbox-prereqs-end:
Download and extract |CL|
*************************
The |CL| live image needs to be downloaded and extracted. The live image will
be used to created a |VB| virtual disk image that can be used with a
:abbr:`VM (Virtual Machine)`.
#. Download the **live image** (:file:`clear-<VERSION-live.img.xz`) of
|CL|. On the `downloads page`_, this is listed as
**Clear Linux OS live boot image**.
You can also use this command to download from a terminal:
.. code-block:: bash
curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep live.img)
#. Validate the integrity of the downloaded image by checking the file hash
and signatures. Refer to the document on :ref:`validate-signatures` for
detailed steps.
#. Decompress the downloaded image. Uncompressed image size is ~ **5GB**.
- On Windows you can use `7zip`_ to extract the file by right-clicking the
file and selecting *Extract Here* (in the same directory)
.. image:: ./figures/vbox/vbox-extract-cl-IMG.png
:alt: 7zip extract here command
- On Linux :
.. code-block:: bash
xz -d clear-<VERSION>-live.img.xz
#. There originally downloaded compressed archive file
(:file:`clear-<VERSION>-live.img.xz`) can now be deleted.
Convert |CL| live image to a |VB| Disk Image
********************************************
The |CL| live image is in a RAW disk image. The live image needs to be
converted to a :abbr:`VDI (VirtualBox Disk Image)` format which |VB|
can utilize.
#. Launch a terminal and navigate to the directory containing the
extracted live image.
#. Convert RAW live image to a :abbr:`VDI (VirtualBox Disk Image)`
format using the command-line VirtualBox Disk Utility.
.. code-block:: bash
VBoxManage convertfromraw clear-<VERSION>-live.img clear-VM.vdi --format VDI
.. note::
The :command:`PATH` environment variable may need to be updated to make the
:command:`VBoxManage` command easily accessible from the terminal.
For example, using Windows PowerShell:
.. code-block:: bash
$env:PATH += ";C:\Program Files\Oracle\VirtualBox"
.. image:: ./figures/vbox/vbox-convert-raw-to-VDI.png
:alt: Convert image in Windows command prompt
For more information on the :command:`VBoxManage` command,
see the `VirtualBox manual section on VBoxManage`_.
#. The originally extracted live image file
(:file:`clear-<VERSION>-live.img`) can now be deleted.
#. Move the converted :file:`clear-VM.vdi` disk image file to a permanent
location. The VDI will be attached to the |VB| VM and should not be
deleted.
Create a new |VB| virtual machine
*********************************
A new VM needs to be created in |VBM| to attach the VDI with |CL| installed.
General instructions for creating a virtual machine and details about using
different settings are available on the
`VirtualBox manual section on Creating a VM`_.
#. Launch the |VBM| from your host system.
#. Click the *New* button to create a new VM.
.. image:: ./figures/vbox/vbox-new-vm.png
:alt: Create a new VM in VirtualBox
#. A *Create Virtual Machine* window will appear.
Select the following settings:
- Type: **Linux**
- Version: **Linux 2.6 / 3.x / 4.x (64-bit)**
- Memory size: **1024 MB** (this can be adjusted appropriately)
- Hard disk: **Use an existing virtual hard disk file**
Click the folder icon next to the drop down menu:
.. image:: ./figures/vbox/vbox-create-vm-existing-disk.png
:alt: Create a new VM in VirtualBox with an existing disk
#. A new window will appear for choosing an existing disk. Click the *Add*
button, browse to the saved VDI file, and click *Choose*.
.. image:: ./figures/vbox/vbox-create-vm-choose-disk.png
:alt: Create a new VM in VirtualBox with an existing disk
#. Click the *Create* button.
#. A new virtual machine will be created and appear in the |VBM|. Click
*Settings* to configure the |CL| VM.
.. image:: ./figures/vbox/vbox-vm-created.png
:alt: A VM selected in VirtualBox Manager
#. A *VM - Settings* window will appear. Navigate to the *System* pane from
the left-hand and select the following setting:
- **Enable I/O APIC**
- **Enable EFI (special OSes only)**
.. image:: ./figures/vbox/vbox-vm-settings-EFI.png
:alt: Enable EFI on a VirtualBox VM settings
.. note::
By default, only 1 virtual CPU is allocated to the new VM. Consider
increasing the number of virtual processors allocated to the virtual
machine under Settings --> System --> Processor for increased
performance.
.. _vbox-start-vm-and-lga-begin:
Start the |CL| VM
*****************
The |CL| VM can now be powered on and setup.
General instructions for using a |VB| virtual machine are available on the
`VirtualBox manual section on Running a VM`_.
#. Start the VM from the |VBM| by selecting the |CL| VM and clicking *Start*
.. image:: ./figures/vbox/vbox-start-vm.png
:alt: Starting a VirtualBox VM
#. |CL| will boot and prompt for login.
- Enter **root** for the username.
#. You will be immediately prompted to set a new password for the **root**
user. Reference :ref:`security` for more information about |CL| security
concepts.
.. image:: ./figures/vbox/vbox-cl-first-login.png
:alt: Initial login to Clear Linux OS on a VirtualBox VM
Install |VB| Linux Guest Additions
==================================
The |VB| Linux Guest Additions provide drivers for full compatibility and
functionality.
|CL| provides |VB| guest drivers and an install script in the **kernel-lts**
(Long Term Support) bundle by |CL|.
#. Validate the installed kernel is **kernel-lts** by checking the output
of the :command:`uname -r` command. It should end in **.lts**.
.. code-block:: bash
uname -r
4.<VERSION>.lts
If the running kernel is not **lts**: install the LTS kernel manually,
update the bootloader, and check again:
.. code-block:: bash
swupd bundle-add kernel-lts
clr-boot-manager set-kernel $(basename $(realpath /usr/lib/kernel/default-lts))
clr-boot-manager update
reboot
#. Remove any kernel bundles that are not *kernel-lts* or *kernel-install*
to simplify and avoid conflicts:
.. code-block:: bash
swupd bundle-list | grep kernel
swupd bundle-remove <NON-LTS-KERNEL>
.. image:: ./figures/vbox/vbox-cl-remove-non-lts-kernels.png
:alt: Initial login to Clear Linux OS on a VirtualBox VM
#. From the VM Console window, click *Devices* on the top menu bar, and
select *Insert Guest Additions CD image...* to mount the |VB| driver
installation to the |CL| VM.
.. image:: ./figures/vbox/vbox-vm-insert-ga-cd.png
:alt: VirtualBox CD
.. note::
To release the mouse cursor from the VM console window, press the right Ctrl key on the keyboard.
#. |CL| provides a script called :command:`install-vbox-lga` to help patch
and install |VB| drivers for |CL|. Inside |CL| VM run this command:
.. code-block:: bash
install-vbox-lga
#. After the script completes successfully, reboot the |CL| VM.
.. code-block:: bash
reboot
#. After the VM reboot, login and verify the |VB| drivers are loaded:
.. code-block:: bash
lsmod | grep ^vbox
You should see drivers loaded with names beginning with **vbox**: (vboxguest, vboxsf, vboxvideo).
The |CL| VM running on |VB| is ready to be used.
.. _vbox-start-vm-and-lga-end:
.. _vbox-troubleshooting-begin:
Troubleshooting
***************
#. **Problem:** Out of disk space inside of |CL| and not be able to install
additional bundles.
**Solution:** The |CL| images are small to minimize download time and
initial disk space .
Power off the VM and resize the virtual disk for the |CL| VM using the |VB|
`Virtual Media Manager`_ found under the File menu. Afterwards, power the
|CL| VM on and follow the instructions here to have |CL| detect the resized
disk. :ref:`increase-virtual-disk-size`
#. **Problem:** On a Microsoft Windows OS, |VB| encounters an error when
trying to start a VM indicating *VT-X/AMD-v hardware acceleration is not
available on your system.*
.. image:: ./figures/vbox/vbox-no-vtx.png
:alt: VirtualBox hardware acceleration error
**Solution:** First, double check the `Prerequisites`_ section to make sure
*Hardware accelerated virtualization* extensions have been enabled in the
host system's EFI/BIOS.
*Hardware accelerated virtualization*, may get disabled for |VB| when another
hypervisor, such as *Hyper-V* is enabled.
To disable *Hyper-V* execute this command in an
**Administrator: Command Prompt or Powershell**, and reboot the system:
.. code-block:: bash
bcdedit /set {current} hypervisorlaunchtype off
To enable Hyper-V again, execute this command in an
**Administrator: Command Prompt or Powershell**, and reboot the system:
.. code-block:: bash
bcdedit /set {current} hypervisorlaunchtype Auto
.. _vbox-troubleshooting-end:
.. |VB| replace:: VirtualBox
.. |VBM| replace:: VirtualBox Manager
.. _appropriate instructions: https://www.virtualbox.org/manual/ch02.html
.. _official VirtualBox website: https://www.virtualbox.org/wiki/Downloads
.. _VirtualBox hypervisor: https://www.virtualbox.org/
.. _downloads page: https://clearlinux.org/downloads
.. _`VirtualBox manual section on Creating a VM`: https://www.virtualbox.org/manual/UserManual.html#gui-createvm
.. _`VirtualBox manual section on Running a VM`: https://www.virtualbox.org/manual/ch01.html#intro-starting-vm-first-time
.. _`Virtual Media Manager`: https://www.virtualbox.org/manual/ch05.html#vdis
.. _7zip: http://www.7-zip.org/
.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
.. _`VirtualBox manual section on VBoxManage`: https://www.virtualbox.org/manual/ch08.html#vboxmanage-convertfromraw
@@ -34,8 +34,9 @@ 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<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.
:ref:`instructions on using Virtualbox<virtualbox-cl-installer>` for more
information. The optimization patches are found in our `Linux-LTS`_ GitHub
repo.
Kernel KVM
==========
@@ -137,6 +137,9 @@ TensorFlow.
You can replace the model with one of your choice supported by the
TensorFlow benchmarks.
If you are using an FP32 based model, it can be converted to an int8 model using `Intel® quantization tools`_
PyTorch single and multi-node benchmarks
****************************************
@@ -444,3 +447,5 @@ Related topics
.. _Jupyter Notebook: https://jupyter.org/
.. _Release notes on Github\*: https://github.com/clearlinux/dockerfiles/blob/master/stacks/dlrs/releasenote.md
.. _Intel® quantization tools: https://github.com/IntelAI/tools/blob/master/tensorflow_quantization/README.md#quantization-tools
Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 204 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 250 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 152 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 197 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 117 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 128 KiB

@@ -1,140 +0,0 @@
.. _multi-boot-mint:
Install Linux Mint\* 18.1 *Serena* MATE
#######################################
This guide describes Linux Mint-specific details of the :ref:`multi-boot`
tutorial.
#. Start the Mint installer and follow the prompts.
#. At the :guilabel:`Installation type` screen, choose
:guilabel:`Something else`. See Figure 1.
.. figure:: figures/multi-boot-mint-1.png
Figure 1: Mint: Installation type.
#. Create a new root partition.
#. Under the :guilabel:`Device` column, select :guilabel:`free space`. See
Figure 2.
.. figure:: figures/multi-boot-mint-2.png
Figure 2: Mint: Add partition.
#. Click the :guilabel:`+` button.
#. In the :guilabel:`Size` field, enter a value for the new partition
size. For this example, we used *40000 MB*, as shown in Figure 3.
.. figure:: figures/multi-boot-mint-3.png
Figure 3: Mint: Configure new partition settings.
#. Set :guilabel:`Use as` to :guilabel:`Ext4 journaling file system`.
#. Set the :guilabel:`Mount point` to :guilabel:`/`.
#. Click :guilabel:`OK`.
#. Share the swap partition created by |CL|.
#. Under the :guilabel:`Device` column, select :file:`/dev/sda2`.
#. Click :guilabel:`Change`.
#. Confirm :guilabel:`Use as` is set to :guilabel:`Swap area`. See Figure 4.
.. figure:: figures/multi-boot-mint-4.png
Figure 4: Mint: Set swap partition.
#. Follow the remaining prompts to complete the Mint installation.
#. At this point, you cannot boot |CL| because `Grub`
is the default boot loader. Follow these steps to make the |CL|
Systemd-Boot the default boot loader and add Mint as a boot option.
#. Boot into Mint.
#. Log in.
#. Locate the Mint :file:`grub.cfg` file in the :file:`/boot/grub/`
directory and look for the :guilabel:`menuentry` section. In Figure 5, the
highlighted lines identify the kernel, the :file:`initrd` files, the root
partition UUID, and the additional parameters used. Use this information
to create a new Systemd-Boot entry for Mint.
.. figure:: figures/multi-boot-mint-5.png
Figure 5: Mint: grub.cfg file.
#. Copy the kernel and :file:`initrd` file to the EFI partition.
.. code-block:: bash
sudo cp /boot/vmlinuz-4.4.0-53-generic /boot/efi
sudo cp /boot/initrd.img-4.4.0-53-generic /boot/efi
#. Create a boot entry for Mint. At a minimum, the file must contain
these settings:
+---------+------------------------------------+
| Setting | Description |
+=========+====================================+
| title | Text to show in the boot menu |
+---------+------------------------------------+
| linux | Linux kernel image |
+---------+------------------------------------+
| initrd | initramfs image |
+---------+------------------------------------+
| options | Options to pass to the EFI program |
| | or kernel boot parameters |
+---------+------------------------------------+
See the `systemd boot loader documentation`_ for additional
details.
The *options* parameters must specify the root partition UUID and
any additional parameters that Mint requires.
.. note:: The root partition UUID used below is unique to this example.
.. code-block:: bash
sudoedit /boot/efi/loader/entries/mint.conf
Add the following lines to the :file:`mint.conf` file:
.. code-block:: console
title Mint 18.1 Serena MATE
linux /vmlinuz-4.4.0-53-generic
initrd /initrd.img-4.4.0-53-generic
options root=UUID=af4901e1-6238-470a-8c14-bc0f0f7715ec ro
#. Re-install Systemd-Boot to make it the default boot loader.
.. code-block:: bash
sudo bootctl install --path /boot/efi
.. note::
If an older version of Mint does not have the `bootctl` command,
skip this step and see :ref:`multi-boot-restore-bl` to restore
Systemd-Boot.
#. Reboot.
If you want to install other :abbr:`OSes (operating systems)`, refer to
:ref:`multi-boot` for details.
.. _systemd boot loader documentation:
https://wiki.archlinux.org/index.php/Systemd-boot
@@ -1,58 +0,0 @@
.. _multi-boot-restore-bl:
Restore the |CL-ATTR| boot loader
###################################
This guide is part of the :ref:`multi-boot` tutorial. If you install a new
:abbr:`OS (operating system)` or upgrade an existing OS, the default boot
loader may change from |CL| Systemd-Boot. This guide describes how to restore
Systemd-Boot.
#. 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 1.
.. figure:: figures/multi-boot-restore-bl-1.png
Figure 1: |CL|: Console.
#. Log in as *root*.
.. note::
When you log in for the first time as *root* through the console, you must
set a new password.
#. Find the location of the |CL| EFI partition. In this example, it is
:file:`/dev/sda3`. See Figure 2.
.. code-block:: bash
fdisk -l
.. figure:: figures/multi-boot-restore-bl-2.png
Figure 2: |CL|: fdisk -l command.
#. Mount the EFI partition.
.. code-block:: bash
mount /dev/sda3 /mnt
#. Re-install Systemd-Boot to make it the default boot loader.
.. code-block:: bash
bootctl install --path /mnt
#. Unmount the EFI partition.
.. code-block:: bash
umount /mnt
#. Reboot.
If you want to install other :abbr:`OSes (operating systems)`, refer to
:ref:`multi-boot` for details.
@@ -1,165 +0,0 @@
.. _multi-boot-rhel:
Install Red Hat\* Enterprise Linux 7.4 Beta
###########################################
This guide describes Red Hat-specific details of the :ref:`multi-boot`
tutorial.
#. Start the Red Hat installer and follow the prompts.
#. At the :guilabel:`INSTALLATION SUMMARY` screen, choose
:guilabel:`INSTALLATION DESTINATION`. See Figure 1.
.. figure:: figures/multi-boot-rhel-1.png
Figure 1: Red Hat: Installation summary.
#. In the :guilabel:`Device Selection` section, select a drive on which to
install the OS. See Figure 2.
.. figure:: figures/multi-boot-rhel-2.png
Figure 2: Red Hat: Installation destination.
#. Under the :guilabel:`Other Storage Options` section, choose
:guilabel:`I will configure partitioning`. See Figure 2.
#. Click :guilabel:`Done`.
#. Under the :menuselection:`New Red Hat Enterprise Linux 7.4 Installation
--> New mount points will use the following partitioning scheme` section,
select :menuselection:`Standard Partition` from the drop down list. See
Figure 3.
.. figure:: figures/multi-boot-rhel-3.png
Figure 3: Red Hat: New partition scheme.
#. Create a new root partition.
#. Click the :menuselection:`+` button on the lower left corner.
#. Enter `/` and the new partition size. For this example, we specified 45
GB. See Figure 4.
.. figure:: figures/multi-boot-rhel-4.png
Figure 4: Red Hat: Create new root partition.
#. Click :guilabel:`Add mount point`.
#. Share the swap partition that was created by |CL|. See Figure 5.
#. Expand :guilabel:`Unknown`.
#. Select :guilabel:`swap / sda2`.
#. Select :guilabel:`Reformat`.
#. Click :guilabel:`Update Settings`.
.. figure:: figures/multi-boot-rhel-5.png
Figure 5: Red Hat: Configure swap partition.
#. Share the EFI partition that was created by |CL|. See Figure 6.
#. Expand :guilabel:`Unknown.`
#. Select :guilabel:`EFI System Partition / sda3`.
#. Under :guilabel:`Mount Point`, enter `/boot/efi`.
#. Click :guilabel:`Update Settings`.
.. figure:: figures/multi-boot-rhel-6.png
Figure 6: Red Hat: Configure EFI partition.
#. Click :guilabel:`Done`.
#. Follow the remaining prompts to complete the Red Hat installation.
#. At this point, you cannot boot |CL| because `Grub` is the default boot
loader. Follow these steps to make the |CL| Systemd-Boot the default boot
loader and add Red Hat as a boot option:
#. Boot into Red Hat.
#. Log in.
#. Locate the Red Hat :file:`grub.cfg` file in the
:file:`/boot/efi/EFI/redhat/` directory and look for the primary Red
Hat :guilabel:`menuentry` section. In Figure 7, the highlighted lines
identify the kernel and `initrd` filenames, root partition UUID, and
additional parameters used. Use this information to create a
new Systemd-Boot entry for Red Hat.
.. figure:: figures/multi-boot-rhel-7.png
Figure 7: Red Hat: grub.cfg file.
#. Copy the kernel and :file:`initrd` file to the EFI partition.
.. code-block:: bash
sudo cp /boot/vmlinuz-3.10.0-663.el7.x86_64 /boot/efi
sudo cp /boot/initramfs-3.10.0-663.el7.x86_64.img /boot/efi
#. Create a boot entry for Red Hat. At a minimum, the file must contain
these settings:
+---------+---------------------------------------------------+
| Setting | Description |
+=========+===================================================+
| title | Text to show in the boot menu |
+---------+---------------------------------------------------+
| linux | Linux kernel image |
+---------+---------------------------------------------------+
| initrd | initramfs image |
+---------+---------------------------------------------------+
| options | Options to pass to the EFI program or kernel boot |
| | parameters |
+---------+---------------------------------------------------+
See the `systemd boot loader documentation`_ for additional
details.
The *options* parameters must specify the root partition UUID and any
additional parameters that Red Hat requires.
.. note:: The root partition UUID used below is unique to this example.
.. code-block:: bash
sudoedit /boot/efi/loader/entries/redhat.conf
Add the following lines to the :file:`redhat.conf` file:
.. code-block:: console
title Red Hat Enterprise Linux 7.4 Beta
linux /vmlinuz-3.10.0-663.el7.x86_64
initrd /initramfs-3.10.0-663.el7.x86_64.img
options root=UUID=30655c74-6cc1-4c55-8fcc-ac8bddcea4db ro
crashkernel=auto rhgb LANG=en_US.UTF-8
#. Re-install Systemd-Boot to make it the default boot loader.
.. note::
This version of Red Hat does not support `bootctl install`. Perform
the steps in :ref:`multi-boot-restore-bl` instead.
#. Reboot.
If you want to install other :abbr:`OSes (operating systems)`, refer to
:ref:`multi-boot` for details.
.. _systemd boot loader documentation:
https://wiki.archlinux.org/index.php/Systemd-boot
@@ -1,124 +0,0 @@
.. _multi-boot-sles:
Install SUSE\* Linux Enterprise Server 12 SP2
#############################################
This guide describes SUSE-specific details of the :ref:`multi-boot`
tutorial.
#. Start the SUSE installer and follow the prompts.
#. At the :guilabel:`Suggested Partitioning` screen, choose
:guilabel:`Expert Partitioner`. See Figure 1.
.. figure:: figures/multi-boot-sles-1.png
Figure 1: SUSE: Suggested partitioning.
**Optional:** Under :guilabel:`Available Storage on Linux` section,
right-click the SUSE :file:`/home` partition and delete it. In this example, it is :file:`/dev/sda8`. See Figure 2.
.. figure:: figures/multi-boot-sles-2.png
Figure 2: SUSE: Delete /home partition.
#. Under :guilabel:`Available Storage on Linux` section, right-click the SUSE
root partition and resize it. In this example, :file:`/dev/sda7` is
resized to 45 GB. See Figure 3.
.. figure:: figures/multi-boot-sles-3.png
Figure 3: SUSE: Resize root partition.
#. Click :guilabel:`Accept`.
#. Follow the remaining prompts to complete the SUSE installation.
#. At this point, you cannot boot |CL| because `Grub`
is the default boot loader. Follow these steps to make the |CL|
Systemd-Boot the default boot loader and add SUSE as a boot option:
#. Boot into SUSE.
#. Log in.
#. Locate the SUSE :file:`grub.cfg` file in the :file:`/boot/grub2/` directory
and look for the primary SUSE :guilabel:`menuentry` section. In Figure 4, the
highlighted lines identify the kernel, the :file:`initrd` filenames, the
root partition UUID, and the additional parameters used. Use this information
to create a new Systemd-Boot entry for SUSE.
.. figure:: figures/multi-boot-sles-4.png
Figure 4: SUSE: grub.cfg file.
#. Copy the kernel and the :file:`initrd` file to the EFI partition.
.. code-block:: bash
sudo cp /boot/vmlinuz-4.4.21-69-default /boot/efi
sudo cp /boot/initrd-4.4.21-69-default /boot/efi
#. Create a boot entry for SUSE. At a minimum, the file must contain
these settings:
+---------+---------------------------------------+
| Setting | Description |
+=========+=======================================+
| title | Text to show in the boot menu |
+---------+---------------------------------------+
| linux | Linux kernel image |
+---------+---------------------------------------+
| initrd | initramfs image |
+---------+---------------------------------------+
| options | Options to pass to the EFI program or |
| | kernel boot parameters |
+---------+---------------------------------------+
See the `systemd boot loader documentation`_ for additional
details.
The *options* parameter must specify the root partition UUID and
any additional parameters SUSE requires.
.. note:: The root partition UUID used below is unique to this example.
.. code-block:: bash
sudoedit /boot/efi/loader/entries/suse.conf
Add the following lines to the :file:`suse.conf` file:
.. code-block:: console
title SUSE Linux Enterprise 12 SP2
linux /vmlinuz-4.4.21-69-default
initrd /initrd-4.4.21-69-default
options root=UUID=b9e25e98-a644-4ac3-b955-ae32800ee350 ro
resume=/dev/disk/by-uuid/6a50c032-1c1e-4b4a-b799-ca365bb10dc7
splash=silent showopts crashkernel=109M,high
crashkernel=72M,low
#. Re-install Systemd-Boot to make it the default boot loader.
.. code-block:: bash
sudo bootctl install --path /boot/efi
.. note::
If an older version of SUSE does not have the `bootctl` command,
skip this step and see :ref:`multi-boot-restore-bl` to restore
Systemd-Boot.
#. Reboot.
If you want to install other :abbr:`OSes (operating systems)`, refer to
:ref:`multi-boot` for details.
.. _systemd boot loader documentation:
https://wiki.archlinux.org/index.php/Systemd-boot
@@ -1,142 +0,0 @@
.. _multi-boot-ubuntu:
Install Ubuntu\* 16.04 LTS Desktop
##################################
This guide describes Ubuntu-specific details of the :ref:`multi-boot`
tutorial.
#. Start the Ubuntu installer and follow the prompts.
#. At the :guilabel:`Installation type` screen, choose
:guilabel:`Something else`. See Figure 1.
.. figure:: figures/multi-boot-ubuntu-1.png
Figure 1: Ubuntu: Installation type.
#. Create a new root partition.
#. Under the :guilabel:`Device` column, select :guilabel:`free space`. See
Figure 2.
.. figure:: figures/multi-boot-ubuntu-2.png
Figure 2: Ubuntu: Add partition.
#. Click the :guilabel:`+` button on the lower left corner.
#. Enter the new partition size. For this example, we used *40000 MB*, as
shown in Figure 3.
.. figure:: figures/multi-boot-ubuntu-3.png
Figure 3: Ubuntu: Configure new root partition.
#. Set :guilabel:`Use as` to :guilabel:`Ext4 journaling file system`.
#. Set the :guilabel:`Mount point` to `/`.
#. Click :guilabel:`OK`.
#. Under the :guilabel:`Format?` column, select the new partition to be
formatted, in this example :file:`/dev/sda8`.
#. Share the swap partition that was created by |CL|.
#. Under the :guilabel:`Device` column, select :file:`/dev/sda2`.
#. Click :guilabel:`Change`.
#. Confirm :guilabel:`Use as` is set to :guilabel:`swap area`. See Figure 4.
.. figure:: figures/multi-boot-ubuntu-4.png
Figure 4: Ubuntu: Set swap partition.
#. Follow the remaining prompts to complete the Ubuntu installation.
#. At this point, you cannot boot |CL| because `Grub`
is the default boot loader. Follow these steps to make the |CL|
Systemd-Boot the default boot loader and add Ubuntu as a boot option:
#. Boot into Ubuntu.
#. Log in.
#. Locate the Ubuntu :file:`grub.cfg` file in the :file:`/boot/grub/`
directory and look for the :guilabel:`menuentry` section. In Figure 5, the
highlighted lines identify the kernel, the :file:`initrd` files, the
root partition UUID, and the additional parameters used. Use this
information to create a new Systemd-Boot entry for Ubuntu.
.. figure:: figures/multi-boot-ubuntu-5.png
Figure 5: Ubuntu: grub.cfg file.
#. Copy the kernel and the :file:`initrd` file to the EFI partition.
.. code-block:: bash
sudo cp /boot/vmlinuz-4.8.0-36-generic.efi.signed /boot/efi
sudo cp /boot/initrd.img-4.8.0-36-generic /boot/efi
#. Create a boot entry for Ubuntu. At a minimum, the file must contain
these settings:
+---------+------------------------------------+
| Setting | Description |
+=========+====================================+
| title | Text to show in the boot menu |
+---------+------------------------------------+
| linux | Linux kernel image |
+---------+------------------------------------+
| initrd | initramfs image |
+---------+------------------------------------+
| options | Options to pass to the EFI program |
| | or kernel boot parameters |
+---------+------------------------------------+
See the `systemd boot loader documentation`_ for additional
details.
The *options* parameters must specify the root partition UUID and
any additional parameters that Ubuntu requires.
.. note:: The root partition UUID used below is unique to this example.
.. code-block:: bash
sudoedit /boot/efi/loader/entries/ubuntu.conf
Add the following lines to the :file:`ubuntu.conf` file:
.. code-block:: console
title Ubuntu 16.04 LTS Desktop
linux /vmlinuz-4.8.0-36-generic.efi.signed
initrd /initrd.img-4.8.0-36-generic
options root=UUID=17f0aa66-3467-4f99-b92c-8b2cea1045aa ro
#. Re-install Systemd-Boot to make it the default boot loader.
.. code-block:: bash
sudo bootctl install --path /boot/efi
.. note::
If an older version of Ubuntu does not have the `bootctl` command,
skip this step and see :ref:`multi-boot-restore-bl` to restore
Systemd-Boot.
#. Reboot.
If you want to install other :abbr:`OSes (operating systems)`, refer to
:ref:`multi-boot` for details.
.. _systemd boot loader documentation:
https://wiki.archlinux.org/index.php/Systemd-boot

Some files were not shown because too many files have changed in this diff Show More