From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0115.ocn.ad.jp (mogw0115.ocn.ad.jp [118.23.109.89]) by dpdk.org (Postfix) with ESMTP id 75E521B2A7 for ; Mon, 5 Feb 2018 03:39:00 +0100 (CET) Received: from mf-smf-ucb002.ocn.ad.jp (mf-smf-ucb002.ocn.ad.jp [153.149.227.4]) by mogw0115.ocn.ad.jp (Postfix) with ESMTP id 12406494273; Mon, 5 Feb 2018 11:38:59 +0900 (JST) Received: from mf-smf-ucb002.ocn.ad.jp (mf-smf-ucb002 [153.149.227.4]) by mf-smf-ucb002.ocn.ad.jp (Postfix) with ESMTP id E95E3C0678; Mon, 5 Feb 2018 11:38:58 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb022 (mv-mta-ucb022.ocn.ad.jp [153.149.142.85]) by mf-smf-ucb002.ocn.ad.jp (Switch-3.3.4/Switch-3.3.4) with ESMTP id w152cr6c026323; Mon, 5 Feb 2018 11:38:58 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.134]) by ntt.pod01.mv-mta-ucb022 with id 6qey1x0042ud8JZ01qeyB8; Mon, 05 Feb 2018 02:38:58 +0000 Received: from localhost.localdomain (sp49-97-109-142.msc.spmode.ne.jp [49.97.109.142]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Mon, 5 Feb 2018 11:38:54 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, nakamura.hiroyuki@po.ntt-tx.co.jp Cc: Yasufumi Ogawa Date: Mon, 5 Feb 2018 11:39:01 +0900 Message-Id: <20180205023921.7775-8-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20180205023921.7775-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180205023921.7775-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 08/28] docs: fix bug spp_vf howto_use guide X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 05 Feb 2018 02:39:01 -0000 From: Yasufumi Ogawa Signed-off-by: Yasufumi Ogawa --- docs/guides/spp_vf/gsg/howto_use.rst | 41 ++++++++---------------------------- 1 file changed, 9 insertions(+), 32 deletions(-) diff --git a/docs/guides/spp_vf/gsg/howto_use.rst b/docs/guides/spp_vf/gsg/howto_use.rst index 1db3ebf..e5983fb 100644 --- a/docs/guides/spp_vf/gsg/howto_use.rst +++ b/docs/guides/spp_vf/gsg/howto_use.rst @@ -32,30 +32,9 @@ How to Use ========== -SPP_VF ------- - -``SPP_VF`` is a SR-IOV like network functionality for NFV. - -.. image:: images/spp_vf_overview.svg - :height: 550 em - :width: 550 em - -Environment ------------ - -* Ubuntu 16.04 -* qemu-kvm 2.7 or later -* DPDK v17.11 or later - -Launch SPP ----------- - -Before launching spp, you need to setup DPDK, virsh, etc. described at -:doc:`build`. SPP Controller -~~~~~~~~~~~~~~ +-------------- First, run SPP Controller with port numbers for spp primary and secondary. @@ -65,7 +44,7 @@ First, run SPP Controller with port numbers for spp primary and secondary. SPP Primary -~~~~~~~~~~~ +----------- SPP primary allocates and manages resources for secondary processes. You need to run SPP primary before secondary processes. @@ -94,7 +73,7 @@ Then, spp primary can be launched like this. -- -p 0x03 -n 9 -s 127.0.0.1:5555 SPP Secondary -~~~~~~~~~~~~~ +------------- spp secondary processes(``spp_vf``) can be launched with two kinds of options, like primary process. @@ -104,9 +83,9 @@ DPDK, the other is ``spp_vf``. ``spp_vf`` specific options are: - * --client-id : client id - * -s : IPv4 address and port for spp secondary - * --vhost-client : vhost-user client enable setting + * --client-id: client id + * -s: IPv4 address and port for spp secondary + * --vhost-client: vhost-user client enable setting ``spp_vf`` can be launched like this. @@ -120,7 +99,7 @@ If ``--vhost-client`` option is specified, then ``vhost-user`` act as the client, otherwise the server. For reconnect feature from SPP to VM, ``--vhost-client`` option can be used. This reconnect features requires QEMU 2.7 (or later). -See also `DPDK documentation _. +See also `DPDK documentation `_. VM -- @@ -138,8 +117,7 @@ Additional Network Configurations To enable processes running on the VM to communicate through spp, it is required additional network configurations on host and guest VMs. -Guest VMs -""""""""" +(1) Guest VMs .. code-block:: console @@ -149,8 +127,7 @@ Guest VMs # Disable offload for vhost interface $ sudo ethtool -K [IF_NAME] tx off -Host2 -""""" +(2) Host2 .. code-block:: console -- 2.13.1