# Documentation Structure
1. OVERVIEW: General introduction to CSIT Performance Dashboard and CSIT itself.
- - **[CSIT-Dash](overview/c_dash)**: The design and the structure of
- CSIT-Dash dashboard.
- - **[CSIT](overview/csit)**: The design of the [FD.io](https://fd.io/)
- CSIT system, and the description of the test scenarios, test naming and
- test tags.
-2. METHODOLOGY
- - **[Overview](methodology/overview)**: Terminology, per-thread
- resources, multi-core speedup, VPP forwarding modes and DUT state
- considerations.
- - **[Measurement](methodology/measurements)**: Data plane throughput, packet
- latency and the telemetry.
- - **[Test](methodology/test)**: Methodology of all tests used in CSIT.
- - **[Trending](methodology/trending)**: A high-level design of a system for
- continuous performance measuring, trending and change detection for FD.io
- VPP SW data plane (and other performance tests run within CSIT
- sub-project).
- - **[Per-patch Testing](methodology/per_patch_testing)**: A methodology
- similar to trending analysis is used for comparing performance before a DUT
- code change is merged.
-3. RELEASE NOTES: Performance tests executed in physical FD.io testbeds.
- - **[CSIT rls2306](release_notes/csit_rls2306)**: The release notes of the
- current CSIT release.
- - **[Previous](release_notes/previous)**: Archived release notes for the past
- releases.
-4. INFRASTRUCTURE
- - **[FD.io DC Vexxhost Inventory](infrastructure/fdio_dc_vexxhost_inventory)**:
+ - **[CSIT-Dash]({{< relref "/overview/c_dash/" >}})**: The design and the
+ structure of CSIT-Dash dashboard.
+ - **[CSIT]({{< relref "/overview/csit/" >}})**: The design of the
+ [FD.io](https://fd.io/) CSIT system, and the description of the test
+ scenarios, test naming and test tags.
+1. METHODOLOGY
+ - **[Overview]({{< relref "/methodology/overview/" >}})**: Terminology,
+ per-thread resources, multi-core speedup, VPP forwarding modes and DUT
+ state considerations.
+ - **[Measurement]({{< relref "/methodology/measurements/" >}})**: Data plane
+ throughput, packet latency and the telemetry.
+ - **[Test]({{< relref "/methodology/test/" >}})**: Methodology of all tests
+ used in CSIT.
+ - **[Trending]({{< relref "/methodology/trending/" >}})**: A high-level
+ design of a system for continuous performance measuring, trending and
+ change detection for FD.io VPP SW data plane (and other performance tests
+ run within CSIT sub-project).
+ - **[Per-patch Testing]({{< relref "/methodology/per_patch_testing" >}})**:
+ A methodology similar to trending analysis is used for comparing
+ performance before a DUT code change is merged.
+2. RELEASE NOTES: Performance tests executed in physical FD.io testbeds.
+ - **[CSIT rls2306]({{< relref "/release_notes/csit_rls2306/" >}})**: The
+ release notes of the current CSIT release.
+ - **[Previous]({{< relref "/release_notes/previous/" >}})**: Archived release
+ notes for the past releases.
+3. INFRASTRUCTURE
+ - **[FD.io DC Vexxhost Inventory]({{< relref "/infrastructure/fdio_dc_vexxhost_inventory" >}})**:
Physical testbeds location.
- - **[FD.io DC Testbed Specifications](infrastructure/fdio_dc_testbed_specifications)**:
+ - **[FD.io DC Testbed Specifications]({{< relref "/infrastructure/fdio_dc_testbed_specifications" >}})**:
Specification of the physical testbed infrastructure.
- - **[FD.io DC Testbed Configuration](infrastructure/testbed_configuration)**:
+ - **[FD.io DC Testbed Configuration]({{< relref "/infrastructure/testbed_configuration/" >}})**:
Configuration of the physical testbed infrastructure.
- - **[FD.io CSIT Testbed Versioning](infrastructure/fdio_csit_testbed_versioning)**:
+ - **[FD.io CSIT Testbed Versioning]({{< relref "/infrastructure/fdio_csit_testbed_versioning" >}})**:
CSIT test environment versioning to track modifications of the test
environment.
- - **[FD.io CSIT Logical Topologies](infrastructure/fdio_csit_logical_topologies)**:
+ - **[FD.io CSIT Logical Topologies]({{< relref "/infrastructure/fdio_csit_logical_topologies" >}})**:
CSIT performance tests are executed on physical testbeds. Based on the
packet path thru server SUTs, three distinct logical topology types are
used for VPP DUT data plane testing.
- - **[VPP Startup Settings](infrastructure/vpp_startup_settings)**: List of
- common settings applied to all tests and test dependent settings.
+ - **[VPP Startup Settings]({{< relref "/infrastructure/vpp_startup_settings" >}})**:
+ List of common settings applied to all tests and test dependent settings.
# FD.io DC Testbed Configuration
-- [GigaByte ThunderX2](gigabyte_tx2_hw_bios_cfg)
-- [Huawei Taishan](huawei_tsh_hw_bios_cfg)
-- [MegaRac Altra](ami_alt_hw_bios_cfg)
-- [SuperMicro Cascadelake](sm_clx_hw_bios_cfg)
-- [SuperMicro EPYC Zen2](sm_zn2_hw_bios_cfg)
-- [SuperMicro Icelake](sm_icx_hw_bios_cfg)
-- [SuperMicro SapphireRapids](sm_spr_hw_bios_cfg)
+- [GigaByte ThunderX2]({{< relref "/infrastructure/testbed_configuration/gigabyte_tx2_hw_bios_cfg" >}})
+- [Huawei Taishan]({{< relref "/infrastructure/testbed_configuration/huawei_tsh_hw_bios_cfg" >}})
+- [MegaRac Altra]({{< relref "/infrastructure/testbed_configuration/ami_alt_hw_bios_cfg" >}})
+- [SuperMicro Cascadelake]({{< relref "/infrastructure/testbed_configuration/sm_clx_hw_bios_cfg" >}})
+- [SuperMicro EPYC Zen2]({{< relref "/infrastructure/testbed_configuration/sm_zn2_hw_bios_cfg" >}})
+- [SuperMicro Icelake]({{< relref "/infrastructure/testbed_configuration/sm_icx_hw_bios_cfg" >}})
+- [SuperMicro SapphireRapids]({{< relref "/infrastructure/testbed_configuration/sm_spr_hw_bios_cfg" >}})
# Measurement
-- [Data Plane Throughput](data_plane_throughput)
-- [Packet Latency](packet_latency)
-- [Telemetry](telemetry)
+- [Data Plane Throughput]({{< relref "/methodology/measurements/data_plane_throughput" >}})
+- [Packet Latency]({{< relref "/methodology/measurements/packet_latency" >}})
+- [Telemetry]({{< relref "/methodology/measurements/telemetry" >}})
# Data Plane Throughput
-- [Overview](data_plane_throughput)
-- [MLR Search](mlr_search)
-- [PLR Search](plr_search)
-- [MRR](mrr)
+- [Overview]({{< relref "/methodology/measurements/data_plane_throughput/data_plane_throughput" >}})
+- [MLR Search]({{< relref "/methodology/measurements/data_plane_throughput/mlr_search" >}})
+- [PLR Search]({{< relref "/methodology/measurements/data_plane_throughput/plr_search" >}})
+- [MRR]({{< relref "/methodology/measurements/data_plane_throughput/mrr" >}})
\ No newline at end of file
# Methodology
-- [Terminology](terminology)
-- [Per Thread Resources](per_thread_resources)
-- [Multi-Core Speedup](multi_core_speedup)
-- [VPP Forwarding Modes](vpp_forwarding_modes)
-- [DUT State Considerations](dut_state_considerations)
-- [TRex Traffic Generator](trex_traffic_generator)
+- [Terminology]({{< relref "/methodology/overview/terminology" >}})
+- [Per Thread Resources]({{< relref "/methodology/overview/per_thread_resources" >}})
+- [Multi-Core Speedup]({{< relref "/methodology/overview/multi_core_speedup" >}})
+- [VPP Forwarding Modes]({{< relref "/methodology/overview/vpp_forwarding_modes" >}})
+- [DUT State Considerations]({{< relref "/methodology/overview/dut_state_considerations" >}})
+- [TRex Traffic Generator]({{< relref "/methodology/overview/trex_traffic_generator" >}})
# Tests
-- [Network Address Translation](network_address_translation)
-- [Packet Flow Ordering](packet_flow_ordering)
-- [Tunnel Encapsulations](tunnel_encapsulations)
-- [Internet Protocol Security](internet_protocol_security)
-- [Access Control Lists](access_control_lists)
-- [Hoststack](hoststack)
-- [Generic Segmentation Offload](generic_segmentation_offload)
-- [Reconfiguration](reconfiguration)
-- [VPP Device](vpp_device)
-- [Reassembly](reassembly)
+- [Network Address Translation]({{< relref "/methodology/test/network_address_translation" >}})
+- [Packet Flow Ordering]({{< relref "/methodology/test/packet_flow_ordering" >}})
+- [Tunnel Encapsulations]({{< relref "/methodology/test/tunnel_encapsulations" >}})
+- [Internet Protocol Security]({{< relref "/methodology/test/internet_protocol_security" >}})
+- [Access Control Lists]({{< relref "/methodology/test/access_control_lists" >}})
+- [Hoststack]({{< relref "/methodology/test/hoststack/" >}})
+- [Generic Segmentation Offload]({{< relref "/methodology/test/generic_segmentation_offload" >}})
+- [Reconfiguration]({{< relref "/methodology/test/reconfiguration" >}})
+- [VPP Device]({{< relref "/methodology/test/vpp_device" >}})
+- [Reassembly]({{< relref "/methodology/test/reassembly" >}})
# Hoststack
-- [QUIC/UDP/IP with vpp_echo](quicudpip_with_vppecho)
-- [TCP/IP with iperf3](tcpip_with_iperf3)
-- [UDP/IP with iperf3](udpip_with_iperf3)
-- [VSAP ab with nginx](vsap_ab_with_nginx)
+- [QUIC/UDP/IP with vpp_echo]({{< relref "/methodology/test/hoststack/quicudpip_with_vppecho" >}})
+- [TCP/IP with iperf3]({{< relref "/methodology/test/hoststack/tcpip_with_iperf3" >}})
+- [UDP/IP with iperf3]({{< relref "/methodology/test/hoststack/udpip_with_iperf3" >}})
+- [VSAP ab with nginx]({{< relref "/methodology/test/hoststack/vsap_ab_with_nginx" >}})
performance measuring, trending and change detection for FD.io VPP SW
data plane (and other performance tests run within CSIT sub-project).
-- [Analysis](analysis)
-- [Presentation](presentation)
+- [Analysis]({{< relref "/methodology/trending/analysis" >}})
+- [Presentation]({{< relref "/methodology/trending/presentation" >}})
# CSIT-Dash
-- [Design](design)
-- [Structure](structure)
+- [Design]({{< relref "/overview/c_dash/design" >}})
+- [Structure]({{< relref "/overview/c_dash/structure" >}})
# CSIT
-- [Design](design)
-- [Test Scenarios](test_scenarios)
-- [Test Naming](test_naming)
-- [Test Tags](test_tags)
-- [Suite Generation](suite_generation)
+- [Design]({{< relref "/overview/csit/design" >}})
+- [Test Scenarios]({{< relref "/overview/csit/test_scenarios" >}})
+- [Test Naming]({{< relref "/overview/csit/test_naming" >}})
+- [Test Tags]({{< relref "/overview/csit/test_tags" >}})
+- [Suite Generation]({{< relref "/overview/csit/suite_generation" >}})
# CSIT rls2306
-- [VPP Performance](vpp_performance)
-- [DPDK Performance](dpdk_performance)
-- [TRex Performance](trex_performance)
-- [VPP Device](vpp_device)
+- [VPP Performance]({{< relref "/release_notes/csit_rls2306/vpp_performance" >}})
+- [DPDK Performance]({{< relref "/release_notes/csit_rls2306/dpdk_performance" >}})
+- [TRex Performance]({{< relref "/release_notes/csit_rls2306/trex_performance" >}})
+- [VPP Device]({{< relref "/release_notes/csit_rls2306/vpp_device" >}})
# Previous Releases
-- [CSIT rls2302](csit_rls2302)
+- [CSIT rls2302]({{< relref "/release_notes/previous/csit_rls2302" >}})
# CSIT rls2302
-- [VPP Performance](vpp_performance)
-- [DPDK Performance](dpdk_performance)
-- [TRex Performance](trex_performance)
-- [VPP Device](vpp_device)
+- [VPP Performance]({{< relref "/release_notes/previous/csit_rls2302/vpp_performance" >}})
+- [DPDK Performance]({{< relref "/release_notes/previous/csit_rls2302/dpdk_performance" >}})
+- [TRex Performance]({{< relref "/release_notes/previous/csit_rls2302/trex_performance" >}})
+- [VPP Device]({{< relref "/release_notes/previous/csit_rls2302/vpp_device" >}})