From 345ba4a58c9ac21ee83a0bc4267996817174d508 Mon Sep 17 00:00:00 2001 From: Miguel Bernal Marin Date: Tue, 21 Mar 2017 13:29:40 -0600 Subject: [PATCH 1/8] adding clear linux kernel types description --- source/gs_clear-linux-kernels.rst | 66 +++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 source/gs_clear-linux-kernels.rst diff --git a/source/gs_clear-linux-kernels.rst b/source/gs_clear-linux-kernels.rst new file mode 100644 index 00000000..c27da455 --- /dev/null +++ b/source/gs_clear-linux-kernels.rst @@ -0,0 +1,66 @@ +.. _gs_clear-linux-kernels: + +|CL| kernels +############ + +|CLOSIA| has several Linux kernels distributed over several bundles. This +`bundles`_ has specific use case which are explained below. + +Kernel native +============= + +This bundle is focuses in the bare metal platform. It is optimized for +fast boot, and best performance in Intel architecture as described in the +:ref:`gs_supported_hardware`. You can find the optimization patches +in our `linux`_ GitHub* repo. + +Kernel LTS +========== + +This bundle is focuses in the bare metal platform and use the lattes +:abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for +fast boot, and best performance in Intel architecture as described in the +:ref:`gs_supported_hardware`. Also it includes the VirtualBox* kernel +modules (see :ref:`vm-virtualbox`). You can find the optimization patches +in our `linux-lts`_ GitHub* repo. + +Kernel KVM +============= + +This bundle is focuses on Linux :abbr:`KVM (Kernel-based Virtual Machine)`. +It is optimized for fast boot, and best performance in Virtual Machines +running on Intel architecture. It is used as the main Linux kernel from +**Cloud Instances** in projects as `CIAO`_ and OpenStack*, and as a +stand alone Linux VM (see :ref:`vm-kvm`). You can find the +optimization patches in our `linux-kvm`_ GitHub* repo. + +Kernel Hyper-V* +=============== + +This bundle is focuses on running Linux on Microsoft* Hyper-V*. +It is optimized for fast boot, and best performance in Virtual Machines +running on Intel architecture. It is used as the main Linux kernel from +**Cloud Instances** in projects as Microsoft `Azure`_\*, and as a +stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the +optimization patches in our `linux-hyperv`_ GitHub* repo. + +Kernel Hyper-V* LTS +=================== + +This bundle is focuses on running Linux on Microsoft* Hyper-V* and use the +lattes :abbr:`LTS (Long Term Support)` Linux kernel. +It is optimized for fast boot, and best performance in Virtual Machines +running on Intel architecture. It is used as the main Linux kernel from +**Cloud Instances** in projects as Microsoft `Azure`_\*, and as a +stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the +optimization patches in our `linux-hyperv-lts`_ GitHub* repo. + +.. _linux: https://github.com/clearlinux-pkgs/linux +.. _linux-lts: https://github.com/clearlinux-pkgs/linux-lts +.. _linux-kvm: https://github.com/clearlinux-pkgs/linux-kvm +.. _linux-hyperv: https://github.com/clearlinux-pkgs/linux-hyperv +.. _linux-hyperv-lts: https://github.com/clearlinux-pkgs/linux-hyperv-lts +.. _bundles: https://github.com/clearlinux/clr-bundles +.. _CIAO: https://github.com/01org/ciao +.. _Azure: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/clear-linux-project.clear-linux-os + From d10af2b7cc19662ee80cd375d121abfad9ce010f Mon Sep 17 00:00:00 2001 From: Miguel Bernal Marin Date: Tue, 21 Mar 2017 13:30:24 -0600 Subject: [PATCH 2/8] add clr kernels to index --- source/index_gs.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/index_gs.rst b/source/index_gs.rst index 409e2c0e..178de866 100644 --- a/source/index_gs.rst +++ b/source/index_gs.rst @@ -8,5 +8,6 @@ Getting started gs_supported_hardware gs_creating_bootable_usb gs_installing_clr_as_host + gs_clear-linux-kernels From 5de438e3893680182dd203e974c3e1c6fe96a14b Mon Sep 17 00:00:00 2001 From: Miguel Bernal Marin Date: Thu, 23 Mar 2017 15:15:27 -0600 Subject: [PATCH 3/8] CLR kernels: add supported HW to VMs --- source/gs_clear-linux-kernels.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/gs_clear-linux-kernels.rst b/source/gs_clear-linux-kernels.rst index c27da455..d085c549 100644 --- a/source/gs_clear-linux-kernels.rst +++ b/source/gs_clear-linux-kernels.rst @@ -29,8 +29,8 @@ Kernel KVM This bundle is focuses on Linux :abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast boot, and best performance in Virtual Machines -running on Intel architecture. It is used as the main Linux kernel from -**Cloud Instances** in projects as `CIAO`_ and OpenStack*, and as a +running on the :ref:`gs_supported_hardware`.It is used as the main Linux +kernel from **Cloud Instances** in projects as `CIAO`_ and OpenStack*, and as a stand alone Linux VM (see :ref:`vm-kvm`). You can find the optimization patches in our `linux-kvm`_ GitHub* repo. @@ -39,8 +39,8 @@ Kernel Hyper-V* This bundle is focuses on running Linux on Microsoft* Hyper-V*. It is optimized for fast boot, and best performance in Virtual Machines -running on Intel architecture. It is used as the main Linux kernel from -**Cloud Instances** in projects as Microsoft `Azure`_\*, and as a +running on the :ref:`gs_supported_hardware`.It is used as the main Linux +kernel from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the optimization patches in our `linux-hyperv`_ GitHub* repo. @@ -50,8 +50,8 @@ Kernel Hyper-V* LTS This bundle is focuses on running Linux on Microsoft* Hyper-V* and use the lattes :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast boot, and best performance in Virtual Machines -running on Intel architecture. It is used as the main Linux kernel from -**Cloud Instances** in projects as Microsoft `Azure`_\*, and as a +running on the :ref:`gs_supported_hardware`.It is used as the main Linux +kernel from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the optimization patches in our `linux-hyperv-lts`_ GitHub* repo. From b386a59d64f3a9e9ecfa1134b5523e4e6e4672ce Mon Sep 17 00:00:00 2001 From: Miguel Bernal Marin Date: Thu, 23 Mar 2017 15:33:28 -0600 Subject: [PATCH 4/8] fix KVM explanation and Hyper-V --- source/gs_clear-linux-kernels.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/source/gs_clear-linux-kernels.rst b/source/gs_clear-linux-kernels.rst index d085c549..62a54804 100644 --- a/source/gs_clear-linux-kernels.rst +++ b/source/gs_clear-linux-kernels.rst @@ -29,8 +29,11 @@ Kernel KVM This bundle is focuses on Linux :abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast boot, and best performance in Virtual Machines -running on the :ref:`gs_supported_hardware`.It is used as the main Linux -kernel from **Cloud Instances** in projects as `CIAO`_ and OpenStack*, and as a +running on the :ref:`gs_supported_hardware`. +It is the preferred kernel when running |CL| as the guest OS +on top of *qemu/kvm* or through **cloud orchestrators** which +internally use *qemu/kvm* as the **hypervisor**. +Also it can be used as a stand alone Linux VM (see :ref:`vm-kvm`). You can find the optimization patches in our `linux-kvm`_ GitHub* repo. @@ -39,8 +42,9 @@ Kernel Hyper-V* This bundle is focuses on running Linux on Microsoft* Hyper-V*. It is optimized for fast boot, and best performance in Virtual Machines -running on the :ref:`gs_supported_hardware`.It is used as the main Linux -kernel from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a +running on the :ref:`gs_supported_hardware`. +It is the preferred kernel when running |CL| as the guest OS +from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the optimization patches in our `linux-hyperv`_ GitHub* repo. @@ -50,8 +54,9 @@ Kernel Hyper-V* LTS This bundle is focuses on running Linux on Microsoft* Hyper-V* and use the lattes :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast boot, and best performance in Virtual Machines -running on the :ref:`gs_supported_hardware`.It is used as the main Linux -kernel from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a +running on the :ref:`gs_supported_hardware`. +It is the preferred kernel when running |CL| as the guest OS +from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the optimization patches in our `linux-hyperv-lts`_ GitHub* repo. From fcdf7d7c5aa48c9487b797773e7eaa76e6c4a57a Mon Sep 17 00:00:00 2001 From: Rodrigo Caballero Date: Thu, 23 Mar 2017 17:08:46 -0600 Subject: [PATCH 5/8] Edit grammar, spelling, sentence structure, tone, style, and trademarks. Performed an edit ensuring parallel content structures, a consistent tone and style, good grammar and spelling, and trademark references only on the first instance. Added the name of the bundle at the begining of each paragraph in the exact form users need to put in the commands, thus providing a better user experience. Lastly, I fixed capitalization issues with the links. Although the GitHub repos are named in lower case, that does not mean the links' text should be in lower case too. Signed-off-by: Rodrigo Caballero --- source/gs_clear-linux-kernels.rst | 99 +++++++++++++++++-------------- 1 file changed, 53 insertions(+), 46 deletions(-) diff --git a/source/gs_clear-linux-kernels.rst b/source/gs_clear-linux-kernels.rst index 62a54804..e9644435 100644 --- a/source/gs_clear-linux-kernels.rst +++ b/source/gs_clear-linux-kernels.rst @@ -3,69 +3,76 @@ |CL| kernels ############ -|CLOSIA| has several Linux kernels distributed over several bundles. This -`bundles`_ has specific use case which are explained below. +The |CLOSIA| provides several Linux kernels distributed over several bundles. +These `bundles`_ serve the following specific use cases. Kernel native ============= -This bundle is focuses in the bare metal platform. It is optimized for -fast boot, and best performance in Intel architecture as described in the -:ref:`gs_supported_hardware`. You can find the optimization patches -in our `linux`_ GitHub* repo. +The ``kernel-native`` bundle focuses on the bare metal platforms. It is +optimized for fast booting and performs best on the Intel® architectures +described on the :ref:`supported hardware list`. The +optimization patches are found in our `Linux`_ GitHub\* repo. Kernel LTS ========== -This bundle is focuses in the bare metal platform and use the lattes -:abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for -fast boot, and best performance in Intel architecture as described in the -:ref:`gs_supported_hardware`. Also it includes the VirtualBox* kernel -modules (see :ref:`vm-virtualbox`). You can find the optimization patches -in our `linux-lts`_ GitHub* repo. +The ``kernel-lts`` bundle focuses on the bare metal platforms but uses the +latest :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast +booting and performs best on the Intel® architectures described on the +:ref:`supported hardware list`. Additionally, this +kernel includes the VirtualBox\* kernel modules, see our +:ref:`instructions on using Virtualbox` for more information. +The optimization patches are found in our `Linux-LTS`_ GitHub repo. Kernel KVM ============= -This bundle is focuses on Linux :abbr:`KVM (Kernel-based Virtual Machine)`. -It is optimized for fast boot, and best performance in Virtual Machines -running on the :ref:`gs_supported_hardware`. -It is the preferred kernel when running |CL| as the guest OS -on top of *qemu/kvm* or through **cloud orchestrators** which -internally use *qemu/kvm* as the **hypervisor**. -Also it can be used as a -stand alone Linux VM (see :ref:`vm-kvm`). You can find the -optimization patches in our `linux-kvm`_ GitHub* repo. +The ``kernel-kvm`` bundle focuses on the Linux +:abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast booting +and performs best on Virtual Machines running on the Intel® architectures +described on the :ref:`supported hardware list`. +Use this kernel when running |CL| as the guest OS +on top of *qemu/kvm*. Use this kernel with **cloud orchestrators** using +*qemu/kvm* internally as their **hypervisor**. +This kernel can be used as a stand alone Linux VM, see our +:ref:`instructions on using KVM` for more information. The +optimization patches are found in our `Linux-KVM`_ GitHub repo. -Kernel Hyper-V* -=============== +Kernel Hyper-V\* +================ -This bundle is focuses on running Linux on Microsoft* Hyper-V*. -It is optimized for fast boot, and best performance in Virtual Machines -running on the :ref:`gs_supported_hardware`. -It is the preferred kernel when running |CL| as the guest OS -from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a -stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the -optimization patches in our `linux-hyperv`_ GitHub* repo. +The ``kernel-hyperv`` bundle focuses on running Linux on Microsoft\* +Hyper-V. It is optimized for fast booting and performs best on Virtual +Machines running on the Intel® architectures described on the +:ref:`supported hardware list`. +Use this kernel when running |CL| as the guest OS of **Cloud Instances** in +projects such as Microsoft `Azure`_\*. This kernel can be used as a stand +alone Linux VM, see our :ref:`instructions on using Hyper-V` for +more information. The optimization patches are found in our `Linux-HyperV`_ +GitHub repo. -Kernel Hyper-V* LTS -=================== +Kernel Hyper-V LTS +==================== -This bundle is focuses on running Linux on Microsoft* Hyper-V* and use the -lattes :abbr:`LTS (Long Term Support)` Linux kernel. -It is optimized for fast boot, and best performance in Virtual Machines -running on the :ref:`gs_supported_hardware`. -It is the preferred kernel when running |CL| as the guest OS -from **Cloud Instances** in projects as Microsoft `Azure`_\*, and as a -stand alone Linux VM (see :ref:`vm-hyper-v`). You can find the -optimization patches in our `linux-hyperv-lts`_ GitHub* repo. +The ``kernel-hyperv-lts`` bundle focuses on running Linux on Microsoft +Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel. It +is optimized for fast booting and performs best on Virtual +Machines running on the Intel® architectures described on the +:ref:`supported hardware list`. +Use this kernel when running |CL| as the guest OS of **Cloud Instances** in +projects such as Microsoft `Azure`_. This kernel can be used as a stand +alone Linux VM, see our :ref:`instructions on using Hyper-V` for +more information. The optimization patches are found in our +`Linux-HyperV-LTS`_ GitHub repo. -.. _linux: https://github.com/clearlinux-pkgs/linux -.. _linux-lts: https://github.com/clearlinux-pkgs/linux-lts -.. _linux-kvm: https://github.com/clearlinux-pkgs/linux-kvm -.. _linux-hyperv: https://github.com/clearlinux-pkgs/linux-hyperv -.. _linux-hyperv-lts: https://github.com/clearlinux-pkgs/linux-hyperv-lts +.. _Linux: https://github.com/clearlinux-pkgs/linux +.. _Linux-LTS: https://github.com/clearlinux-pkgs/linux-lts +.. _Linux-KVM: https://github.com/clearlinux-pkgs/linux-kvm +.. _Linux-HyperV: https://github.com/clearlinux-pkgs/linux-hyperv +.. _Linux-HyperV-LTS: https://github.com/clearlinux-pkgs/linux-hyperv-lts .. _bundles: https://github.com/clearlinux/clr-bundles .. _CIAO: https://github.com/01org/ciao -.. _Azure: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/clear-linux-project.clear-linux-os +.. _Azure: + https://azuremarketplace.microsoft.com/en-us/marketplace/apps/clear-linux-project.clear-linux-os From baaaae3f60a20775b1d6f2594157c2f3aeb1ba3f Mon Sep 17 00:00:00 2001 From: Miguel Bernal Marin Date: Mon, 3 Apr 2017 16:04:18 -0500 Subject: [PATCH 6/8] add kernel containers description --- source/gs_clear-linux-kernels.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/source/gs_clear-linux-kernels.rst b/source/gs_clear-linux-kernels.rst index e9644435..2e9fc7cf 100644 --- a/source/gs_clear-linux-kernels.rst +++ b/source/gs_clear-linux-kernels.rst @@ -26,7 +26,7 @@ kernel includes the VirtualBox\* kernel modules, see our The optimization patches are found in our `Linux-LTS`_ GitHub repo. Kernel KVM -============= +========== The ``kernel-kvm`` bundle focuses on the Linux :abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast booting @@ -53,7 +53,7 @@ more information. The optimization patches are found in our `Linux-HyperV`_ GitHub repo. Kernel Hyper-V LTS -==================== +================== The ``kernel-hyperv-lts`` bundle focuses on running Linux on Microsoft Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel. It @@ -66,11 +66,22 @@ alone Linux VM, see our :ref:`instructions on using Hyper-V` for more information. The optimization patches are found in our `Linux-HyperV-LTS`_ GitHub repo. +Kernel Container +================ + +The ``kernel-container`` bundle contains the kernel used by +`Intel® Clear Containers `_ +project on |CL|. This kernel is optimized for fast booting +and performs best on |CC| running on the Intel® architectures described on the +:ref:`supported hardware list`. +The optimization patches are found in our `Linux-Container`_ GitHub repo. + .. _Linux: https://github.com/clearlinux-pkgs/linux .. _Linux-LTS: https://github.com/clearlinux-pkgs/linux-lts .. _Linux-KVM: https://github.com/clearlinux-pkgs/linux-kvm .. _Linux-HyperV: https://github.com/clearlinux-pkgs/linux-hyperv .. _Linux-HyperV-LTS: https://github.com/clearlinux-pkgs/linux-hyperv-lts +.. _Linux-Container: https://github.com/clearlinux-pkgs/linux-container .. _bundles: https://github.com/clearlinux/clr-bundles .. _CIAO: https://github.com/01org/ciao .. _Azure: From f644c9b962b19b6fdc7a5483fda0dbcf5da72451 Mon Sep 17 00:00:00 2001 From: Rodrigo Caballero Date: Thu, 6 Apr 2017 11:14:51 -0500 Subject: [PATCH 7/8] Fixed missing articles and in-line link. Signed-off-by: Rodrigo Caballero --- source/gs_clear-linux-kernels.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/gs_clear-linux-kernels.rst b/source/gs_clear-linux-kernels.rst index 2e9fc7cf..0fbe0a1a 100644 --- a/source/gs_clear-linux-kernels.rst +++ b/source/gs_clear-linux-kernels.rst @@ -69,11 +69,10 @@ more information. The optimization patches are found in our Kernel Container ================ -The ``kernel-container`` bundle contains the kernel used by -`Intel® Clear Containers `_ -project on |CL|. This kernel is optimized for fast booting -and performs best on |CC| running on the Intel® architectures described on the -:ref:`supported hardware list`. +The ``kernel-container`` bundle contains the kernel used by the +`Intel® Clear Containers`_ project on |CL|. This kernel is optimized for +fast booting and performs best on |CC| running on the Intel® architectures +described on the :ref:`supported hardware list`. The optimization patches are found in our `Linux-Container`_ GitHub repo. .. _Linux: https://github.com/clearlinux-pkgs/linux @@ -86,4 +85,5 @@ The optimization patches are found in our `Linux-Container`_ GitHub repo. .. _CIAO: https://github.com/01org/ciao .. _Azure: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/clear-linux-project.clear-linux-os - +.. _Intel® Clear Containers: + https://clearlinux.org/features/intel®-clear-containers From ef7cafca9ea9b2f933ea9ff36f8a91ab7e6ed559 Mon Sep 17 00:00:00 2001 From: Rodrigo Caballero Date: Thu, 6 Apr 2017 11:18:15 -0500 Subject: [PATCH 8/8] Change emphasis for bundles name to avoid CSS problems. Signed-off-by: Rodrigo Caballero --- source/gs_clear-linux-kernels.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/gs_clear-linux-kernels.rst b/source/gs_clear-linux-kernels.rst index 0fbe0a1a..f369ed86 100644 --- a/source/gs_clear-linux-kernels.rst +++ b/source/gs_clear-linux-kernels.rst @@ -9,7 +9,7 @@ These `bundles`_ serve the following specific use cases. Kernel native ============= -The ``kernel-native`` bundle focuses on the bare metal platforms. It is +The *kernel-native* bundle focuses on the bare metal platforms. It is optimized for fast booting and performs best on the Intel® architectures described on the :ref:`supported hardware list`. The optimization patches are found in our `Linux`_ GitHub\* repo. @@ -17,7 +17,7 @@ optimization patches are found in our `Linux`_ GitHub\* repo. Kernel LTS ========== -The ``kernel-lts`` bundle focuses on the bare metal platforms but uses the +The *kernel-lts* bundle focuses on the bare metal platforms but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast booting and performs best on the Intel® architectures described on the :ref:`supported hardware list`. Additionally, this @@ -28,7 +28,7 @@ The optimization patches are found in our `Linux-LTS`_ GitHub repo. Kernel KVM ========== -The ``kernel-kvm`` bundle focuses on the Linux +The *kernel-kvm* bundle focuses on the Linux :abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast booting and performs best on Virtual Machines running on the Intel® architectures described on the :ref:`supported hardware list`. @@ -42,7 +42,7 @@ optimization patches are found in our `Linux-KVM`_ GitHub repo. Kernel Hyper-V\* ================ -The ``kernel-hyperv`` bundle focuses on running Linux on Microsoft\* +The *kernel-hyperv* bundle focuses on running Linux on Microsoft\* Hyper-V. It is optimized for fast booting and performs best on Virtual Machines running on the Intel® architectures described on the :ref:`supported hardware list`. @@ -55,7 +55,7 @@ GitHub repo. Kernel Hyper-V LTS ================== -The ``kernel-hyperv-lts`` bundle focuses on running Linux on Microsoft +The *kernel-hyperv-lts* bundle focuses on running Linux on Microsoft Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast booting and performs best on Virtual Machines running on the Intel® architectures described on the @@ -69,7 +69,7 @@ more information. The optimization patches are found in our Kernel Container ================ -The ``kernel-container`` bundle contains the kernel used by the +The *kernel-container* bundle contains the kernel used by the `Intel® Clear Containers`_ project on |CL|. This kernel is optimized for fast booting and performs best on |CC| running on the Intel® architectures described on the :ref:`supported hardware list`.