From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1A3F9A31F3 for ; Sat, 19 Oct 2019 19:04:55 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 119071BEB0; Sat, 19 Oct 2019 19:04:55 +0200 (CEST) Received: from mail-pf1-f176.google.com (mail-pf1-f176.google.com [209.85.210.176]) by dpdk.org (Postfix) with ESMTP id BCF061BF5C for ; Sat, 19 Oct 2019 19:04:53 +0200 (CEST) Received: by mail-pf1-f176.google.com with SMTP id 205so5750308pfw.2 for ; Sat, 19 Oct 2019 10:04:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:in-reply-to:references; bh=tldeG01zLUonBzi1GWu0b2zwGDdkZAvOure+iqEViyY=; b=sf0Or1sdUXlCQh1LligPPIDefPJ5ly/DpUOBd5DjQ1hbCo4wc+0Ltq/I6G5q39Gx2g MlSPu9CottvR7dlGpd+JpuOAYYwzdkOejPWA3EdpUNwM+FC65SSOukJ1pJcIgBiCUrq7 rQRWoCa16AJW7eeskIy0Pf/I1Brmjdr2Fi6/ztpOmBEB4PoiXoZ39/Z/xFKF2WqKfMVT Rpj5eE3msZQdBy/Oqc1l/JdndPGpi2dEiFZf1HTm+1PIQtOoupI+HtqBpmuxCvJksd3Q 2k3MvcRxFQk96BddWFmqjNstDKABPCRAGZavCLskcwvnGrwe8JDcYogbGIKAye2EpQP8 XcOw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=tldeG01zLUonBzi1GWu0b2zwGDdkZAvOure+iqEViyY=; b=c1w1XjDCdNRWwNbNuKKe/JH6vYGiLYs8RplT0EAsGw4cnvdKX0sZCHf4CGIRHJ34aK j88BXyNKM+X1TXCi/s9U5rLXud5S6+eToLw2iVbZT60R4GUg0DUke6BpX5MYV/+S04oN Ci9uz6cGDwej3KGB/zG3kpOMKX7JF6Dis4c8ab9rh9bj01QqfkrV9cL3msTYYWzC8AN6 S8Ys1TNNNlYlLJxWhSba9TJVlUiaY5cUEqCxJoJatJHi/ahSP3dJ3mAlqOiBMqcXcbiZ QIYyGTGW6YXcoLWd/uZmyzk+D2XkYLen+ILa2voFHylv58zx40/jY+sXDclPUYqq4L2j BDAw== X-Gm-Message-State: APjAAAU64uYzjRnffaVzaM+DJVDJWNv4Ic68KMeIMmYncF3Kkhie/eVf uWP3Q2TpzMbsR3ln5r+sKhgEhakNS9M= X-Google-Smtp-Source: APXvYqwKvecPovYzUUTH3dn8pSdzgJF2RFAQRDX9I2QJxw5pRwEnKtQQ/nkQp+0N0bh2GNYx84UITQ== X-Received: by 2002:a62:38d5:: with SMTP id f204mr13769919pfa.209.1571504692688; Sat, 19 Oct 2019 10:04:52 -0700 (PDT) Received: from localhost.localdomain ([2400:4050:c8c2:de00:188c:998e:6041:844a]) by smtp.gmail.com with ESMTPSA id 206sm9493122pge.80.2019.10.19.10.04.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 19 Oct 2019 10:04:52 -0700 (PDT) From: Yasufumi Ogawa To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Sun, 20 Oct 2019 02:04:41 +0900 Message-Id: <20191019170443.23225-4-yasufum.o@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20191019170443.23225-1-yasufum.o@gmail.com> References: <20191019170443.23225-1-yasufum.o@gmail.com> Subject: [spp] [PATCH 3/5] docs: add intro in usecases 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: , Errors-To: spp-bounces@dpdk.org Sender: "spp" To explain overview of usecases, and why spp_primary is not described in this chapter, add an introduction in the top of the chapter. Signed-off-by: Yasufumi Ogawa --- docs/guides/api_ref/index.rst | 2 ++ docs/guides/commands/index.rst | 2 ++ docs/guides/design/impl/index.rst | 2 ++ docs/guides/design/index.rst | 2 ++ docs/guides/usecases/index.rst | 18 ++++++++++++++++++ 5 files changed, 26 insertions(+) diff --git a/docs/guides/api_ref/index.rst b/docs/guides/api_ref/index.rst index 490ec15..5619147 100644 --- a/docs/guides/api_ref/index.rst +++ b/docs/guides/api_ref/index.rst @@ -1,6 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2018-2019 Nippon Telegraph and Telephone Corporation +.. _spp_api_ref_index: + API Reference ============= diff --git a/docs/guides/commands/index.rst b/docs/guides/commands/index.rst index ce67f4b..faaf50a 100644 --- a/docs/guides/commands/index.rst +++ b/docs/guides/commands/index.rst @@ -1,6 +1,8 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation +.. _spp_commands_index: + SPP Commands ============ diff --git a/docs/guides/design/impl/index.rst b/docs/guides/design/impl/index.rst index 53f1c6c..5e6aa1b 100644 --- a/docs/guides/design/impl/index.rst +++ b/docs/guides/design/impl/index.rst @@ -2,6 +2,8 @@ Copyright(c) 2010-2014 Intel Corporation +.. _spp_design_impl_index: + Implementation ============== diff --git a/docs/guides/design/index.rst b/docs/guides/design/index.rst index f8d982d..3bf2c1d 100644 --- a/docs/guides/design/index.rst +++ b/docs/guides/design/index.rst @@ -2,6 +2,8 @@ Copyright(c) 2010-2014 Intel Corporation Copyright(c) 2018-2019 Nippon Telegraph and Telephone Corporation +.. _spp_design_index: + Design ====== diff --git a/docs/guides/usecases/index.rst b/docs/guides/usecases/index.rst index f67ea5d..538db87 100644 --- a/docs/guides/usecases/index.rst +++ b/docs/guides/usecases/index.rst @@ -1,9 +1,27 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2019 Nippon Telegraph and Telephone Corporation +.. _spp_usecases_index: + Use Cases ========= +As described in :ref:`Design`, +SPP has several kinds of secondary process for +usecases such as simple forwarding to network entities, capturing or +mirroring packets for monitoring, or connecting VMs or containers for +Service Function Chaining in NFV. + +This chapter is focusing on explaining about each of secondary +processes with simple usecases. +Usecase of ``spp_primary`` is not covered here because it is almost +similar to ``spp_nfv`` and no need to explain both. + +Details of usages of each process is not covered in this chapter. +You can refer the details of SPP processes via CLI from +:ref:`SPP Commands`, +or via REST API from :ref:`API Reference`. + .. toctree:: :maxdepth: 1 :numbered: -- 2.17.1