From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0113.ocn.ad.jp (mogw0113.ocn.ad.jp [118.23.109.87]) by dpdk.org (Postfix) with ESMTP id B68291B8E2 for ; Thu, 1 Feb 2018 05:05:23 +0100 (CET) Received: from mf-smf-ucb020c1 (mf-smf-ucb020c1.ocn.ad.jp [153.153.66.133]) by mogw0113.ocn.ad.jp (Postfix) with ESMTP id 9F9645C2AD; Thu, 1 Feb 2018 13:05:22 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb021 ([153.149.142.84]) by mf-smf-ucb020c1 with ESMTP id h67des0RNUyvsh67meQOon; Thu, 01 Feb 2018 13:05:22 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.166]) by ntt.pod01.mv-mta-ucb021 with id 5G5N1x0023c2f7501G5NPg; Thu, 01 Feb 2018 04:05:22 +0000 Received: from localhost.localdomain (sp1-66-99-86.msc.spmode.ne.jp [1.66.99.86]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Thu, 1 Feb 2018 13:05:22 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com Cc: Yasufumi Ogawa Date: Thu, 1 Feb 2018 13:04:59 +0900 Message-Id: <20180201040501.8004-13-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 13/15] docs: update overview section 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: Thu, 01 Feb 2018 04:05:24 -0000 From: Yasufumi Ogawa * Add overview image * Add reference Signed-off-by: Yasufumi Ogawa --- docs/guides/images/spp_overview.svg | 327 ++++++++++++++++++++++++++++++++++++ docs/guides/overview.rst | 36 +++- 2 files changed, 356 insertions(+), 7 deletions(-) create mode 100644 docs/guides/images/spp_overview.svg diff --git a/docs/guides/images/spp_overview.svg b/docs/guides/images/spp_overview.svg new file mode 100644 index 0000000..b36fac1 --- /dev/null +++ b/docs/guides/images/spp_overview.svg @@ -0,0 +1,327 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + Host + + + Port 0 + Port 1 + + + + + App + + Port 3 + VM + + SPP + + + App + App + + + + + + diff --git a/docs/guides/overview.rst b/docs/guides/overview.rst index 7650a00..afb46cf 100644 --- a/docs/guides/overview.rst +++ b/docs/guides/overview.rst @@ -31,21 +31,43 @@ Soft Patch Panel ================== +Overview +-------- + +`Soft Patch Panel +`_ +(SPP) is a DPDK application for providing switching +functionality for Service Function Chaining in +NFV (Network Function Virtualization). + +.. image:: images/spp_overview.svg + :height: 350 em + :width: 350 em + +With SPP, user is able to configure network easily and dynamically +via simple patch panel like interface. + The goal of SPP is to easily interconnect DPDK applications together, and assign resources dynamically to these applications to build a pipeline. -The first version of SPP provides for the management of DPDK ports, and -assigning ports to different DPDK applications. +Design +------ -The framework is composed of a primary DPDK application that is +SPP is composed of a primary DPDK application that is responsible for resource management. This primary application doesn't interact with any traffic, and is used to manage creation and freeing of resources only. -A Python based management interface is provided to control the primary +A Python based management interface, SPP controller, is provided to +control the primary DPDK application to create resources, which are then to be used by -secondary applications. This management application provides a socket +secondary applications. +This management application provides a socket based interface for the primary and secondary DPDK applications to -interface to the manager. The management application will use OVSDB to -maintain all created and assigned ports. +interface to the manager. + +Reference +--------- + +* [1] `Implementation and Testing of Soft Patch Panel `_ -- 2.7.4