diff --git a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst index 2ceb830f..b4a6efc4 100644 --- a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst +++ b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst @@ -6,20 +6,19 @@ Install Clear Linux OS on bare metal These instructions guide you through the installation of |CLOSIA| on bare metal using a bootable USB drive. -.. include:: ../compatibility-check.rst - :Start-after: compatibility-check: +Before you begin, run our :ref:`compatibility-check`. -.. include:: ../bootable-usb/bootable-usb-linux.rst - :Start-after: bootable-usb-linux: - :end-before: download-cl-image -.. include:: ../bootable-usb/bootable-usb-linux.rst - :Start-after: download-cl-image: - :end-before: verify-checksum +Download the latest Clear Linux installer image +*********************************************** -.. include:: ../bootable-usb/bootable-usb-linux.rst - :Start-after: verify-checksum: - :end-before: copy-usb-linux +Get the latest |CL| installer image from the `image`_ directory. +Look for the :file:`clear-[version number]-installer.img.xz` file. +Once you have downloaded the image, verify and uncompress the file. + +.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst + :Start-after: verify-linux: + :end-before: To uncompress a GZ .. include:: ../bootable-usb/bootable-usb-linux.rst :Start-after: copy-usb-linux: @@ -182,7 +181,7 @@ open a shell, or exit the |CL| installer. This menu is shown in figure 5: Choose Clear Linux installation type ************************************ -Figure 7 shows the next step of the |CL| installer: +Figure 7 shows the next step of the |CL| installer: :guilabel:`Choose installation Type`. Chose whether to install |CL| **automatically** or **manually**. To end the installer process and shut down the system, select the :guilabel:`< Exit >` button. @@ -317,3 +316,4 @@ system. These instructions are captured in the :ref:`enable-user-space`. .. _`NUC6i5SYH product page`: http://www.intel.com/content/www/us/en/nuc/nuc-kit-nuc6i5syh.html +.. _image: https://download.clearlinux.org/image \ No newline at end of file diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst index 718ce8fc..cccd19a3 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst @@ -1,59 +1,33 @@ .. _bootable-usb-linux: Create a bootable USB drive on Linux -************************************ +#################################### Follow these instructions to create a bootable |CLOSIA| USB drive. Use an **8GB** or larger USB drive. -Alternative instructions for other operating systems are available: +These instructions assume you have +:ref:`downloaded an appropriate image`. + +We also provide instructions for other operating systems: * :ref:`bootable-usb-mac` * :ref:`bootable-usb-windows` -.. _download-cl-image: +.. include:: ../../guides/maintenance/image-types.rst + :start-after: image-types-content: -Download the latest Clear Linux image -===================================== - -#. Go to the Clear Linux `image`_ repository and download the desired type: - - * Live image: `clear--live.img.xz` - * Installer image: `clear--installer.img.xz` - - For older versions, see the `releases`_ page. - -#. Although not required, it is recommended to download the corresponding - checksum file (designated with `-SHA512SUMS` at the end of the filename) for - the image in order to verify its integrity. - -.. _verify-checksum: - -Verify the integrity of the download (recommended) -================================================== - -#. Start a terminal emulator. -#. Go to the directory with the downloaded files. -#. To verify the integrity of the image, enter the following (a live image - is used as example): - - .. code-block:: console - - $ sha512sum ./clear--live.img.xz | diff ./clear--live.img.xz-SHA512SUMS - - - If the checksum of the downloaded image is different than the original - checksum, the differences will displayed. An empty output indicates a match. +.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst + :Start-after: verify-linux: .. _copy-usb-linux: Burn the Clear Linux image onto a USB drive -=========================================== +******************************************* .. caution:: - Backup important data before proceeding. The process of burning an image - onto the USB drive completely formats the - USB drive and any existing content will be destroyed. + |CAUTION-BACKUP-USB| #. Open a terminal emulator and get root privilege. @@ -61,9 +35,9 @@ Burn the Clear Linux image onto a USB drive $ sudo -s +#. Go to the directory with the uncompressed image. #. Plug in the USB drive. - -#. Identify the USB drive using the `lsblk` command. This shows all drives +#. 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 primary drive in this case. The @@ -99,26 +73,26 @@ Burn the Clear Linux image onto a USB drive #. Before an image can be burned onto a USB drive, it should be un-mounted. Some Linux distros may automatically mount a USB drive when it is plugged - in. To unmount, use the `umount` command followed by the device - identifier/partition. For example: From the above `lsblk` output, - `/dev/sdd` has 2 mounted partitions. + in. To unmount, use the :command:`umount` command followed by the device + identifier/partition. For example: From the above :command:`lsblk` output, + `/dev/sdd` has 2 mounted partitions. To unmount them, enter: .. code-block:: console # umount /dev/sdd2 # umount /dev/sdd3 -#. Extract the downloaded image file and burn it onto the USB drive (`/dev/sdd` - is used as an example). +#. Burn the image onto the USB drive. The command-line example below burns an + uncompressed image onto `/dev/sdd`: .. code-block:: console - # xzcat clear--live.img.xz | dd of=/dev/sdd bs=4M status=progress + # dd if=./clear-[version number]-[image type] of=/dev/sdd bs=4M status=progress .. _usb-next: Next steps ----------- +********** With a bootable |CL| USB drive, you can: @@ -128,5 +102,3 @@ With a bootable |CL| USB drive, you can: .. _image: https://download.clearlinux.org/image .. _releases: https://download.clearlinux.org/releases - - diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst index 6b7a1c90..e11803ae 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst @@ -1,76 +1,67 @@ .. _bootable-usb-mac: Create a bootable USB drive on macOS -************************************ +#################################### Follow these instructions to create a bootable |CLOSIA| USB drive. Use an **8GB** or larger USB drive. +These instructions assume you have +:ref:`downloaded an appropriate image`. + Alternative instructions for other operating systems are available: * :ref:`bootable-usb-linux` * :ref:`bootable-usb-windows` -.. include:: bootable-usb-linux.rst - :Start-after: download-cl-image: - :end-before: verify-checksum +.. include:: ../../guides/maintenance/image-types.rst + :start-after: image-types-content: -Verify the integrity of the download (recommended) -================================================== +.. include:: ../../guides/maintenance/download-verify-uncompress-mac.rst + :start-after: verify-mac: -#. Start the Terminal app. -#. Go to the directory with the downloaded files. -#. To verify the integrity of the image, enter the following commands: - - .. code-block:: console - - $ shasum -a512 ./clear--live.img.xz | diff ./clear--live.img.xz-SHA512SUMS - - - If the checksum of the downloaded image is different than the original's, - the differences will displayed. Otherwise, an empty output indicates a match. Burn the Clear Linux image onto a USB drive -=========================================== +******************************************* .. caution:: - Backup important data before proceeding. The process of burning an image - onto the USB drive completely formats the - USB drive and any existing content will be destroyed. + |CAUTION-BACKUP-USB| -#. Launch the Terminal application. - -#. Uncompress the |CL| image. - - .. code-block:: console - - $ gunzip clear--live.img.xz - -#. Plug in a USB drive and get its identifier. See Figure 1. +#. Launch the Terminal app. +#. Go to the directory with the uncompressed image. +#. Plug in a USB drive and get its identifier by entering the command + :command:`diskutil list`. See Figure 1. .. code-block:: console $ diskutil list .. figure:: figures/bootable-usb-mac-1.png + :scale: 100 % :alt: Get USB drive identifier -#. Unmount the USB drive identified in the previous step (using `/dev/disk2` - as the example) + Figure 1: macOS - Get USB drive identifier + +#. Unmount the USB drive identified in the previous step. The command-line + example below umounts `/dev/disk2`: .. code-block:: console $ diskutil umountDisk /dev/disk2 -#. Burn the image onto the drive. +#. Burn the image onto the drive using the :command:`dd` command. The + command-line example below burns an uncompressed image onto `/dev/disk2`: .. code-block:: console - $ sudo dd if=/path/to/clear--live.img of=/dev/rdisk2 bs=4m + $ sudo dd if=./clear-[version number]-[image type] of=/dev/rdisk2 bs=4m - * Adding an ‘r’ in front of the disk identifier should help speed up the - imaging process. - * Use `-T` to check imaging progress. + + Adding an ‘r’ in front of the disk identifier should help speed up the + imaging process. + + You can press :kbd:`-T` to check imaging progress. #. Eject the USB drive. @@ -79,7 +70,7 @@ Burn the Clear Linux image onto a USB drive $ diskutil eject /dev/disk2 Next steps ----------- +********** With a bootable |CL| USB drive, you can: diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst index 593bf32e..33954919 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst @@ -1,56 +1,65 @@ .. _bootable-usb-windows: Create a bootable USB drive on Windows -************************************** +###################################### Follow these instructions to create a bootable |CLOSIA| USB drive. Use an **8GB** or larger USB drive. +These instructions assume you have +:ref:`downloaded an appropriate image`. + Alternative instructions for other operating systems are available: * :ref:`bootable-usb-mac` * :ref:`bootable-usb-linux` -.. include:: bootable-usb-linux.rst - :Start-after: download-cl-image: - :end-before: verify-checksum +.. include:: ../../guides/maintenance/image-types.rst + :start-after: image-types-content: -Verify the integrity of the download (recommended) -================================================== - -#. Start Command-Prompt. -#. Go to the directory with the downloaded files. -#. To verify the integrity of the image, enter the following commands: - - .. code-block:: console - - C:\> CertUtil -hashfile ./clear--live.img.xz sha512 - - Compare the output with the original checksum to make sure they match. +.. include:: ../../guides/maintenance/download-verify-uncompress-windows.rst + :Start-after: verify-windows: Burn the Clear Linux image onto a USB drive -=========================================== +******************************************* .. caution:: - Backup important data before proceeding. The process of burning an image - onto the USB drive completely formats the - USB drive and any existing content will be destroyed. + |CAUTION-BACKUP-USB| -#. Download the `Rufus`_ tool to burn the image onto a USB drive. +#. Download the `Rufus`_ tool to burn the image onto a USB drive. +#. Plug in the USB drive. +#. Click the :guilabel:`CD-ROM` icon button. See Figure 1. -#. Plug in the USB drive. + .. figure:: figures/bootable-usb-windows-1.png + :scale: 80 % + :alt: Rufus utility - Click CD-ROM button -#. Select the |CL| image file and ensure that “Create a bootable disk using DD - Image” is checked. See Figure 1. + Figure 1: Rufus utility - Click CD-ROM button - .. figure:: figures/bootable-usb-windows-1.png - :alt: Burn image onto USB drive +#. By default, Rufus only shows ISO files. To find and select a compressed |CL| + image file, you must click the file-type dropdown and select :guilabel:`All files`. + See Figure 2. -#. Click Start. + .. figure:: figures/bootable-usb-windows-2.png + :scale: 80 % + :alt: Rufus utility - Show and select |CL| image file + + Figure 2: Rufus utility - Show and select |CL| image file + +#. Verify that :guilabel:`Create a bootable disk using DD Image` checkbox is + checked. See Figure 3. + + .. figure:: figures/bootable-usb-windows-3.png + :scale: 80 % + :alt: Rufus utility - Create a bootable disk using DD Image + + Figure 3: Rufus utility - Create a bootable disk using DD Image + +#. Click :guilabel:`Start`. Next steps ----------- +********** With a bootable |CL| USB drive, you can: diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb.rst index c42f5b69..431e9e2f 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb.rst @@ -3,8 +3,24 @@ Create a bootable Clear Linux USB drive ####################################### -Instructions to create a |CLOSIA| USB drive vary depending on the system you are -using. See below for step-by-step instructions catered to your system: +Instructions to create a |CLOSIA| USB drive vary depending on your operating +system. + +.. _download-usb-image: + +Download the latest Clear Linux image +************************************* + +There are 2 types of |CL| images suitable for burning onto and running +off a USB drive: + + * Live image: :file:`clear-[version number]-live.img.xz` + * Installer image: :file:`clear-[version number]-installer.img.xz` + +Go to the Clear Linux `image`_ repository and download the desired type. + +With the appropriate image downloaded, choose the step-by-step instructions +applicable to your system: .. toctree:: :maxdepth: 1 @@ -12,3 +28,5 @@ using. See below for step-by-step instructions catered to your system: bootable-usb-linux bootable-usb-windows bootable-usb-mac + +.. _image: https://download.clearlinux.org/image diff --git a/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-1.png b/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-1.png index 5798a012..39152060 100644 Binary files a/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-1.png and b/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-1.png differ diff --git a/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-2.png b/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-2.png new file mode 100644 index 00000000..2441ff67 Binary files /dev/null and b/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-2.png differ diff --git a/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-3.png b/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-3.png new file mode 100644 index 00000000..f9e32fe3 Binary files /dev/null and b/source/clear-linux/get-started/bootable-usb/figures/bootable-usb-windows-3.png differ diff --git a/source/clear-linux/get-started/bootable-usb/figures/download-verify-uncompress-windows-fig-1.png b/source/clear-linux/get-started/bootable-usb/figures/download-verify-uncompress-windows-fig-1.png new file mode 100644 index 00000000..0b0ee7f6 Binary files /dev/null and b/source/clear-linux/get-started/bootable-usb/figures/download-verify-uncompress-windows-fig-1.png differ diff --git a/source/clear-linux/get-started/compatibility-check.rst b/source/clear-linux/get-started/compatibility-check.rst index f6d196c4..ea0a2fa0 100644 --- a/source/clear-linux/get-started/compatibility-check.rst +++ b/source/clear-linux/get-started/compatibility-check.rst @@ -1,11 +1,11 @@ .. _compatibility-check: Check processor and EFI firmware compatibility with Clear Linux\* -***************************************************************** +################################################################# On a system that is currently running a Linux operating system, follow the instructions below to determine if your system's processor and EFI firmware is -capable of running |CLOSIA|. Otherwise, +capable of running |CLOSIA|. Otherwise, :ref:`run Clear Linux as a Live image ` and then perform the steps below. diff --git a/source/clear-linux/get-started/live-image.rst b/source/clear-linux/get-started/live-image.rst index 1c9c323e..c95312bd 100644 --- a/source/clear-linux/get-started/live-image.rst +++ b/source/clear-linux/get-started/live-image.rst @@ -8,46 +8,28 @@ 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. -.. include:: bootable-usb/bootable-usb-linux.rst - :Start-after: bootable-usb-linux: - :end-before: download-cl-image - -Download the latest Clear Linux Live image -****************************************** - -#. Get the latest |CL| Live image from the `image`_ page. Look for - `clear--live.img.xz`. - - For older versions, see the `releases`_ page. - -#. Although not required, it is recommended to download the corresponding - checksum file (designated with `-SHA512SUMS` at the end of the filename) for - the image in order to verify its integrity. - -.. include:: bootable-usb/bootable-usb-linux.rst - :Start-after: verify-checksum: - :end-before: verify-checksum-on-macos - -.. include:: bootable-usb/bootable-usb-linux.rst - :Start-after: copy-usb-linux: - :end-before: usb-next +To create a bootable USB drive with a live image, follow +:ref:`our step-by-step instructions` 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 Clear Linux Live image +Boot the Clear Linux 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. + * Enable `Intel® Virtualization Technology (Intel® VT)`_. + * Enable `Intel® Virtualization Technology for Directed I/O (Intel® VT-d)`_. + * Disable `Secure Boot`. +#. Plug the imaged USB drive in and boot it up. #. Log in as `root` and set a password. -.. _`releases`: https://download.clearlinux.org/releases .. _`image`: https://download.clearlinux.org/image + .. _`Intel® Virtualization Technology (Intel® VT)`: http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html + .. _`Intel® Virtualization Technology for Directed I/O (Intel® VT-d)`: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices>` diff --git a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst index ce59a7f1..006d22c7 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst @@ -30,7 +30,6 @@ appropriate set of step-by-step instructions to proceed. kvm virtualbox - vmware-esxi vmware-player hyper-v diff --git a/source/clear-linux/get-started/virtual-machine-install/vmware-esxi.rst b/source/clear-linux/get-started/virtual-machine-install/vmware-esxi.rst deleted file mode 100644 index 1ee967e4..00000000 --- a/source/clear-linux/get-started/virtual-machine-install/vmware-esxi.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. _vmware-esxi: - -Use VMware\* ESXi guest -####################### - - -This section is based on *VMware vSphere 6* and explains how to use |CLOSIA| -as ESXi Guest. - -Ensure `Intel® Virtualization Technology`_ (Intel® VT) and -`Intel® Virtualization Technology for Directed I/O`_ (Intel® VT-d) are both -enabled in your BIOS/UEFI firmware configuration. - -Run Clear Linux OS for Intel Architecture -========================================= - -#. Download the `latest`_ |CL| **live** version - :file:`clear-{release-number}-live.img.xz`. - -#. Decompress the downloaded image. Uncompressed image size is ~ **5GB**. - - * On Linux: - - .. code-block:: console - - $ xz -d clear-{release-number}-live.img.xz - - * On Windows, use `7zip`_. - - - Right-click the file and select - :menuselection:`Extract in the same directory`. - - .. image:: ./figures/7zipwin.png - :alt: 7zip extract here command - -#. Create a virtual machine with the following configuration: - - * :guilabel:`Guest OS`: Linux, Distribution: Other 3.x Linux (64-bits) - - * :guilabel:`UEFI support`: |CL| uses `systemd-boot` as the UEFI - boot manager for EFI images. Add UEFI support. Find this option's - settings using the vSphere GUI. Go to the - :menuselection:`Configuration settings of the virtual machine-->General` - Tab and select :guilabel:`EFI boot firmware`. - - * :guilabel:`SCSI Para-virtualized disk`: Convert to - :abbr:`VMDK (VMware DisK)` and attach the |CL| image downloaded above. - - + On Linux, To convert Clear Linux image to VMDK\* you can use the - :command:`qemu-img` command: - - .. code-block:: console - - qemu-img convert -f raw -O vmdk -o adapter_type=lsilogic -o compat6 -p clear-vmware.img clear-vmware.vmdk - - + On Windows, convert the live image from RAW to VMDK format with a - tool like :program:`VBoxManage` from `VirtualBox`_. You can refer on - :ref:`how to create a VM on VirtualBox ` as an - example. - -#. Transfer the Clear Linux image to the VMware ESXi server and use the - :command:`vmkfstools` command. Access to ESXi command line is required: - - .. code-block:: console - - vmkfstools -i clear-vmware.vmdk -d zeroedthick clear-vmware-fix.vmdk - -#. Add the converted image to the guest using the VMware vSphere virtual - machine settings. - -#. Start the virtual machine. - -.. _latest: https://download.clearlinux.org/image/ -.. _7zip: http://www.7-zip.org/ -.. _VirtualBox: https://www.virtualbox.org/ -.. _Intel® Virtualization Technology: - http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html -.. _Intel® Virtualization Technology for Directed I/O: - https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices - diff --git a/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst b/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst new file mode 100644 index 00000000..8cd944c7 --- /dev/null +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst @@ -0,0 +1,62 @@ +.. _download-verify-uncompress-linux: + +Download, verify, and uncompress a Clear Linux image on Linux +############################################################# + +This section explains the types of |CLOSIA| images available, where to download +them, how to verify the integrity of an image, and how to uncompress it. + +We also provide instructions for other operating systems: + +* :ref:`download-verify-uncompress-mac` +* :ref:`download-verify-uncompress-windows` + +.. include:: image-types.rst + :start-after: image-types-content: + +.. _verify-linux: + +Verify the integrity of the Clear Linux image +********************************************* + +Before you use a downloaded |CL| image, verify its integrity. Thus, you +eliminate the small chance of a corrupted image due to download issues. +To support verification, we accompany each released |CL| image with an official +SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. + +#. Download the official corresponding SHA512 checksum file of your + downloaded |CL| image. +#. Start a terminal emulator. +#. Go to the directory with the downloaded image and checksum files. +#. Verify the integrity of the image and compare it to its original checksum + by entering: + + .. code-block:: console + + $ sha512sum ./clear-[version number]-[image type].[compression type] | diff ./clear-[version number]-[image type].[compression type]-SHA512SUMS - + +If the checksum of the downloaded image is different than the original +checksum, the differences will displayed. Otherwise, an empty output indicates +a match and your downloaded image is good. + +Uncompress the Clear Linux image +******************************** + +We compress all released |CL| images by default with either GNU zip +(`.gz`) or XZ (`.xz`). The compression type we use depends on the target +platform or environment of the image. To uncompress the image, follow these steps: + +#. Start a terminal emulator. +#. Go to the directory with the downloaded image. + + To uncompress an XZ image, enter: + + .. code-block:: console + + $ unxz clear-[version number]-[image type].xz + + To uncompress a GZ image, enter: + + .. code-block:: console + + $ gunzip clear-[version number]-[image type].gz diff --git a/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst b/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst new file mode 100644 index 00000000..3c3eb766 --- /dev/null +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst @@ -0,0 +1,57 @@ +.. _download-verify-uncompress-mac: + +Download, verify, and uncompress a Clear Linux image on macOS +############################################################# + +This section explains the types of |CLOSIA| images available, where to download +them, how to verify the integrity of an image, and how to uncompress it. + +We also provide instructions for other operating systems: + +* :ref:`download-verify-uncompress-linux` +* :ref:`download-verify-uncompress-windows` + +.. include:: image-types.rst + :start-after: image-types-content: + +.. _verify-mac: + +Verify the integrity of the Clear Linux image +********************************************* + +Before you use a downloaded |CL| image, verify its integrity. Thus, you +eliminate the small chance of a corrupted image due to download issues. +To support verification, we accompany each released |CL| image with an official +SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. + +#. Download the official corresponding SHA512 checksum file of your + downloaded |CL| image. +#. Start the Terminal app. +#. Go to the directory with the downloaded image and checksum files. +#. Verify the integrity of the image and compare it to its original checksum + by entering: + + .. code-block:: console + + $ shasum -a512 ./clear-[version number]-[image type].[compression type] | diff ./clear-[version number]-[image type].[compression type]-SHA512SUMS - + +If the checksum of the downloaded image is different than the original +checksum, the differences will displayed. Otherwise, an empty output indicates +a match and your downloaded image is good. + +Uncompress the Clear Linux image +******************************** + +We compress all released |CL| images by default with either GNU zip +(`.gz`) or XZ (`.xz`). The compression type we use depends on the target +platform or environment of the image. To uncompress the image, follow these steps: + +#. Start the Terminal app. +#. Go to the directory with the downloaded image. +#. You can use the `gunzip` command to uncompress both types of compression + formats. For examples: + + .. code-block:: console + + $ gunzip clear-[version number]-[image type].xz + $ gunzip clear-[version number]-[image type].gz diff --git a/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst b/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst new file mode 100644 index 00000000..e222d6b2 --- /dev/null +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst @@ -0,0 +1,58 @@ +.. _download-verify-uncompress-windows: + +Download, verify, and uncompress a Clear Linux image on Windows +############################################################### + +This section explains the types of |CLOSIA| images available, where to download +them, how to verify the integrity of an image, and how to uncompress it. + +We also provide instructions for other operating systems: + +* :ref:`download-verify-uncompress-linux` +* :ref:`download-verify-uncompress-mac` + +.. include:: image-types.rst + :start-after: image-types-content: + +.. _verify-windows: + +Verify the integrity of the Clear Linux image +********************************************* + +Before you use a downloaded |CL| image, verify its integrity. Thus, you +eliminate the small chance of a corrupted image due to download issues. +To support verification, we accompany each released |CL| image with an official +SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. + +#. Download the official corresponding SHA512 checksum file of your + downloaded |CL| image. +#. Start Command-Prompt. +#. Go to the directory with the downloaded image and checksum files. +#. Get the SHA512 checksum of the image by entering: + + .. code-block:: console + + C:\> CertUtil -hashfile ./clear-[version number]-[image type].[compression type] sha512 + +#. Manually compare the output with the original checksum value shown in + the downloaded checksum file and make sure they match. + +Uncompress the Clear Linux image +******************************** + +We compress all released |CL| images by default with either GNU zip +(`.gz`) or XZ (`.xz`). The compression type we use depends on the target +platform or environment of the image. To uncompress the image, follow these steps: + +#. Download and install `7zip`_. +#. Locate the |CL| image and right-click it. +#. From the pop-up menu, select :guilabel:`7-Zip` and select + :guilabel:`Extract here`. + + .. figure:: figures/download-verify-uncompress-windows-fig-1.png + :scale: 80 % + :alt: 7-Zip extract file + + Figure 1: Windows - 7-Zip extract file + +.. _7zip: http://www.7-zip.org/ diff --git a/source/clear-linux/guides/maintenance/figures/download-verify-uncompress-windows-fig-1.png b/source/clear-linux/guides/maintenance/figures/download-verify-uncompress-windows-fig-1.png new file mode 100755 index 00000000..0b0ee7f6 Binary files /dev/null and b/source/clear-linux/guides/maintenance/figures/download-verify-uncompress-windows-fig-1.png differ diff --git a/source/clear-linux/guides/maintenance/image-types.rst b/source/clear-linux/guides/maintenance/image-types.rst new file mode 100644 index 00000000..bf32eb3f --- /dev/null +++ b/source/clear-linux/guides/maintenance/image-types.rst @@ -0,0 +1,58 @@ +.. _image-types: + +Clear Linux image types +####################### + +.. _image-types-content: + +|CL| offers many types of `images`_ for different platforms and environments. + +The naming convention of a |CL| image filename is: + + .. code-block:: console + + clear-[version number]-[image type].[compression type] + +The *[version number]* field specifies the version number. + +The *[image type]* field specifies the type of image and its corresponding +file format. + +The *[compression type]* field specifies the compression type. Two types of +compressions are used, namely GNU zip (*.gz*) and XZ (*.xz*). + +The current list of available images: + +.. list-table:: Table 1: Types of Clear Linux images + :widths: 20, 60 + :header-rows: 1 + + * - Image Type + - Description + * - azure.vhd + - Image for Microsoft Azure + * - azure-docker.vhd + - Image with the Docker installed for Microsoft Azure + * - azure-machine-learning.vhd + - Image with the `machine-learning-basic` bundle installed for Microsoft + Azure + * - cloud.img + - Image for cloud deployment such as OpenStack, etc. + * - containers.img + - An optimized image utilized by Clear Containers runtime + * - hyperv.vhdx + - Image for Microsoft HyperV + * - hyperv-mini.vhdx + - A minimal image with fewer bundles for Microsoft HyperV + * - installer.img + - An interactive installer image for installing Clear Linux + * - installer.iso + - An ISO of the interactive installer image for installing Clear Linux + * - kvm.img + - Image for booting in a simple VM with start_qemu.sh + * - live.img + - A live boot image of Clear Linux + * - vmware.vmdk + - Image for VMware + +.. _images: https://download.clearlinux.org/image diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst index fb86d493..9f7ee213 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -16,3 +16,7 @@ maintaining |CLOSIA| after :ref:`installation ` is completed. validate-signatures telemetry-enable time + download-verify-uncompress-linux + download-verify-uncompress-mac + download-verify-uncompress-windows + image-types diff --git a/source/substitutions.txt b/source/substitutions.txt index 051cd808..b8bc7513 100644 --- a/source/substitutions.txt +++ b/source/substitutions.txt @@ -3,3 +3,6 @@ .. |CLOSIA| replace:: Clear Linux* OS for Intel® Architecture .. |CC| replace:: Clear Containers + +.. |CAUTION-BACKUP-USB| replace:: + Burning an image formats the USB drive, thus destroying all existing content. Backup your data before proceeding.