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 d1ccc957..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,30 +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:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: types-of-cl-images: - :end-before: verify-image-checksum Download the latest Clear Linux installer image -=============================================== +*********************************************** -Get the latest |CL| installer image from the `image`_ directory. +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-image-checksum-on-linux: - :end-before: uncompress-image-on-linux - -.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: uncompress-image-on-linux: - :end-before: uncompress-gz-on-linux + :Start-after: verify-linux: + :end-before: To uncompress a GZ .. include:: ../bootable-usb/bootable-usb-linux.rst :Start-after: copy-usb-linux: @@ -192,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. 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 e911ae2c..751ebca6 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,46 +1,29 @@ .. _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 and 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: .. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: types-of-cl-images: - :end-before: verify-image-checksum-on-linux - -.. _download-usb-suitable-images: - -Download the latest Clear Linux image -===================================== - -There are 2 types of |CL| images that are 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. - -.. _image: https://download.clearlinux.org/image - -.. _end-download-usb-suitable-images: - -.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: verify-image-checksum-on-linux: + :Start-after: verify-linux: .. _copy-usb-linux: Burn the Clear Linux image onto a USB drive -=========================================== +******************************************* .. caution:: @@ -99,8 +82,8 @@ Burn the Clear Linux image onto a USB drive # umount /dev/sdd2 # umount /dev/sdd3 -#. Burn the image onto the USB drive. The command-line example below burns an - uncompressed image onto `/dev/sdd`: +#. Burn the image onto the USB drive. The command-line example below burns an + uncompressed image onto `/dev/sdd`: .. code-block:: console @@ -109,7 +92,7 @@ Burn the Clear Linux image onto a USB drive .. _usb-next: Next steps ----------- +********** With a bootable |CL| USB drive, you can: @@ -119,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 1738fa70..fce3f933 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,33 +1,28 @@ .. _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 and appropriate image`. + Alternative instructions for other operating systems are available: * :ref:`bootable-usb-linux` * :ref:`bootable-usb-windows` -.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: types-of-cl-images: - :end-before: verify-image-checksum-on-linux - -.. include:: bootable-usb-linux.rst - :Start-after: download-usb-suitable-images: - :end-before: end-download-usb-suitable-images +.. include:: ../../guides/maintenance/image-types.rst + :start-after: image-types-content: .. include:: ../../guides/maintenance/download-verify-uncompress-mac.rst - :Start-after: verify-image-checksum-on-mac: - :end-before: uncompress-image-on-mac + :start-after: verify-mac: -.. include:: ../../guides/maintenance/download-verify-uncompress-mac.rst - :Start-after: uncompress-image-on-mac: Burn the Clear Linux image onto a USB drive -=========================================== +******************************************* .. caution:: @@ -35,7 +30,7 @@ Burn the Clear Linux image onto a USB drive #. 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 +#. Plug in a USB drive and get its identifier by entering the command `diskutil list`. See Figure 1. .. code-block:: console @@ -46,14 +41,14 @@ Burn the Clear Linux image onto a USB drive :scale: 100 % :alt: Get USB drive identifier -#. Unmount the USB drive identified in the previous step. The command-line +#. 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. The command-line example below burns an +#. Burn the image onto the drive. The command-line example below burns an uncompressed image onto `/dev/disk2`: .. code-block:: console @@ -61,7 +56,7 @@ Burn the Clear Linux image onto a USB drive $ sudo dd if=./clear-[version number]-[image type] of=/dev/rdisk2 bs=4m .. note:: - + * Adding an ‘r’ in front of the disk identifier should help speed up the imaging process. * Press :kbd:`-T` to check imaging progress. @@ -73,7 +68,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 80786d34..8d74ab38 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 @@ -6,28 +6,22 @@ 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 and appropriate image`. + Alternative instructions for other operating systems are available: * :ref:`bootable-usb-mac` * :ref:`bootable-usb-linux` -.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: types-of-cl-images: - :end-before: verify-image-checksum-on-linux - -.. include:: bootable-usb-linux.rst - :Start-after: download-usb-suitable-images: - :end-before: end-download-usb-suitable-images +.. include:: ../../guides/maintenance/image-types.rst + :start-after: image-types-content: .. include:: ../../guides/maintenance/download-verify-uncompress-windows.rst - :Start-after: verify-image-checksum-on-windows: - :end-before: uncompress-image-on-windows - -.. include:: ../../guides/maintenance/download-verify-uncompress-windows.rst - :Start-after: uncompress-image-on-windows: + :Start-after: verify-windows: Burn the Clear Linux image onto a USB drive -=========================================== +******************************************* .. caution:: @@ -37,7 +31,7 @@ Burn the Clear Linux image onto a USB drive #. Plug in the USB drive. #. Click the CD-ROM icon button and select the |CL| image file. See Figure 1. #. Ensure that :guilabel:`Create a bootable disk using DD - Image` is checked. + Image` is checked. .. figure:: figures/bootable-usb-windows-1.png :scale: 100 % @@ -46,7 +40,7 @@ Burn the Clear Linux image onto a USB drive #. 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/guides/maintenance/figures/7zipwin.png b/source/clear-linux/get-started/bootable-usb/figures/download-verify-uncompress-windows-fig-1.png old mode 100755 new mode 100644 similarity index 100% rename from source/clear-linux/guides/maintenance/figures/7zipwin.png rename to source/clear-linux/get-started/bootable-usb/figures/download-verify-uncompress-windows-fig-1.png 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 f6ad029c..c95312bd 100644 --- a/source/clear-linux/get-started/live-image.rst +++ b/source/clear-linux/get-started/live-image.rst @@ -8,31 +8,10 @@ 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 - -.. include:: ../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: types-of-cl-images: - :end-before: verify-image-checksum - -Download the latest Clear Linux live image -========================================== - -Get the latest |CL| live image from the `image`_ directory. -Look for :file:`clear-[version number]-live.img.xz`. - -.. include:: ../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: verify-image-checksum-on-linux: - :end-before: uncompress-image-on-linux - -.. include:: ../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: uncompress-image-on-linux: - :end-before: uncompress-gz-on-linux - -.. 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: @@ -40,16 +19,17 @@ 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. + +#. 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/guides/maintenance/download-verify-uncompress-linux.rst b/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst index 15a757d6..fb817890 100644 --- a/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst @@ -6,112 +6,59 @@ 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. -Alternative instructions for other operating systems are available: +We also provide instructions for other operating systems: * :ref:`download-verify-uncompress-mac` * :ref:`download-verify-uncompress-windows` -.. _types-of-cl-images: +.. include:: image-types.rst + :start-after: image-types-content: -Types of Clear Linux images -=========================== - -|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 current list of images available are: - -.. 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 - -The *[compression type]* field specifies the compression type. Two types of -compressions are used, namely GNU zip (*.gz*) and XZ (*.xz*). - -.. _images: https://download.clearlinux.org/image - -.. _verify-image-checksum-on-linux: +.. _verify-linux: Verify the integrity of the Clear Linux image -============================================= +********************************************* -Before you use a downloaded |CL| image, it is recommended that you verify its -integrity to eliminate the chance, albeit small, that it might be corrupted due -to any download issues. To support this, each released |CL| image is accompanied -by an official SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. +Before you use a downloaded |CL| image, it is recommended that you verify its +integrity to eliminate the chance, albeit small, that it might be corrupted +due to any download issues. To support this, each released |CL| image is +accompanied by an official SHA512 checksum file, which is designated with the +suffix `-SHA512SUMS`. -#. Download the official corresponding SHA512 checksum file of your downloaded |CL| image. +#. 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: +#. Verify the integrity of the image and compare it to its original checksum + by entering: - .. code-block:: console + .. 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 +checksum, the differences will displayed. Otherwise, an empty output indicates a match and your downloaded image is good. -.. _uncompress-image-on-linux: - Uncompress the Clear Linux image -================================ +******************************** -All released |CL| images are compressed by default using either GNU zip -(`.gz`) or XZ (`.xz`). The compression typed used is dependent on which -platform/enviroment the image is targeted for. Uncompress your image using +All released |CL| images are compressed by default using either GNU zip +(`.gz`) or XZ (`.xz`). The compression typed used is dependent on which +platform/enviroment the image is targeted for. Uncompress your image using these steps: #. Start a terminal emulator. #. Go to the directory with the downloaded image. -.. _uncompress-xz-on-linux: + To uncompress an XZ image, enter: - To uncompress an XZ image, enter: + .. code-block:: console - .. code-block:: console + $ unxz clear-[version number]-[image type].xz - $ unxz clear-[version number]-[image type].xz + To uncompress a GZ image, enter: -.. _uncompress-gz-on-linux: + .. code-block:: console - To uncompress a GZ image, enter: - - .. code-block:: console - - $ gunzip clear-[version number]-[image type].gz \ No newline at end of file + $ 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 index d0e05782..3ffe39eb 100644 --- a/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst @@ -6,54 +6,54 @@ 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. -Alternative instructions for other operating systems are available: +We also provide instructions for other operating systems: * :ref:`download-verify-uncompress-linux` * :ref:`download-verify-uncompress-windows` -.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: types-of-cl-images: - :end-before: verify-image-checksum-on-linux +.. include:: image-types.rst + :start-after: image-types-content: -.. _verify-image-checksum-on-mac: +.. _verify-mac: Verify the integrity of the Clear Linux image -============================================= +********************************************* -Before you use a downloaded |CL| image, it is recommended that you verify its -integrity to eliminate the chance, albeit small, that it might be corrupted due -to any download issues. To support this, each released |CL| image is accompanied -by an official SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. +Before you use a downloaded |CL| image, it is recommended that you verify its +integrity to eliminate the chance, albeit small, that it might be corrupted +due to any download issues. To support this, each released |CL| image is +accompanied by 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: +#. 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 +checksum, the differences will displayed. Otherwise, an empty output indicates a match and your downloaded image is good. -.. _uncompress-image-on-mac: - Uncompress the Clear Linux image -================================ +******************************** -All released |CL| images are compressed by default using either GNU zip -(`.gz`) or XZ (`.xz`). The compression typed used is dependent on which -platform/enviroment the image is targeted for. Uncompress your image using +All released |CL| images are compressed by default using either GNU zip +(`.gz`) or XZ (`.xz`). The compression typed used is dependent on which +platform/enviroment the image is targeted for. Uncompress your image using 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: +#. 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 \ No newline at end of file + $ 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 index 17fcb45a..31e63330 100644 --- a/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst @@ -6,55 +6,55 @@ 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. -Alternative instructions for other operating systems are available: +We also provide instructions for other operating systems: * :ref:`download-verify-uncompress-linux` * :ref:`download-verify-uncompress-mac` -.. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst - :Start-after: types-of-cl-images: - :end-before: verify-image-checksum-on-linux +.. include:: image-types.rst + :start-after: image-types-content: -.. _verify-image-checksum-on-windows: +.. _verify-windows: Verify the integrity of the Clear Linux image -============================================= +********************************************* -Before you use a downloaded |CL| image, it is recommended that you verify its -integrity to eliminate the chance, albeit small, that it might be corrupted due -to any download issues. To support this, each released |CL| image is accompanied -by an official SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. +Before you use a downloaded |CL| image, it is recommended that you verify its +integrity to eliminate the chance, albeit small, that it might be corrupted +due to any download issues. To support this, each released |CL| image is +accompanied by an official SHA512 checksum file, which is designated with the +suffix `-SHA512SUMS`. -#. Download the official corresponding SHA512 checksum file of your downloaded |CL| image. +#. 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: +#. 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 +#. Manually compare the output with the original checksum value shown in the downloaded checksum file and make sure they match. -.. _uncompress-image-on-windows: - Uncompress the Clear Linux image -================================ +******************************** -All released |CL| images are compressed by default using either GNU zip -(`.gz`) or XZ (`.xz`). The compression typed used is dependent on which -platform/enviroment the image is targeted for. Uncompress your image using +All released |CL| images are compressed by default using either GNU zip +(`.gz`) or XZ (`.xz`). The compression typed used is dependent on which +platform/enviroment the image is targeted for. Uncompress your image using 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`. +#. From the pop-up menu, select :guilabel:`7-Zip` and select + :guilabel:`Extract here`. - .. figure:: figures/7zipwin.png - :scale: 80 % - :alt: 7-Zip extract file + .. figure:: figures/download-verify-uncompress-windows-fig-1.png + :scale: 80 % + :alt: 7-Zip extract file - Figure 1: Windows - 7-Zip extract file + Figure 1: Windows - 7-Zip extract file -.. _7zip: http://www.7-zip.org/ \ No newline at end of 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 cd546abe..9f7ee213 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -19,3 +19,4 @@ maintaining |CLOSIA| after :ref:`installation ` is completed. download-verify-uncompress-linux download-verify-uncompress-mac download-verify-uncompress-windows + image-types