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 05C5BA31F3 for ; Sat, 19 Oct 2019 19:04:52 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id DE53E1BEAF; Sat, 19 Oct 2019 19:04:51 +0200 (CEST) Received: from mail-pl1-f193.google.com (mail-pl1-f193.google.com [209.85.214.193]) by dpdk.org (Postfix) with ESMTP id D83A81BEAF for ; Sat, 19 Oct 2019 19:04:50 +0200 (CEST) Received: by mail-pl1-f193.google.com with SMTP id q15so4393876pll.11 for ; Sat, 19 Oct 2019 10:04:50 -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=4DwoHV/n6uxXPVzpVP6aSZ2yv6I9bu4eyI+jU57mVOE=; b=E/13vhkG+DnlnR5JRna1Kckc6XzOQj/FCDLxfb+sz64BKiSN6OL6xjbXcjMWe5G9dZ DP5g92dq05EqlXJzeX74kxviuSjA8DxcRjFEPhu006cgPx7fK7AwBDeXpLOwD2X/otOY 8imCL8+bWqLygoiEEHemGEkmFul/k9bCh7BP0zDVv/eE1HP3UxKNdDjnBIKB0elCfdGn H/OFSLH6CaLD8EkOza/Wsvx7IrUolTsfDjKLwm0nGFisPvaje4NC4wL4dn/UmAJ2es/S aQoZH3cdxEUY61N9eEui9HtjcDU5sTz+7DSOH2xTyFetr7yhTz2NUeiX4rCeTriGirB2 3oKw== 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=4DwoHV/n6uxXPVzpVP6aSZ2yv6I9bu4eyI+jU57mVOE=; b=fwtzCwqkyIuZgUAF4wsxOLFHtKHPOhqA2ECTjmt8WCgtFHoVI6CPDZX+AY/UO8dT/9 MTSx1r9akXJfGBeAg8yEO8E8+NPty/A8HAu2HR/fLa5yep6mgnrf27GI7fWcLqXmdHex L0Moj7S0t5woS7XEKGi8kSD+tHLTAqdzWYgB6PY9+/UqOsokh/oOdczss1rhCX+YNKmM P9N/xZ6oM8DQDGfDlO+iL7sWoCs6OzaU/tv8JlG26CMGEc2EAIIWSq+ZXLCRyl9jc33B ntUvHKGW8/guBx8nkqOZipXlY3F70EXVL0eriFM75D9+Ci+td0pW0wlxY5M7IqjN5zOG MeYg== X-Gm-Message-State: APjAAAXGhwtvb+3rGQfsGWUfbq0prVgC0kyFE4fdkUTEIpTSchGkP/GO kIb8ZNp17vwBeaML+jqvuKkbwA3fcWk= X-Google-Smtp-Source: APXvYqx3CINZU0jEWHfpH1AxhCgfmZfWIv3tZP5qlolHTwzp5eVepBi7WcFuznYiuBovGk1gBgaHVw== X-Received: by 2002:a17:902:8305:: with SMTP id bd5mr11424558plb.184.1571504689715; Sat, 19 Oct 2019 10:04:49 -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.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 19 Oct 2019 10:04:49 -0700 (PDT) From: Yasufumi Ogawa To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Sun, 20 Oct 2019 02:04:39 +0900 Message-Id: <20191019170443.23225-2-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 1/5] docs: add pri APIs for forwarder 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" This update is to add REST APIs for `forward` and `patches` for spp_primary. Signed-off-by: Yasufumi Ogawa --- docs/guides/api_ref/spp_mirror.rst | 4 +- docs/guides/api_ref/spp_nfv.rst | 4 +- docs/guides/api_ref/spp_pcap.rst | 4 +- docs/guides/api_ref/spp_primary.rst | 132 ++++++++++++++++++++++++++-- docs/guides/api_ref/spp_vf.rst | 4 +- 5 files changed, 132 insertions(+), 16 deletions(-) diff --git a/docs/guides/api_ref/spp_mirror.rst b/docs/guides/api_ref/spp_mirror.rst index 1d4efee..a3f7c02 100644 --- a/docs/guides/api_ref/spp_mirror.rst +++ b/docs/guides/api_ref/spp_mirror.rst @@ -4,8 +4,8 @@ .. _spp_ctl_rest_api_spp_mirror: -API for spp_mirror -================== +spp_mirror +========== GET /v1/mirrors/{client_id} --------------------------- diff --git a/docs/guides/api_ref/spp_nfv.rst b/docs/guides/api_ref/spp_nfv.rst index 949f772..7dbd43e 100644 --- a/docs/guides/api_ref/spp_nfv.rst +++ b/docs/guides/api_ref/spp_nfv.rst @@ -4,8 +4,8 @@ .. _spp_ctl_rest_api_spp_nfv: -API for spp_nfv -=============== +spp_nfv +======= GET /v1/nfvs/{client_id} ------------------------ diff --git a/docs/guides/api_ref/spp_pcap.rst b/docs/guides/api_ref/spp_pcap.rst index 56ed542..6f5bec5 100644 --- a/docs/guides/api_ref/spp_pcap.rst +++ b/docs/guides/api_ref/spp_pcap.rst @@ -4,8 +4,8 @@ .. _spp_ctl_rest_api_spp_pcap: -API for spp_pcap -================ +spp_pcap +======== GET /v1/pcaps/{client_id} ------------------------- diff --git a/docs/guides/api_ref/spp_primary.rst b/docs/guides/api_ref/spp_primary.rst index 1345a46..382915f 100644 --- a/docs/guides/api_ref/spp_primary.rst +++ b/docs/guides/api_ref/spp_primary.rst @@ -4,8 +4,8 @@ .. _spp_ctl_rest_api_spp_primary: -API for spp_primary -=================== +spp_primary +=========== GET /v1/primary/status ---------------------- @@ -136,6 +136,46 @@ Response example } +PUT /v1/primary/forward +----------------------- + +Start or stop forwarding. + +* Normal response codes: 204 +* Error response codes: 400, 404 + + +Request example +~~~~~~~~~~~~~~~ + +.. code-block:: console + + $ curl -X PUT -H 'application/json' -d '{"action": "start"}' \ + http://127.0.0.1:7777/v1/primary/forward + + +Response +~~~~~~~~ + +There is no body content for the response of a successful ``PUT`` request. + + +Equivalent CLI command +~~~~~~~~~~~~~~~~~~~~~~ + +Action is ``start``. + +.. code-block:: none + + spp > pri; forward + +Action is ``stop``. + +.. code-block:: none + + spp > pri; stop + + PUT /v1/primary/ports --------------------- @@ -207,6 +247,88 @@ Response There is no body content for the response of a successful ``DELETE`` request. +PUT /v1/primary/patches +----------------------- + +Add a patch. + +* Normal response codes: 204 +* Error response codes: 400, 404 + + +Request (body) +~~~~~~~~~~~~~~ + +.. _table_spp_ctl_spp_primary_ports_patches_body: + +.. table:: Request body params of patches of ``spp_primary``. + + +------+--------+------------------------------------+ + | Name | Type | Description | + | | | | + +======+========+====================================+ + | src | string | Source port id. | + +------+--------+------------------------------------+ + | dst | string | Destination port id. | + +------+--------+------------------------------------+ + + +Request example +~~~~~~~~~~~~~~~ + +.. code-block:: console + + $ curl -X PUT -H 'application/json' \ + -d '{"src": "ring:0", "dst": "ring:1"}' \ + http://127.0.0.1:7777/v1/primary/patches + + +Response +~~~~~~~~ + +There is no body content for the response of a successful ``PUT`` request. + + +Equivalent CLI command +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: none + + spp > pri; patch {src} {dst} + + +DELETE /v1/primary/patches +-------------------------- + +Reset patches. + +* Normal response codes: 204 +* Error response codes: 400, 404 + + +Request example +~~~~~~~~~~~~~~~ + +.. code-block:: console + + $ curl -X DELETE -H 'application/json' \ + http://127.0.0.1:7777/v1/primary/patches + + +Response +~~~~~~~~ + +There is no body content for the response of a successful ``DELETE`` request. + + +Equivalent CLI command +~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: none + + spp > pri; patch reset + + DELETE /v1/primary ------------------ @@ -239,12 +361,6 @@ Launch a secondary process. * Error response codes: 400, 404 -Request (path) -~~~~~~~~~~~~~~ - -There is no params in this API. - - Request (body) ~~~~~~~~~~~~~~ diff --git a/docs/guides/api_ref/spp_vf.rst b/docs/guides/api_ref/spp_vf.rst index d9d3719..77a52c2 100644 --- a/docs/guides/api_ref/spp_vf.rst +++ b/docs/guides/api_ref/spp_vf.rst @@ -4,8 +4,8 @@ .. _spp_ctl_rest_api__spp_vf: -API for spp_vf -============== +spp_vf +====== GET /v1/vfs/{client_id} ----------------------- -- 2.17.1