Merge pull request #181 from puneetse/edit/ps-image-types-reference

Update document describing image types
2026-08-26 10:28:24 +00:00 · 2018-06-29 14:12:54 -07:00
parent 98b2c0715f 5379715cf9
commit e65963e72d
2 changed files with 77 additions and 58 deletions
@@ -1,58 +0,0 @@
-.. _image-types:
-
-Clear Linux image types
-#######################
-
-.. _image-types-content:
-
-|CLOSIA| 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: GNU\* zip (*.gz*) and XZ (*.xz*).
-
-Table 1 lists the currently 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 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\*
-   * - containers.img
-     - Optimized image used by Clear Containers runtime
-   * - hyperv.vhdx
-     - Image for Microsoft Hyper-V\*
-   * - hyperv-mini.vhdx
-     - Minimal image with fewer bundles for Microsoft Hyper-V
-   * - installer.img
-     - Interactive installer image
-   * - installer.iso
-     - ISO of the interactive installer image
-   * - kvm.img
-     - Image for booting in a simple VM with start_qemu.sh
-   * - live.img
-     - Live boot image
-   * - vmware.vmdk
-     - Image for VMware\*
-
-.. _images: https://download.clearlinux.org/image
@@ -0,0 +1,77 @@
+.. _image-types:
+
+Clear Linux\* image types
+#######################
+
+.. _image-types-content:
+
+|CLOSIA| 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: GNU\* zip (*.gz*) and XZ (*.xz*).
+
+Table 1 lists the currently available images that are platform independent.
+Table 2 lists the currently available images that are platform specific.
+
+.. list-table:: Table 1: Types of platform-independent Clear Linux images
+   :widths: 15, 85
+   :header-rows: 1
+
+   * - Image Type
+     - Description
+
+   * - installer.img 
+     - Preferred image of Clear Linux with interactive installer. 
+
+   * - installer.iso
+     - ISO of Clear Linux with interactive installer. Only for special cases where ISO image format is required (not for use with a USB key)
+
+   * - live.img
+     - image for live booting into memory, without requiring installaton. 
+
+.. list-table:: Table 2: Types of platform-specific Clear Linux images
+   :widths: 15, 85
+   :header-rows: 1
+
+   * - Image Type
+     - Description
+
+   * - azure.vhd
+     - Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform
+
+   * - azure-docker.vhd
+     - Virtual Hard Disk for use on Microsoft Azure cloud platform with Docker\* pre-installed
+
+   * - azure-machine-learning.vhd
+     - Virtual Hard Disk for use on Microsoft Azure cloud platform with the `machine-learning-basic` bundle installed
+
+   * - cloud.img
+     - Image for use by cloud deployments such as OpenStack\*
+
+   * - containers.img
+     - Image for use by Clear Containers runtime. Includes `optimized kernel`_ for Clear Containers.
+
+   * - hyperv.vhdx
+     - Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes `optimized kernel`_ for Hyper-V.
+
+   * - kvm.img
+     - Image for booting in a simple VM with start_qemu.sh. Includes 
+       `optimized kernel`_ for KVM.
+
+   * - vmware.vmdk
+     - Virtual Machine Disk for VMware\* platforms inclduing Player, Workstation, and ESXi.
+
+.. _images: https://download.clearlinux.org/image
+.. _`optimized kernel`: https://clearlinux.org/documentation/clear-linux/reference/compatible-kernels
+