* [spp] [PATCH 1/2] doc: Fix document error under spp_vf directory
[not found] <1525844601-26319-1-git-send-email-x-fn-spp@sl.ntt-tx.co.jp>
@ 2018-05-09 5:45 ` x-fn-spp
2018-05-24 12:47 ` Ferruh Yigit
2018-05-09 5:45 ` [spp] [PATCH 2/2] doc: Improve document " x-fn-spp
1 sibling, 1 reply; 4+ messages in thread
From: x-fn-spp @ 2018-05-09 5:45 UTC (permalink / raw)
To: spp
From: Hideyuki-Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
- Fix typo in build.rst
- Fix typo and error 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 | 4 +-
docs/guides/spp_vf/use_cases/usecase1.rst | 80 +++++++++++++++----------------
2 files changed, 41 insertions(+), 43 deletions(-)
diff --git a/docs/guides/spp_vf/gsg/build.rst b/docs/guides/spp_vf/gsg/build.rst
index a37f86a..52611dc 100644
--- a/docs/guides/spp_vf/gsg/build.rst
+++ b/docs/guides/spp_vf/gsg/build.rst
@@ -79,7 +79,7 @@ You need to run ``update-grub`` and reboot to activate grub config.
.. code-block:: console
- $ sudo upadte-grub
+ $ sudo update-grub
$ sudo reboot
@@ -101,7 +101,7 @@ You can check hugepage settings as following.
hugetlbfs-kvm on /run/hugepages/kvm type hugetlbfs (rw,relatime,mode=775,gid=117)
hugetlb on /run/lxcfs/controllers/hugetlb type cgroup (rw,relatime,hugetlb,release_agent=/run/cgmanager/agents/cgm-release-agent.hugetlb,nsroot=/)
-Finally, you unmount default hugepage.
+Finally, you umount default hugepage.
.. code-block:: console
diff --git a/docs/guides/spp_vf/use_cases/usecase1.rst b/docs/guides/spp_vf/use_cases/usecase1.rst
index 080aba1..b5256e5 100644
--- a/docs/guides/spp_vf/use_cases/usecase1.rst
+++ b/docs/guides/spp_vf/use_cases/usecase1.rst
@@ -82,7 +82,7 @@ After ``spp_primary`` is launched, run secondary process ``spp_vf``.
.. code-block:: console
$ sudo ./src/vf/x86_64-native-linuxapp-gcc/spp_vf \
- -c 0x00fe -n 4 --proc-type=secondary \
+ -c 0x3ffd -n 4 --proc-type=secondary \
-- \
--client-id 1 \
-s 127.0.0.1:6666 \
@@ -156,14 +156,14 @@ merger has two rx ports.
spp > sec 1;port add ring:0 rx forwarder1
spp > sec 1;port add vhost:0 tx forwarder1
# forwarder2
- spp > sec 1;port add vhost:0 rx forwarder2
- spp > sec 1;port add ring:2 tx forwarder2
+ spp > sec 1;port add ring:1 rx forwarder2
+ spp > sec 1;port add vhost:2 tx forwarder2
# forwarder3
- spp > sec 1;port add ring:1 rx forwarder3
- spp > sec 1;port add vhost:2 rx forwarder3
+ spp > sec 1;port add vhost:0 rx forwarder3
+ spp > sec 1;port add ring:2 tx forwarder3
# forwarder4
- spp > sec 1;port add vhost:2 tx forwarder4
- spp > sec 1;port add ring:3 rx forwarder4
+ spp > sec 1;port add vhost:2 rx forwarder4
+ spp > sec 1;port add ring:3 tx forwarder4
# merger1
spp > sec 1;port add ring:2 rx merger1
spp > sec 1;port add ring:3 rx merger1
@@ -213,14 +213,14 @@ Add ports to each of components.
spp > sec 1;port add ring:4 rx forwarder5
spp > sec 1;port add vhost:1 tx forwarder5
# forwarder6
- spp > sec 1;port add vhost:1 rx forwarder6
- spp > sec 1;port add ring:6 tx forwarder6
+ spp > sec 1;port add ring:5 rx forwarder6
+ spp > sec 1;port add vhost:3 tx forwarder6
# forwarder7
- spp > sec 1;port add ring:5 rx forwarder7
- spp > sec 1;port add vhost:3 rx forwarder7
+ spp > sec 1;port add vhost:1 rx forwarder7
+ spp > sec 1;port add ring:6 tx forwarder7
# forwarder8
- spp > sec 1;port add vhost:3 tx forwarder8
- spp > sec 1;port add ring:7 rx forwarder8
+ spp > sec 1;port add vhost:3 rx forwarder8
+ spp > sec 1;port add ring:7 tx forwarder8
# merger2
spp > sec 1;port add ring:6 rx merger2
spp > sec 1;port add ring:7 rx merger2
@@ -287,8 +287,6 @@ Configurations also for ``spp-vm2`` as ``spp-vm1``.
.. code-block:: console
- $ ssh -oStrictHostKeyChecking=no sppuser@192.168.122.32
-
# up interfaces
$ sudo ifconfig ens4 inet 192.168.140.31 netmask 255.255.255.0 up
$ sudo ifconfig ens5 inet 192.168.150.32 netmask 255.255.255.0 up
@@ -340,21 +338,21 @@ for the first SSH login path.
spp > sec 1;port del ring:0 tx classifier1
spp > sec 1;port del ring:1 tx classifier1
# forwarder1
- spp > sec 1;port del ring:0 rx forward1
- spp > sec 1;port del vhost:0 tx forward1
+ spp > sec 1;port del ring:0 rx forwarder1
+ spp > sec 1;port del vhost:0 tx forwarder1
# forwarder2
- spp > sec 1;port del vhost:0 rx forward2
- spp > sec 1;port del ring:2 tx forward2
+ spp > sec 1;port del ring:1 rx forwarder2
+ spp > sec 1;port del vhost:2 tx forwarder2
# forwarder3
- spp > sec 1;port del ring:1 rx forward3
- spp > sec 1;port del vhost:2 rx forward3
+ spp > sec 1;port del vhost:0 rx forwarder3
+ spp > sec 1;port del ring:2 tx forwarder3
# forwarder4
- spp > sec 1;port del vhost:2 tx forward4
- spp > sec 1;port del ring:3 rx forward4
+ spp > sec 1;port del vhost:2 rx forwarder4
+ spp > sec 1;port del ring:3 tx forwarder4
# merger1
- spp > sec 1;port del ring:2 rx merge1
- spp > sec 1;port del ring:3 rx merge1
- spp > sec 1;port del phy:0 tx merge1
+ spp > sec 1;port del ring:2 rx merger1
+ spp > sec 1;port del ring:3 rx merger1
+ spp > sec 1;port del phy:0 tx merger1
Then, stop components.
@@ -362,11 +360,11 @@ Then, stop components.
# Stop component to spp_vf
spp > sec 1;component stop classifier1
- spp > sec 1;component stop forward1
- spp > sec 1;component stop forward2
- spp > sec 1;component stop forward3
- spp > sec 1;component stop forward4
- spp > sec 1;component stop merge1
+ spp > sec 1;component stop forwarder1
+ spp > sec 1;component stop forwarder2
+ spp > sec 1;component stop forwarder3
+ spp > sec 1;component stop forwarder4
+ spp > sec 1;component stop merger1
Second, do termination for the second path.
Delete entries from ``classifier_table`` and ports from each of
@@ -388,11 +386,11 @@ components.
spp > sec 1;port del ring:4 rx forwarder5
spp > sec 1;port del vhost:1 tx forwarder5
# forwarder6
- spp > sec 1;port del vhost:1 rx forwarder6
- spp > sec 1;port del ring:6 tx forwarder6
+ spp > sec 1;port del ring:5 rx forwarder6
+ spp > sec 1;port del vhost:3 tx forwarder6
# forwarder7
- spp > sec 1;port del ring:5 rx forwarder7
- spp > sec 1;port del vhost:3 rx forwarder7
+ spp > sec 1;port del vhost:1 rx forwarder7
+ spp > sec 1;port del ring:6 tx forwarder7
# forwarder8
spp > sec 1;port del vhost:3 tx forwarder8
spp > sec 1;port del ring:7 rx forwarder8
@@ -406,12 +404,12 @@ Then, stop components.
.. code-block:: console
# Stop component to spp_vf
- spp > sec 1;component stop classifier2 8 classifier_mac
- spp > sec 1;component stop forward5 9 forward
- spp > sec 1;component stop forward6 10 forward
- spp > sec 1;component stop forward7 11 forward
- spp > sec 1;component stop forward8 12 forward
- spp > sec 1;component stop merge2 13 merge
+ spp > sec 1;component stop classifier2
+ spp > sec 1;component stop forwarder5
+ spp > sec 1;component stop forwarder6
+ spp > sec 1;component stop forwarder7
+ spp > sec 1;component stop forwarder8
+ spp > sec 1;component stop merger2
Finally, run ``flush`` subcommand.
--
1.9.1
^ permalink raw reply [flat|nested] 4+ messages in thread* [spp] [PATCH 2/2] doc: Improve document under spp_vf directory
[not found] <1525844601-26319-1-git-send-email-x-fn-spp@sl.ntt-tx.co.jp>
2018-05-09 5:45 ` [spp] [PATCH 1/2] doc: Fix document error under spp_vf directory x-fn-spp
@ 2018-05-09 5:45 ` x-fn-spp
1 sibling, 0 replies; 4+ messages in thread
From: x-fn-spp @ 2018-05-09 5:45 UTC (permalink / raw)
To: spp
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
^ permalink raw reply [flat|nested] 4+ messages in thread