From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0621.ocn.ad.jp (mogw0621.ocn.ad.jp [153.149.228.22]) by dpdk.org (Postfix) with ESMTP id E189C1B899 for ; Thu, 1 Feb 2018 05:04:41 +0100 (CET) Received: from mf-smf-ucb033c3 (mf-smf-ucb033c3.ocn.ad.jp [153.153.66.226]) by mogw0621.ocn.ad.jp (Postfix) with ESMTP id 7E8DC380238; Thu, 1 Feb 2018 13:04:40 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb023 ([153.149.142.86]) by mf-smf-ucb033c3 with ESMTP id h676evQy2vAhDh676eS4kJ; Thu, 01 Feb 2018 13:04:40 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.166]) by ntt.pod01.mv-mta-ucb023 with id 5G4e1x0023c2f7501G4ekt; Thu, 01 Feb 2018 04:04:40 +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:04:37 +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:48 +0900 Message-Id: <20180201040501.8004-2-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 02/15] docs: add overview 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:04:42 -0000 From: Yasufumi Ogawa Add overview section for describing SPP project. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/index.rst | 36 +++++++++++++++++++++++++++++ docs/guides/overview.rst | 51 ++++++++++++++++++++++++++++++++++++++++++ docs/guides/tools/index.rst | 36 +++++++++++++++++++++++++++++ 3 files changed, 123 insertions(+) create mode 100644 docs/guides/commands/index.rst create mode 100644 docs/guides/overview.rst create mode 100644 docs/guides/tools/index.rst diff --git a/docs/guides/commands/index.rst b/docs/guides/commands/index.rst new file mode 100644 index 0000000..b084b1f --- /dev/null +++ b/docs/guides/commands/index.rst @@ -0,0 +1,36 @@ +.. BSD LICENSE + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +SPP Commands +============ + +.. toctree:: + :maxdepth: 2 + :numbered: diff --git a/docs/guides/overview.rst b/docs/guides/overview.rst new file mode 100644 index 0000000..7650a00 --- /dev/null +++ b/docs/guides/overview.rst @@ -0,0 +1,51 @@ +.. BSD LICENSE + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Soft Patch Panel +================== + +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. + +The framework 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 +DPDK application to create resources, which are then to be used by +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. diff --git a/docs/guides/tools/index.rst b/docs/guides/tools/index.rst new file mode 100644 index 0000000..9cf137e --- /dev/null +++ b/docs/guides/tools/index.rst @@ -0,0 +1,36 @@ +.. BSD LICENSE + Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Intel Corporation nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Tools +=============== + +.. toctree:: + :maxdepth: 2 + :numbered: -- 2.7.4