From 17f6344ce2332762ac14f37ec4f84c38a5222f99 Mon Sep 17 00:00:00 2001
From: lirui34 <ruix.li@intel.com>
Date: Fri, 29 Nov 2019 02:33:46 +0000
Subject: [PATCH] doc: Add tutorial about how to launch kata vm.

Signed-off-by: lirui34 <ruix.li@intel.com>
---
 doc/develop.rst                       |  1 +
 doc/tutorials/run_kata_containers.rst | 47 +++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)
 create mode 100644 doc/tutorials/run_kata_containers.rst

diff --git a/doc/develop.rst b/doc/develop.rst
index d85edb579..953a2c3b3 100644
--- a/doc/develop.rst
+++ b/doc/develop.rst
@@ -32,6 +32,7 @@ Configuration Tutorials
    tutorials/enable_laag_secure_boot
    tutorials/building_acrn_in_docker
    tutorials/acrn_ootb
+   tutorials/run_kata_containers
 
 User VM Tutorials
 *****************
diff --git a/doc/tutorials/run_kata_containers.rst b/doc/tutorials/run_kata_containers.rst
new file mode 100644
index 000000000..3bffd147c
--- /dev/null
+++ b/doc/tutorials/run_kata_containers.rst
@@ -0,0 +1,47 @@
+.. _run-kata-containers:
+
+How to run Kata containers on Service VM
+########################################
+
+This tutorial describes how to install, configure and run Kata containers on
+ACRN Service VM.
+
+Pre-requisites
+**************
+
+.. _kata prerequisites:
+   https://github.com/kata-containers/documentation/blob/master/how-to/how-to-use-kata-containers-with-acrn.md#pre-requisites
+
+#. :ref:`ACRN supported hardware <hardware>`.
+#. For default prebuilt ACRN binary in E2E package, You need have 4 CPUs cores or enable "CPU Hyper-Threading”
+   to have 4 CPU Thread for 2 CPU cores.
+#. Follow this :ref:`instruction <quick-setup-guide>` to set up the ACRN Service VM.
+#. Build ACRN kernel to enable ``macvtap`` function.
+
+   .. 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/
+
+   Login Service VM, use the new ACRN kernel:
+
+   .. code-block:: none
+
+      $ sudo mount /dev/sda1 /mnt
+      $ sudo scp -r <user name>@<host address>:<your workspace>/acrn-kernel/arch/x86/boot/bzImage /mnt/
+      $ sudo scp -r <user name>@<host address>:<your workspace>/acrn-kernel/out/lib/modules/* /lib/modules/
+      $ 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
+
+Configure Kata on ACRN
+**********************
+
+Now you can follow this `kata instruction
+<https://github.com/kata-containers/documentation/blob/master/how-to/how-to-use-kata-containers-with-acrn.md>`_
+to configure and launch the Kata VMs with ACRN.