X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Ftag_documentation.rst;h=c37df8508b78bb9681cd04f40d76cf16411c9c21;hp=40d90fc6ad2c3c0a93a062a4c0f632f7b92a1293;hb=ac776adf699e105081630c44a3e36906d9ce2903;hpb=2d9516f9256790276802849d43156fa51f0bb6d3 diff --git a/docs/tag_documentation.rst b/docs/tag_documentation.rst index 40d90fc6ad..c37df8508b 100644 --- a/docs/tag_documentation.rst +++ b/docs/tag_documentation.rst @@ -189,6 +189,36 @@ 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. + Test Category Tags ------------------ @@ -278,11 +308,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 +337,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,29 +348,56 @@ Test Type Tags At least one feature is configured in test cases. Use also feature tag(s). -.. topic:: TLDK +.. topic:: UDP - Functional test cases for TLDK. + Tests which use any kind of UDP traffic (STL or ASTF profile). -.. topic:: DMM +.. topic:: TCP - Functional test cases for DMM. + Tests which use any kind of TCP traffic (STL or ASTF profile). -.. topic:: TCP +.. + TODO: Should we define tags STL and ASTF? + +.. topic:: UDP_UDIR + + Tests which use unidirectional UDP traffic (STL profile only). - Tests which use TCP. +.. 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:: UDP_PPS -.. topic:: TCP_RPS + 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. - Performance tests which measure requests per second using http requests. +.. 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:: NF_DENSITY @@ -408,6 +467,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 ------------- @@ -523,17 +594,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 @@ -601,6 +682,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 ------------ @@ -745,20 +846,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. @@ -851,23 +938,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.