diff options
author | 2021-10-28 15:05:53 +0200 | |
---|---|---|
committer | 2021-12-13 10:57:25 +0000 | |
commit | e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f (patch) | |
tree | 8548662c60534211b7eb34f2f2881636ec3797b9 /tests/vpp/perf/crypto/2n1l-10ge2p1x710-ethip4ipsec4tnlswasync-scheduler-ip4base-int-aes128cbc-hmac512sha-udir-ndrpdr.robot | |
parent | f87931f3c85fe71bb3124e787168abafc5874c54 (diff) |
doc: fixing documentation structure
When building documentation using sphinx we see ~1200 similar warnings [0]
[0] - https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-verify-tox-master-ubuntu2004-x86_64/3289/doc_verify.log.gz
These warning are harmless and can be fixed later
Signed-off-by: Viliam Luc <vluc@cisco.com>
Change-Id: I1ac1099d38935971d47491dde905715345d3935c
Diffstat (limited to 'tests/vpp/perf/crypto/2n1l-10ge2p1x710-ethip4ipsec4tnlswasync-scheduler-ip4base-int-aes128cbc-hmac512sha-udir-ndrpdr.robot')
-rw-r--r-- | tests/vpp/perf/crypto/2n1l-10ge2p1x710-ethip4ipsec4tnlswasync-scheduler-ip4base-int-aes128cbc-hmac512sha-udir-ndrpdr.robot | 53 |
1 files changed, 29 insertions, 24 deletions
diff --git a/tests/vpp/perf/crypto/2n1l-10ge2p1x710-ethip4ipsec4tnlswasync-scheduler-ip4base-int-aes128cbc-hmac512sha-udir-ndrpdr.robot b/tests/vpp/perf/crypto/2n1l-10ge2p1x710-ethip4ipsec4tnlswasync-scheduler-ip4base-int-aes128cbc-hmac512sha-udir-ndrpdr.robot index 9546a3cb24..cc9522880e 100644 --- a/tests/vpp/perf/crypto/2n1l-10ge2p1x710-ethip4ipsec4tnlswasync-scheduler-ip4base-int-aes128cbc-hmac512sha-udir-ndrpdr.robot +++ b/tests/vpp/perf/crypto/2n1l-10ge2p1x710-ethip4ipsec4tnlswasync-scheduler-ip4base-int-aes128cbc-hmac512sha-udir-ndrpdr.robot @@ -29,29 +29,34 @@ | | Test Template | Local Template | -| Documentation | *RFC2544: Pkt throughput IPv4 IPsec tunnel mode.* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology +| Documentation | **RFC2544: Pkt throughput IPv4 IPsec tunnel mode.** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 on TG-DUT1, -| ... | Eth-IPv4-IPSec on DUT1-TG -| ... | *[Cfg] DUT configuration:* DUT1 is configured with multiple IPsec\ -| ... | tunnels between it and TG, run with IPsec async mode and use crypto -| ... | sw scheduler engine to schedule crypto work to crypto cores. DUT gets +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 on TG-DUT1, \ +| ... | Eth-IPv4-IPSec on DUT1-TG. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with multiple IPsec \ +| ... | tunnels between it and TG, run with IPsec async mode and use crypto \ +| ... | sw scheduler engine to schedule crypto work to crypto cores. DUT gets \ | ... | IPv4 traffic from TG, encrypts it and sends back to TG. -| ... | *[Ver] TG verification:* TG finds and reports throughput NDR (Non Drop\ -| ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\ -| ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\ -| ... | of packets transmitted. NDR and PDR are discovered for different\ -| ... | Ethernet L2 frame sizes using MLRsearch library.\ -| ... | Test packets are generated by TG on links to DUTs. -| ... | TG traffic profile contains one L3 flow-groups (number of flows -| ... | per flow-group equals to number of IPSec tunnels) with all packets -| ... | containing Ethernet header, IPv4 header with IP protocol=61 and -| ... | static payload. MAC addresses are matching MAC addresses of the TG -| ... | node interfaces. Incrementing of IP.dst (IPv4 destination address) field -| ... | is applied to the stream. -| ... | *[Ref] Applicable standard specifications:* RFC4303 and RFC2544. +| ... | +| ... | - **[Ver] TG verification:** TG finds and reports throughput NDR (Non \ +| ... | Drop Rate) with zero packet loss tolerance and throughput PDR \ +| ... | (Partial Drop Rate) with non-zero packet loss tolerance (LT) \ +| ... | expressed in percentage of packets transmitted. NDR and PDR are \ +| ... | discovered for different Ethernet L2 frame sizes using MLRsearch \ +| ... | library. +| ... | Test packets are generated by TG on links to DUTs. \ +| ... | TG traffic profile contains one L3 flow-groups (number of flows \ +| ... | per flow-group equals to number of IPSec tunnels) with all packets \ +| ... | containing Ethernet header, IPv4 header with IP protocol=61 and \ +| ... | static payload. MAC addresses are matching MAC addresses of the TG \ +| ... | node interfaces. Incrementing of IP.dst (IPv4 destination address) \ +| ... | field is applied to the stream. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC4303 and RFC2544. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -83,10 +88,10 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs IPSec tunneling AES_128_CBC / HMAC_SHA_512 config.\ -| | ... | Each DUT uses one physical core for data plane workers +| | ... | - **[Cfg]** DUT runs IPSec tunneling AES_128_CBC / HMAC_SHA_512 \ +| | ... | Each DUT uses one physical core for data plane workers \ | | ... | and rest of ${phy_cores} physical core(s) for crypto workers. -| | ... | [Ver] Measure NDR and PDR values using MLRsearch algorithm.\ +| | ... | - **[Ver]** Measure NDR and PDR values using MLRsearch algorithm. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer or string (IMIX_v4_1). |