From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id 25D5B1B20C for ; Wed, 9 Jan 2019 02:51:44 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id x091phuo018568; Wed, 9 Jan 2019 10:51:43 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 79EC7EA736E; Wed, 9 Jan 2019 10:51:43 +0900 (JST) Received: from localhost.localdomain (lobster.nslab.ecl.ntt.co.jp [129.60.13.95]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 61EBAEA728E; Wed, 9 Jan 2019 10:51:43 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, ogawa.yasufumi@lab.ntt.co.jp Date: Wed, 9 Jan 2019 10:49:22 +0900 Message-Id: <1546998573-26108-2-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1546998573-26108-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1546998573-26108-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH 01/11] docs: change structure of 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: Wed, 09 Jan 2019 01:51:45 -0000 From: Yasufumi Ogawa This patche is to divide `overview.rst` to sub sections for adding more contents to this section. All of design sections, for instance spp-ctl, are moved to under this overview section in next patches. Signed-off-by: Yasufumi Ogawa --- docs/guides/index.rst | 2 +- docs/guides/overview.rst | 63 --------------------------------------- docs/guides/overview/design.rst | 39 ++++++++++++++++++++++++ docs/guides/overview/index.rst | 12 ++++++++ docs/guides/overview/overview.rst | 25 ++++++++++++++++ docs/guides/setup/howto_use.rst | 2 +- 6 files changed, 78 insertions(+), 65 deletions(-) delete mode 100644 docs/guides/overview.rst create mode 100644 docs/guides/overview/design.rst create mode 100644 docs/guides/overview/index.rst create mode 100644 docs/guides/overview/overview.rst diff --git a/docs/guides/index.rst b/docs/guides/index.rst index a01c959..99897aa 100644 --- a/docs/guides/index.rst +++ b/docs/guides/index.rst @@ -7,7 +7,7 @@ SPP documentation .. toctree:: :maxdepth: 1 - overview + overview/index setup/index commands/index tools/index diff --git a/docs/guides/overview.rst b/docs/guides/overview.rst deleted file mode 100644 index 1140cd6..0000000 --- a/docs/guides/overview.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. SPDX-License-Identifier: BSD-3-Clause - Copyright(c) 2010-2014 Intel Corporation - -.. _spp_overview: - -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). - -.. figure:: images/overview/spp_overview.* - :width: 50% - - SPP overview - -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 NFV applications via high -thoughput network interfaces provided by DPDK and change configurations -of resources dynamically to applications to build pipelines. - - -Design ------- - -SPP is composed of several DPDK processes and controller processes [1]. - -In terms of DPDK processes, SPP is derived from DPDK's multi-process sample -application and it consists of a primary process and multiple secondary -processes. -SPP primary process is responsible for resource management, for example, ports, -mbufs or shared memory. On the other hand, secondary processes are working for -tasks. - -SPP is controlled from python based management framework. It consists of -front-end CLI and back-end server process. -SPP's front-end CLI provides a patch panel like interface for users. -This CLI process parses user input and sends request to the back-end via REST -APIs. It means that the back-end server process accepts requests from other -than CLI. It enables developers to implement control interface such as GUI, or -plugin for other framework. -`networking-spp -`_ -is a Neutron ML2 plugin for using SPP with OpenStack. -By using networking-spp and doing some of extra tunings for optimization, you -can deploy high-performance NFV services on OpenStack [2]. - - -Reference ---------- - -* [1] `Implementation and Testing of Soft Patch Panel - `_ -* [2] `Integrating OpenStack with DPDK for High Performance Applications - `_ diff --git a/docs/guides/overview/design.rst b/docs/guides/overview/design.rst new file mode 100644 index 0000000..486550d --- /dev/null +++ b/docs/guides/overview/design.rst @@ -0,0 +1,39 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2010-2014 Intel Corporation + Copyright(c) 2018-2019 Nippon Telegraph and Telephone Corporation + +.. _spp_overview_design: + +Design +====== + +SPP is composed of several DPDK processes and controller processes [1]. + +In terms of DPDK processes, SPP is derived from DPDK's multi-process sample +application and it consists of a primary process and multiple secondary +processes. +SPP primary process is responsible for resource management, for example, ports, +mbufs or shared memory. On the other hand, secondary processes are working for +tasks. + +SPP is controlled from python based management framework. It consists of +front-end CLI and back-end server process. +SPP's front-end CLI provides a patch panel like interface for users. +This CLI process parses user input and sends request to the back-end via REST +APIs. It means that the back-end server process accepts requests from other +than CLI. It enables developers to implement control interface such as GUI, or +plugin for other framework. +`networking-spp +`_ +is a Neutron ML2 plugin for using SPP with OpenStack. +By using networking-spp and doing some of extra tunings for optimization, you +can deploy high-performance NFV services on OpenStack [2]. + + +Reference +--------- + +* [1] `Implementation and Testing of Soft Patch Panel + `_ +* [2] `Integrating OpenStack with DPDK for High Performance Applications + `_ diff --git a/docs/guides/overview/index.rst b/docs/guides/overview/index.rst new file mode 100644 index 0000000..a4c6f70 --- /dev/null +++ b/docs/guides/overview/index.rst @@ -0,0 +1,12 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Nippon Telegraph and Telephone Corporation + +Soft Patch Panel +================ + +.. toctree:: + :maxdepth: 2 + :numbered: + + overview + design diff --git a/docs/guides/overview/overview.rst b/docs/guides/overview/overview.rst new file mode 100644 index 0000000..e66c861 --- /dev/null +++ b/docs/guides/overview/overview.rst @@ -0,0 +1,25 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2010-2014 Intel Corporation + +.. _spp_overview_overview: + +Overview +======== + +`Soft Patch Panel +`_ +(SPP) is a DPDK application for providing switching +functionality for Service Function Chaining in +NFV (Network Function Virtualization). + +.. figure:: ../images/overview/spp_overview.* + :width: 50% + + SPP overview + +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 NFV applications via high +thoughput network interfaces provided by DPDK and change configurations +of resources dynamically to applications to build pipelines. diff --git a/docs/guides/setup/howto_use.rst b/docs/guides/setup/howto_use.rst index 78700e3..a7fa97a 100644 --- a/docs/guides/setup/howto_use.rst +++ b/docs/guides/setup/howto_use.rst @@ -4,7 +4,7 @@ How to Use ========== -As described in :ref:`Overview`, SPP consists of +As described in :ref:`Design`, SPP consists of primary process for managing resources, secondary processes for forwarding packet, and SPP controller to accept user commands and send it to SPP processes. -- 2.7.4