[spp] [PATCH 2/2] doc: Improve document under spp_vf directory

[x-fn-spp@sl.ntt-tx.co.jp]

From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>

    - Add detail about where to edit using virsh edit command in build.rst
    - Change command in Trouble Shooting Guide in build.rst
    - Additional note when registering MAC address to classfier in usecase1.rst

Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <takada.naoki@lab.ntt.co.jp>
---
 docs/guides/spp_vf/gsg/build.rst          | 49 ++++++++++++++++++++++++++-----
 docs/guides/spp_vf/use_cases/usecase1.rst |  9 ++++++
 2 files changed, 50 insertions(+), 8 deletions(-)

diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index 52611dc..1a8e114 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -30,7 +30,7 @@
 
 .. _spp_vf_gsg_build:
 
-Build
+Setup
 =====
 
 Environment
@@ -165,6 +165,32 @@ Then, bind it with PCI_Number.
 
 virsh setup
 -----------
+.. note::
+
+    This document assumes that VM is already installed. If not please follow the instruction below and install the VM.
+
+.. code-block:: console
+
+   virt-install \
+   --name ${VMNAME} \
+   --ram 4096 \
+   --disk path=/var/lib/libvirt/images/${VMNAME}.img,size=30 \
+   --vcpus 4 \
+   --os-type linux \
+   --os-variant ubuntu16.04 \
+   --network network=default \
+   --graphics none \
+   --console pty,target_type=serial \
+   --location 'http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/' \
+   --extra-args 'console=ttyS0,115200n8 serial'
+
+You may need type the following commands through ssh to activate console.
+
+.. code-block:: console
+
+    $sudo systemctl enable serial-getty@ttyS0.service
+    $sudo systemctl start serial-getty@ttyS0.service
+
 
 Edit VM configuration with virsh.
 
@@ -172,6 +198,13 @@ Edit VM configuration with virsh.
 
     $ virsh edit [VM_NAME]
 
+You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` into the domain tag because of adding ``<qemu:commandline>`` tag.
+In addition, you need to add the tag enclosed by ``<memoryBacking>`` and ``</memoryBacking>``, ``<qemu:commandline>`` and ``</qemu:commandline>`` because SPP uses vhost-user as interface with VM.
+Note that number used in those tags should be the same value (e.g. chr0,sock0,vhost-net0) and these values should correspond to "add vhost N" (in this example 0).
+MAC address used in ``<qemu:arg value='virtio-net-pci,netdev=vhost-net0,mac=52:54:00:12:34:56'/>`` can be specified when registering MAC address to classifier using Secondary command.
+
+        The following is an example of modified xml file:
+
 .. code-block:: xml
 
     <domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'>
@@ -266,13 +299,13 @@ In this case, you should try it.
 
 .. code-block:: console
 
-    $ sudo ln -s /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper /etc/apparmor.d/disable/usr.lib.libvirt.virt-aa-helper
-    $ sudo ln -s /etc/apparmor.d/usr.sbin.libvirtd /etc/apparmor.d/disable/usr.sbin.libvirtd
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.lib.libvirt.virt-aa-helper
-    $ sudo apparmor_parser -R /etc/apparmor.d/usr.sbin.libvirtd
-    $ sudo service apparmor reload
-    $ sudo service apparmor restart
-    $ sudo service libvirt-bin restart
+    #Edit /etc/libvirt/qemu.conf and set security_driver to none:
+    $sudo vi /etc/libvirt/qemu.conf
+    ...
+    security_driver = "none"
+    ...
+    #Restart libvirtd:
+    $sudo systemctl restart libvirtd.service
 
 Or, you remove appamor.
 
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index b5256e5..6a4f62f 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -186,6 +186,10 @@ In this usecase, you need to register two MAC addresses for merger1.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:56 ring:0
     spp > sec 1;classifier_table add mac 52:54:00:12:34:58 ring:1
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
 
 Configuration for the second login path is almost similar to the first
 path.
@@ -234,6 +238,11 @@ Register entries to classifier_table for classifier2.
     spp > sec 1;classifier_table add mac 52:54:00:12:34:57 ring:4
     spp > sec 1;classifier_table add mac 52:54:00:12:34:59 ring:5
 
+.. note::
+
+    Please verify that MAC address of target VM is specified in
+    [MACADDRESS] parameter.
+
 Finally, activate all of settings by doign `flush` subcommand.
 
 .. code-block:: console
-- 
1.9.1