From 1e9b5ce1070a98bc4d48b59cd4d280457acff691 Mon Sep 17 00:00:00 2001 From: puneetse <22071208+puneetse@users.noreply.github.com> Date: Thu, 28 Jun 2018 10:51:48 -0700 Subject: [PATCH 1/6] Remove hyperv-mini image hyperv-mini image is being deprecated --- source/clear-linux/guides/maintenance/image-types.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/clear-linux/guides/maintenance/image-types.rst b/source/clear-linux/guides/maintenance/image-types.rst index e3a119f5..c0d6c1e6 100644 --- a/source/clear-linux/guides/maintenance/image-types.rst +++ b/source/clear-linux/guides/maintenance/image-types.rst @@ -42,8 +42,6 @@ Table 1 lists the currently available images. - 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 From 85e87d3b16af7b9c03907a76bad168fd3fd61c16 Mon Sep 17 00:00:00 2001 From: puneetse <22071208+puneetse@users.noreply.github.com> Date: Thu, 28 Jun 2018 11:24:29 -0700 Subject: [PATCH 2/6] Add preference to use IMG over ISO --- source/clear-linux/guides/maintenance/image-types.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/clear-linux/guides/maintenance/image-types.rst b/source/clear-linux/guides/maintenance/image-types.rst index c0d6c1e6..85b1d96a 100644 --- a/source/clear-linux/guides/maintenance/image-types.rst +++ b/source/clear-linux/guides/maintenance/image-types.rst @@ -42,10 +42,10 @@ Table 1 lists the currently available images. - Optimized image used by Clear Containers runtime * - hyperv.vhdx - Image for Microsoft Hyper-V\* - * - installer.img - - Interactive installer image + * - installer.img + - Preferred interactive installer image * - installer.iso - - ISO of the interactive installer image + - ISO of the interactive installer image. Only on special cases where ISO image format is required (not for use with a USB key) * - kvm.img - Image for booting in a simple VM with start_qemu.sh * - live.img From 353f967c3d675fe6f3afafb8680fac6d39cfced0 Mon Sep 17 00:00:00 2001 From: puneetse <22071208+puneetse@users.noreply.github.com> Date: Thu, 28 Jun 2018 12:20:33 -0700 Subject: [PATCH 3/6] More descriptive description and file readability Add some consistency to dscriptions, references to images with optimized kernels. --- .../guides/maintenance/image-types.rst | 36 ++++++++++++------- 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/source/clear-linux/guides/maintenance/image-types.rst b/source/clear-linux/guides/maintenance/image-types.rst index 85b1d96a..5653e763 100644 --- a/source/clear-linux/guides/maintenance/image-types.rst +++ b/source/clear-linux/guides/maintenance/image-types.rst @@ -29,28 +29,40 @@ Table 1 lists the currently available images. * - Image Type - Description + * - azure.vhd - - Image for Microsoft\* Azure\* + - Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform + * - azure-docker.vhd - - Image with Docker\* installed for Microsoft Azure + - Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform with Docker\* pre-installed + * - azure-machine-learning.vhd - - Image with the `machine-learning-basic` bundle installed for Microsoft - Azure + - Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform with the `machine-learning-basic` bundle installed + * - cloud.img - - Image for cloud deployment such as OpenStack\* + - Image for use by cloud deployments such as OpenStack\* + * - containers.img - - Optimized image used by Clear Containers runtime + - Image for use by Clear Containers runtime. Includes `optimized kernel`_ for Clear Containers. + * - hyperv.vhdx - - Image for Microsoft Hyper-V\* + - Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes `optimized kernel`_ for Hyper-V. + * - installer.img - - Preferred interactive installer image + - Preferred image of Clear Linux with interactive installer. + * - installer.iso - - ISO of the interactive installer image. Only on special cases where ISO image format is required (not for use with a USB key) + - ISO of Clear Linux with interactive installer. Only for special cases where ISO image format is required (not for use with a USB key) + * - kvm.img - - Image for booting in a simple VM with start_qemu.sh + - Image for booting in a simple VM with start_qemu.sh. Includes `optimized kernel`_ for KVM. + * - live.img - - Live boot image + - image for live booting into memory, without requiring installaton. + * - vmware.vmdk - - Image for VMware\* + - 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 + From 27273f7aeabf2272112a34cea8f91548ad05f2ba Mon Sep 17 00:00:00 2001 From: puneetse <22071208+puneetse@users.noreply.github.com> Date: Thu, 28 Jun 2018 12:32:24 -0700 Subject: [PATCH 4/6] Split table into 2 This helps understand the difference between images by catagorizingthem and highlights what users are most likely looking for. --- .../guides/maintenance/image-types.rst | 34 ++++++++++++------- 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/source/clear-linux/guides/maintenance/image-types.rst b/source/clear-linux/guides/maintenance/image-types.rst index 5653e763..d1cfcdab 100644 --- a/source/clear-linux/guides/maintenance/image-types.rst +++ b/source/clear-linux/guides/maintenance/image-types.rst @@ -21,10 +21,29 @@ 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. +Table 1 lists the currently available images which are platform independant. +Table 2 lists the currently available images which are platform specific. -.. list-table:: Table 1: Types of Clear Linux images - :widths: 20, 60 +.. list-table:: Table 1: Types of platform independant 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 @@ -48,18 +67,9 @@ Table 1 lists the currently available images. * - hyperv.vhdx - Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes `optimized kernel`_ for Hyper-V. - * - 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) - * - kvm.img - Image for booting in a simple VM with start_qemu.sh. Includes `optimized kernel`_ for KVM. - * - live.img - - image for live booting into memory, without requiring installaton. - * - vmware.vmdk - Virtual Machine Disk for VMware\* platforms inclduing Player, Workstation, and ESXi. From 053d57c682798b1b4c01f2769a5cc692b747af51 Mon Sep 17 00:00:00 2001 From: puneetse <22071208+puneetse@users.noreply.github.com> Date: Thu, 28 Jun 2018 12:35:44 -0700 Subject: [PATCH 5/6] Move image types document from guide to reference --- .../clear-linux/{guides/maintenance => reference}/image-types.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename source/clear-linux/{guides/maintenance => reference}/image-types.rst (100%) diff --git a/source/clear-linux/guides/maintenance/image-types.rst b/source/clear-linux/reference/image-types.rst similarity index 100% rename from source/clear-linux/guides/maintenance/image-types.rst rename to source/clear-linux/reference/image-types.rst From 5379715cf971e2a1e7b1fc68f57262119b98668e Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Fri, 29 Jun 2018 13:40:53 -0700 Subject: [PATCH 6/6] Corrects Sphinx syntax, spelling, and document formatting. Signed-off-by: Michael Vincerra --- source/clear-linux/reference/image-types.rst | 33 ++++++++++---------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/source/clear-linux/reference/image-types.rst b/source/clear-linux/reference/image-types.rst index d1cfcdab..25d375ef 100644 --- a/source/clear-linux/reference/image-types.rst +++ b/source/clear-linux/reference/image-types.rst @@ -1,6 +1,6 @@ .. _image-types: -Clear Linux image types +Clear Linux\* image types ####################### .. _image-types-content: @@ -9,22 +9,22 @@ Clear Linux image types The naming convention of a |CL| image filename is: - .. code-block:: console +.. code-block:: console - clear-[version number]-[image type].[compression type] + clear-[version number]-[image type].[compression type] -The *[version number]* field specifies the version number. +* The *[version number]* field specifies the version number. -The *[image type]* field specifies the type of image and its corresponding -file format. +* 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*). +* 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 which are platform independant. -Table 2 lists the currently available images which are platform specific. +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 independant Clear Linux images +.. list-table:: Table 1: Types of platform-independent Clear Linux images :widths: 15, 85 :header-rows: 1 @@ -40,9 +40,7 @@ Table 2 lists the currently available images which are platform specific. * - live.img - image for live booting into memory, without requiring installaton. - - -.. list-table:: Table 2: Types of platform specific Clear Linux images +.. list-table:: Table 2: Types of platform-specific Clear Linux images :widths: 15, 85 :header-rows: 1 @@ -53,10 +51,10 @@ Table 2 lists the currently available images which are platform specific. - 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 + - 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 + - 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\* @@ -68,7 +66,8 @@ Table 2 lists the currently available images which are platform specific. - 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. + - 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.