X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Ftag_documentation.rst;h=d554d2cd9a5ef92dad66bd96d5077f46f79b2fbe;hp=e255d48c6d13c1a299a937e5f6fbd069070f71ac;hb=75fe508bc9e03291977c1a28ca0adc31c3149df9;hpb=6daa2d791f0e0d41b73668ef3ee233e58987dc37 diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst index e255d48c6d..d554d2cd9a 100644 --- a/docs/tag_documentation.rst +++ b/docs/tag_documentation.rst @@ -83,6 +83,10 @@ NIC Model Tags VIC-1385 by Cisco. +.. topic:: NIC_Amazon-Nitro-50G + + Amazon EC2 ENA NIC. + Scaling Tags ------------ @@ -189,6 +193,60 @@ Scaling Tags Traffic stream with 100 000 unique flows (100 IPs/users x 1000 UDP ports) in one direction. +.. topic:: HOSTS_1024 + + Stateless or stateful traffic stream with 1024 client source IP4 addresses, + usually with 63 flow differing in source port number. Could be UDP or TCP. + If NAT is used, the clients are inside. Outside IP range can differ. + +.. topic:: HOSTS_4096 + + Stateless or stateful traffic stream with 4096 client source IP4 addresses, + usually with 63 flow differing in source port number. Could be UDP or TCP. + If NAT is used, the clients are inside. Outside IP range can differ. + +.. topic:: HOSTS_16384 + + Stateless or stateful traffic stream with 16384 client source IP4 addresses, + usually with 63 flow differing in source port number. Could be UDP or TCP. + If NAT is used, the clients are inside. Outside IP range can differ. + +.. topic:: HOSTS_65536 + + Stateless or stateful traffic stream with 65536 client source IP4 addresses, + usually with 63 flow differing in source port number. Could be UDP or TCP. + If NAT is used, the clients are inside. Outside IP range can differ. + +.. topic:: HOSTS_262144 + + Stateless or stateful traffic stream with 262144 client source IP4 addresses + usually with 63 flow differing in source port number. Could be UDP or TCP. + If NAT is used, the clients are inside. Outside IP range can differ. + +.. topic:: GENEVE4_1TUN + + Test with 1 GENEVE IPv4 tunnel. + +.. topic:: GENEVE4_4TUN + + Test with 4 GENEVE IPv4 tunnels. + +.. topic:: GENEVE4_16TUN + + Test with 16 GENEVE IPv4 tunnels. + +.. topic:: GENEVE4_64TUN + + Test with 64 GENEVE IPv4 tunnels. + +.. topic:: GENEVE4_256TUN + + Test with 256 GENEVE IPv4 tunnels. + +.. topic:: GENEVE4_1024TUN + + Test with 1024 GENEVE IPv4 tunnels. + Test Category Tags ------------------ @@ -278,11 +336,12 @@ Test Type Tags .. topic:: BASE Baseline test cases, no encapsulation, no feature(s) configured in tests. + No scaling whatsoever, beyond minimum needed for RSS. .. topic:: IP4BASE IPv4 baseline test cases, no encapsulation, no feature(s) configured in - tests. + tests. Minimal number of routes. Other quantities may be scaled. .. topic:: IP6BASE @@ -306,7 +365,8 @@ Test Type Tags .. topic:: SCALE - Scale test cases. + Scale test cases. Other tags specify which quantities are scaled. + Also applies if scaling is set on TG only (e.g. DUT works as IP4BASE). .. topic:: ENCAP @@ -316,21 +376,66 @@ Test Type Tags At least one feature is configured in test cases. Use also feature tag(s). +.. topic:: UDP + + Tests which use any kind of UDP traffic (STL or ASTF profile). + .. topic:: TCP - Tests which use TCP. + Tests which use any kind of TCP traffic (STL or ASTF profile). + +.. + TODO: Should we define tags STL and ASTF? + +.. topic:: UDP_UDIR + + Tests which use unidirectional UDP traffic (STL profile only). + +.. topic:: UDP_BIDIR + + Tests which use bidirectional UDP traffic (STL profile only). + +.. topic:: UDP_CPS + + Tests which measure connections per second on minimal UDP pseudoconnections. + This implies ASTF traffic profile is used. + This tag selects specific output processing in PAL. .. topic:: TCP_CPS - Performance tests which measure connections per second using http requests. + Tests which measure connections per second on empty TCP connections. + This implies ASTF traffic profile is used. + This tag selects specific output processing in PAL. .. topic:: TCP_RPS - Performance tests which measure requests per second using http requests. + Tests which measure requests per second on empty TCP connections. + This implies ASTF traffic profile is used. + This tag selects specific output processing in PAL. + +.. topic:: UDP_PPS + + Tests which measure packets per second on lightweight UDP transactions. + This implies ASTF traffic profile is used. + This tag selects specific output processing in PAL. + +.. topic:: TCP_PPS + + Tests which measure packets per second on lightweight TCP transactions. + This implies ASTF traffic profile is used. + This tag selects specific output processing in PAL. .. topic:: HTTP - Tests which use HTTP. + Tests which use traffic formed of valid HTTP requests (and responses). + +.. + TODO: Add HTTP tag to the current hoststack tests. + TODO: Document other tags already used by hoststack tests. + +.. topic:: LDP_NGINX + + LDP NGINX is un-modified NGINX with VPP via LD_PRELOAD. .. topic:: NF_DENSITY @@ -500,6 +605,10 @@ Encapsulation Tags All test cases with GRE. +.. topic:: GTPU + + All test cases with GTPU. + .. topic:: IPSEC All test cases with IPSEC. @@ -520,6 +629,14 @@ Encapsulation Tags All SRv6 test cases with two SIDs and without decapsulation. +.. topic:: GENEVE + + All test cases with GENEVE. + +.. topic:: GENEVE_L3MODE + + All test cases with GENEVE tunnel in L3 mode. + Interface Tags -------------- @@ -527,17 +644,27 @@ Interface Tags All test cases which use physical interface(s). +.. topic:: GSO + + All test cases which uses Generic Segmentation Offload. + .. topic:: VHOST All test cases which uses VHOST. -.. topic:: VHOST_256 +.. topic:: VHOST_1024 - All test cases which uses VHOST with qemu queue size set to 256. + All test cases which uses VHOST DPDK driver with qemu queue size set + to 1024. -.. topic:: VHOST_1024 +.. topic:: VIRTIO + + All test cases which uses VIRTIO native VPP driver. + +.. topic:: VIRTIO_1024 - All test cases which uses VHOST with qemu queue size set to 1024. + All test cases which uses VIRTIO native VPP driver with qemu queue size set + to 1024. .. topic:: CFS_OPT @@ -632,9 +759,9 @@ Feature Tags iACL destination. -.. topic:: COPWHLIST +.. topic:: ADLALWLIST - COP whitelist. + ADL allowlist. .. topic:: NAT44 @@ -743,6 +870,10 @@ Encryption Tags IPSec using HMAC SHA 512 integrity algorithms. +.. topic:: SCHEDULER + + IPSec using crypto sw scheduler engine. + Client-Workload Tags -------------------- @@ -861,23 +992,3 @@ Multi-Threading Tags 8 worker threads each pinned to a separate logical core within 4 dedicated physical cores. 4 receive queues per interface. Main thread pinned to core 1. - -Honeycomb Tags --------------- - -.. topic:: HC_FUNC - - Honeycomb functional test cases. - -.. topic:: HC_NSH - - Honeycomb NSH test cases. - -.. topic:: HC_PERSIST - - Honeycomb persistence test cases. - -.. topic:: HC_REST_ONLY - - (Exclusion tag) Honeycomb test cases that cannot be run in Netconf mode - using ODL client for Restfconf -> Netconf translation.