From e25a2bf80c607ffc429662f718a98acace5669fe Mon Sep 17 00:00:00 2001
From: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Date: Fri, 27 Dec 2019 13:44:28 +0100
Subject: [PATCH] doc: add more details to the Kata Containers with ACRN
 tutorial

* Add more details about Kata Containers and ACRN in the introduction
* Adjust and correct some of the instructions

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
---
 doc/tutorials/run_kata_containers.rst | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

diff --git a/doc/tutorials/run_kata_containers.rst b/doc/tutorials/run_kata_containers.rst
index 7eb60cb8f..7e7ba488c 100644
--- a/doc/tutorials/run_kata_containers.rst
+++ b/doc/tutorials/run_kata_containers.rst
@@ -1,10 +1,15 @@
 .. _run-kata-containers:
 
-Run Kata containers on a Service VM
+Run Kata Containers on a Service VM
 ###################################
 
-This tutorial describes how to install, configure, and run Kata containers on
-the ACRN Service VM.
+This tutorial describes how to install, configure, and run `Kata Containers
+<https://katacontainers.io/>`_ on the ACRN Service VM. In this configuration,
+Kata Containers leverage the ACRN hypervisor instead of QEMU which is used by
+default. Refer to the `Kata Containers with ACRN
+<https://drive.google.com/file/d/1ZrqM5ouWUJA0FeIWhU_aitEJe8781rpe/view?usp=sharing>`_
+presentation from a previous ACRN Project Technical Community Meeting for more
+details on Kata Containers and how the integration with ACRN has been done.
 
 Pre-Requisites
 **************
@@ -15,16 +20,14 @@ Pre-Requisites
 #. Refer to the :ref:`ACRN supported hardware <hardware>`.
 #. For a default prebuilt ACRN binary in the E2E package, you must have 4 CPU cores or enable "CPU Hyper-Threading” in order to have 4 CPU threads for 2 CPU cores.
 #. Follow :ref:`these instructions <quick-setup-guide>` to set up the ACRN Service VM.
-#. Build the ACRN kernel to enable the ``macvtap`` function:
+#. Build the ACRN kernel (required to support ``macvtap``, enabled by default since `247a3ba9243b <https://github.com/projectacrn/acrn-kernel/commit/247a3ba9243b1fd8c2d763158d55f8791a9cac94>`_)
 
    .. code-block:: none
 
       $ git clone https://github.com/projectacrn/acrn-kernel.git
       $ cd acrn-kernel
       $ cp kernel_config_sos .config
-      $ sed -i "s/# CONFIG_MACVLAN is not set/CONFIG_MACVLAN=y/" .config
-      $ sed -i '$ i CONFIG_MACVTAP=y' .config
-      $ make clean && make olddefconfig && make && sudo make modules_install INSTALL_MOD_PATH=out/
+      $ make clean && make olddefconfig && make && make modules_install INSTALL_MOD_PATH=out/
 
    Log in to the Service VM and use the new ACRN kernel:
 
@@ -36,7 +39,10 @@ Pre-Requisites
       $ conf_file=`sed -n '$ s/default //p' /mnt/loader/loader.conf`.conf
       $ kernel_img=`sed -n 2p /mnt/loader/entries/$conf_file | cut -d'/' -f4`
       $ sed -i "s/$kernel_img/bzImage/g" /mnt/loader/entries/$conf_file
-      $ sync && umount /mnt && sudo reboot
+      $ sync && sudo umount /mnt && reboot
+
+  .. note::
+     Adjust the EFI System Partition (ESP) device node (``/dev/sda1`` in the example above) to match your system setup.
 
 Configure Kata on ACRN
 **********************