Files
clear-linux-documentation/source/get-started/bootable-usb.rst
bktan8 73e5ba9f6f Remove reference to "decompress" in bare metal installer docs. (#847)
- In Preliminary steps, remove penultimate step on verify.
- Verify integrity of image is already included in `bootable-usb`
- If `bootable-usb` is referenced in installation docs, `verify` is implied
- Edits `..-install-server` to make Prelim steps consistent with `..-install-server`

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
2019-10-07 19:48:32 -07:00

223 lines
6.3 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
.. _bootable-usb:
Create a bootable USB drive
###########################
Follow the instructions applicable to your system to create a bootable
|CL-ATTR| USB drive:
* :ref:`bootable-usb-linux`
* :ref:`bootable-usb-mac`
* :ref:`bootable-usb-windows`
Prerequisites
*************
* Download the |CL| Desktop or Server image from the `Downloads`_ page
* Recommended minimum **4GB** USB drive or larger
.. _bootable-usb-linux:
Create a bootable USB drive on Linux\*
**************************************
* Make sure you completed all `Prerequisites`_.
* :ref:`verify-linux` on Linux.
Burn the |CL| image onto a USB drive
====================================
.. caution::
Burning an image formats the USB drive and destroys all pre-existing
content. Back up your data before proceeding.
#. Open a terminal window.
#. Change directory to where the image resides.
#. Plug in the USB drive.
#. Identify the USB drive using the :command:`lsblk` command. This shows all
drives attached to the system, including the primary hard disk. In the
example output below, there are 4 drives
(`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached, where
`/dev/sda` is the primary drive. The remaining are three USB drives. The output
also shows the mounted partitions (under the `MOUNTPOINT` column) for each
drive.
.. code-block:: bash
lsblk
Example output:
.. code-block:: console
:emphasize-lines: 1-5
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
sdd 8:48 1 15G 0 disk
├─sdd2 8:50 1 5G 0 part /run/media/user1/960c184f-3bb7-42b7-bcaf-0c1282
├─sdd3 8:51 1 8G 0 part /run/media/user1/704f3382-b26d-4f34-af1b-cb9aab
└─sdd1 8:49 1 2G 0 part
sdb 8:16 1 14.8G 0 disk
└─sdb1 8:17 1 14.8G 0 part /run/media/user1/PATRIOT_USB
sdc 8:32 1 7.3G 0 disk
└─sdc1 8:33 1 7.3G 0 part /run/media/user1/LINUX MINT
sda 8:0 0 335.4G 0 disk
├─sda4 8:4 0 28G 0 part
├─sda2 8:2 0 3.7G 0 part [SWAP]
├─sda7 8:7 0 6G 0 part /home
├─sda5 8:5 0 1G 0 part /boot
├─sda3 8:3 0 954M 0 part /boot/efi
├─sda1 8:1 0 28G 0 part
├─sda8 8:8 0 30G 0 part /
└─sda6 8:6 0 7.9G 0 part [SWAP]
.. note::
Some Linux distros may automatically mount a USB drive when it is plugged in.
#. If the USB drive you want to use is mounted, it must be umounted before
burning an image onto it. Use the :command:`umount` command followed by
the device identifier/partition. For example, to unmount all /dev/sdd
partitions:
.. code-block:: bash
sudo umount /dev/sdd*
#. Burn the image onto the USB drive. The example below burns an image onto `<your USB device>`:
.. code-block:: bash
sudo dd if=./clear-[version number]-live-[desktop | server].iso of=<your USB device> oflag=sync bs=4M status=progress
.. caution::
Not fully unmounting the USB drive before burning an image could cause
file system checksum errors in it. If this happens, burn the image again,
ensuring all the USB drive partitions are unmounted first.
.. _bootable-usb-mac:
Create a bootable USB drive on macOS\*
**************************************
* Make sure you completed all `Prerequisites`_.
* :ref:`verify-mac` on macOS.
Burn the |CL| image onto a USB drive
====================================
.. caution::
Burning an image formats the USB drive and destroys all pre-existing
content. Back up your data before proceeding.
#. Open a Terminal window.
#. Change directory to where the image resides.
#. Plug in a USB drive and get its identifier:
.. code-block:: bash
diskutil list
This lists available disks and their partitions, as shown in Figure 1.
.. figure:: /_figures/bootable-usb/bootable-usb-mac-01.png
:scale: 100 %
:alt: Get USB drive identifier
Figure 1: macOS - Get USB drive identifier
#. Unmount the USB drive identified in the previous step. For example, to unmount /dev/disk2:
.. code-block:: bash
diskutil umountDisk /dev/disk2
#. Burn the image onto the drive using the :command:`dd` command.
This example uses `./`, your current directory, and it shows how to burn
an image onto `<your USB device>`:
.. code-block:: bash
sudo dd if=./clear-[version number]-live-[desktop | server].iso of=<your USB device> bs=4m
To accelerate the imaging process, add an r before the disk identifier.
Example: `sudo dd if=./clear-30800-live-server.iso of=/dev/rdisk2 bs=4m`.
Press :kbd:`<CTRL>-T` to check imaging progress.
#. Eject the USB drive.
.. code-block:: bash
diskutil eject /dev/disk2
.. _bootable-usb-windows:
Create a bootable USB drive on Windows
**************************************
* Make sure you completed all `Prerequisites`_.
* :ref:`verify-windows` on Windows\* OS.
Burn the |CL| image onto a USB drive
====================================
.. caution::
Burning an image formats the USB drive and destroys all pre-existing
content. Back up your data before proceeding.
#. Download the `Rufus`_ utility to burn the image onto a USB drive.
We use Rufus 3.5 for this example.
**Only use the latest version of Rufus**.
#. Plug in the USB drive.
#. Launch Rufus.
#. Under `Device`, select the USB drive.
#. Under `Boot selection`, click the :guilabel:`SELECT` button.
.. note::
For other image tools, verify the `Volume label` is set to :guilabel:`CLR_ISO` **Do not change the label as installer relies on it.**
#. Click the :guilabel:`START` button. See Figure 2.
.. figure:: /_figures/bootable-usb/bootable-usb-windows-02.png
:scale: 80 %
:alt: Rufus utility
Figure 2: Rufus utility
#. When the dialogue appears, select
:guilabel:`Write in ISO image mode (Recommended)`. See Figure 3.
.. figure:: /_figures/bootable-usb/bootable-usb-windows-03.png
:scale: 80 %
:alt: ISOHybrid image detected
Figure 3: ISOHybrid image detected
#. Click :guilabel:`OK`.
#. The process make take more than a few minutes. When the process completes,
close Rufus.
#. Select the Windows taskbar menu for USB and select
:guilabel:`Eject <drive name>`.
.. _Rufus: https://rufus.ie/
.. _Downloads: https://clearlinux.org/downloads