Add module for switching kernel to HWE
Related-Prod: PROD-30103
Change-Id: Ice332409f7876683109e5134f6ce3496b93e1152
(cherry-picked from commit 4e45a705926f31437a801d97853cb1ef718d012b)
diff --git a/README.rst b/README.rst
index ba61d01..8eac7b5 100644
--- a/README.rst
+++ b/README.rst
@@ -2781,6 +2781,72 @@
ip link set dev eth0 mtu 1400
+Switch Kernel from non-HWE to HWE
+==================================
+
+It is possible to switch Kernel from non-HWE to HWE by using module
+linux_kernel_switch. It has few methods:
+
+* check_hwe_kernel
+* switch_kernel
+* rollback_switch_kernel
+
+Method ``check_hwe_kernel`` allows to check whether HWE kernel installed
+or not:
+
+.. code-block:: bash
+
+ salt <target> linux_kernel_switch.check_hwe_kernel
+
+Output for case HWE is installed:
+
+.. code-bloc:: bash
+
+ kvm02.cluster-env.local:
+ ----------
+ linux-image-extra-virtual-hwe-16.04:
+ ----------
+ linux-image-extra-virtual-hwe-16.04:
+ ----------
+ architecture:
+ amd64
+ description:
+ Extra drivers for Virtual Linux kernel image
+ This package will always depend on linux-image-generic.
+ group:
+ kernel
+ install_date:
+ 2019-10-01T11:50:15Z
+ name:
+ linux-image-extra-virtual-hwe-16.04
+ packager:
+ Ubuntu Kernel Team <kernel-team@lists.ubuntu.com>
+ source:
+ linux-meta-hwe
+ version:
+ 4.15.0.54.75
+ ...
+
+Output for case HWE is not installed:
+
+.. code-bloc:: bash
+
+ kvm02.cluster-env.local:
+ ----------
+ linux-image-extra-virtual-hwe-16.04:
+ Not installed!
+ linux-image-generic-hwe-16.04:
+ Not installed!
+
+Method ``switch_kernel`` allows you to switch from non-HWE to HWE. It has
+two options: ``dry_run`` - to check what packages are going to be installed or
+removed and ``only_kernel`` - install only Kernel image packages without other
+HWE packages.
+
+Method ``rollback_switch_kernel`` allows you to rollback method
+``switch_kernel`` which was executed successfully previously. Option
+``dry_run`` - to check what packages are going to be installed/removed.
+
Read more
=========