X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Ftag_documentation.rst;h=fa015759a196b4cf223d45823793fb73821a1b59;hp=b28fd89c6f240b09e674a169deba7da195ddfb32;hb=9377c956a86e42727039d9dab8879c10c9399f4c;hpb=2732350ff44a68fe34d7703682ea9339944f1459 diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst index b28fd89c6f..fa015759a1 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 ------------------ @@ -220,20 +278,33 @@ Performance Type Tags Performance tests using PLRsearch to find the critical load. +.. topic:: RECONF + + Performance tests aimed to measure lost packets (time) when performing + reconfiguration while full throughput offered load is applied. + Ethernet Frame Size Tags ------------------------ +These are describing the traffic offered by Traffic Generator, +"primary" traffic in case of asymmetric load. +For traffic between DUTs, or for "secondary" traffic, see ${overhead} value. + .. topic:: 64B - 64B frames used for test. + 64B frames used for test. Generic ethernet or IPv4. .. topic:: 78B - 78B frames used for test. + 78B frames used for test. Ipv6. .. topic:: 114B - 114B frames used for test. + 114B frames used for test. IPv4+vxlan. + +.. topic:: 118B + + 118B frames used for test. Dot1q+IPv4+vxlan. .. topic:: IMIX @@ -265,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 @@ -293,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 @@ -303,29 +376,66 @@ Test Type Tags At least one feature is configured in test cases. Use also feature tag(s). -.. topic:: TLDK +.. topic:: UDP + + Tests which use any kind of UDP traffic (STL or ASTF profile). - Functional test cases for TLDK. +.. topic:: TCP -.. topic:: DMM + Tests which use any kind of TCP traffic (STL or ASTF profile). - Functional test cases for DMM. +.. + TODO: Should we define tags STL and ASTF? -.. topic:: TCP +.. 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 use TCP. + 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 @@ -337,35 +447,40 @@ NF Service Density Tags .. topic:: CHAIN - NF service density tests with VNF or CNF service chain topology(ies). + NF service density tests with VNF or CNF service chain topology(ies). .. topic:: PIPE - NF service density tests with CNF service pipeline topology(ies). + NF service density tests with CNF service pipeline topology(ies). .. topic:: NF_L3FWDIP4 - NF service density tests with DPDK l3fwd IPv4 routing as NF workload. + NF service density tests with DPDK l3fwd IPv4 routing as NF workload. .. topic:: NF_VPPIP4 - NF service density tests with VPP IPv4 routing as NF workload. + NF service density tests with VPP IPv4 routing as NF workload. .. topic:: {r}R{c}C - Service density matrix locator {r}R{c}C, {r}Row denoting number of - service instances, {c}Column denoting number of NFs per service - instance. {r}=(1,2,4,6,8,10), {c}=(1,2,4,6,8,10). + Service density matrix locator {r}R{c}C, {r}Row denoting number of + service instances, {c}Column denoting number of NFs per service + instance. {r}=(1,2,4,6,8,10), {c}=(1,2,4,6,8,10). .. topic:: {n}VM{t}T - Service density {n}VM{t}T, {n}Number of NF Qemu VMs, {t}Number of threads - per NF. + Service density {n}VM{t}T, {n}Number of NF Qemu VMs, {t}Number of threads + per NF. .. topic:: {n}DCRt}T - Service density {n}DCR{t}T, {n}Number of NF Docker containers, {t}Number of - threads per NF. + Service density {n}DCR{t}T, {n}Number of NF Docker containers, {t}Number of + threads per NF. + +.. topic:: {n}_ADDED_CHAINS + + {n}Number of chains (or pipelines) added (and/or removed) + during RECONF test. Forwarding Mode Tags -------------------- @@ -390,6 +505,18 @@ Forwarding Mode Tags VPP IPv6 routed forwarding. +.. topic:: LOADBALANCER_MAGLEV + + VPP Load balancer maglev mode. + +.. topic:: LOADBALANCER_L3DSR + + VPP Load balancer l3dsr mode. + +.. topic:: LOADBALANCER_NAT4 + + VPP Load balancer nat4 mode. + Underlay Tags ------------- @@ -446,6 +573,26 @@ Encapsulation Tags All test cases with LISP-GPE. +.. topic:: LISP_IP4o4 + + All test cases with LISP_IP4o4. + +.. topic:: LISPGPE_IP4o4 + + All test cases with LISPGPE_IP4o4. + +.. topic:: LISPGPE_IP6o4 + + All test cases with LISPGPE_IP6o4. + +.. topic:: LISPGPE_IP4o6 + + All test cases with LISPGPE_IP4o6. + +.. topic:: LISPGPE_IP6o6 + + All test cases with LISPGPE_IP6o6. + .. topic:: VXLAN All test cases with Vxlan. @@ -478,6 +625,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 -------------- @@ -485,17 +640,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. - All test cases which uses VHOST with qemu queue size set to 1024. +.. topic:: VIRTIO_1024 + + All test cases which uses VIRTIO native VPP driver with qemu queue size set + to 1024. .. topic:: CFS_OPT @@ -563,6 +728,26 @@ Interface Tags devices. In essence, today this driver can be used only with Intel XL710 / X710 / XXV710 adapters. +.. topic:: DRV_VFIO_PCI + + All test cases which uses vfio-pci device driver. It supports variety of NIC + adapters. + +.. topic:: DRV_RDMA_CORE + + All test cases which uses rdma-core device driver. It supports Mellanox + NIC adapters. + +.. topic:: RXQ_SIZE_{n} + + All test cases which RXQ size (RX descriptors) are set to {n}. Default is 0, + which means VPP (API) default. + +.. topic:: TXQ_SIZE_{n} + + All test cases which TXQ size (TX descriptors) are set to {n}. Default is 0, + which means VPP (API) default. + Feature Tags ------------ @@ -570,9 +755,9 @@ Feature Tags iACL destination. -.. topic:: COPWHLIST +.. topic:: ADLALWLIST - COP whitelist. + ADL allowlist. .. topic:: NAT44 @@ -681,6 +866,10 @@ Encryption Tags IPSec using HMAC SHA 512 integrity algorithms. +.. topic:: SCHEDULER + + IPSec using crypto sw scheduler engine. + Client-Workload Tags -------------------- @@ -707,20 +896,6 @@ Client-Workload Tags Container Orchestration Tags ---------------------------- -.. topic:: K8S - - All test cases which use Kubernetes for orchestration. - -.. topic:: SFC_CONTROLLER - - All test cases which use ligato/sfc_controller for driving configuration - of vpp inside container. - -.. topic:: VPP_AGENT - - All test cases which use Golang implementation of a control/management plane - for VPP - .. topic:: 1VSWITCH VPP running in Docker container acting as VSWITCH. @@ -813,23 +988,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.