X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fcontent%2F_index.md;h=9c09aa81ed374b406c4806babc76ead25b03441d;hb=ea81830e9d656edf42844526d0a50533ff3c41ce;hp=15cd1ec3f19847cda8db04e6ffc781c7219364d3;hpb=de72298ead9d9564f7c2b9647226f48c47e9e0bf;p=csit.git diff --git a/docs/content/_index.md b/docs/content/_index.md index 15cd1ec3f1..9c09aa81ed 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -3,39 +3,47 @@ title: "FD.io CSIT" type: "docs" --- -# Report Structure +# Documentation Structure -FD.io CSIT Dashboard Documentation contains system performance and functional -testing data. - -Documentation is structured as follows: - -1. INTRODUCTION: General introduction to CSIT Performance Dashboard. - - **Dashboard History**: Version changes. - - **Test Scenarios Overview**: A brief overview of test scenarios - covered in this report. - - **Design**: Framework modular design hierarchy. - - **Test Naming**: Test naming convention. - - **Test Tags Descriptions**: Robot Framework Tags used for test suite and - test case grouping and selection. -2. METHODOLOGY: - - **Overview**: Tested logical topologies, test coverage and naming - specifics. -3. RELEASE NOTES: Performance tests executed in physical FD.io - testbeds. - - **VPP Performance**: Changes, added tests, environment or methodology - changes, known issues. - - **DPDK Performance**: Changes, added tests, environment or methodology - changes, known issues. - - **TRex Performance**: Changes, added tests, environment or methodology - changes, known issues. - - **VPP Device**: Changes, added tests, environment or methodology - changes, known issues. -4. INFRASTRUCTURE: - - **FD.io DC Vexxhost Inventory**: Physical testbeds location. - - **FD.io CSIT Testbed Specifications**: Specification of the physical - testbed infrastructure. - - **FD.io CSIT Testbed Configuration**: Configuration of the physical - testbed infrastructure. - - **FD.io CSIT Testbed Versioning**: CSIT testbed versioning. - - **FD.io CSIT Logical Topologies**: CSIT Logical Topologies. +1. OVERVIEW: General introduction to CSIT Performance Dashboard and CSIT itself. + - **[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]({{< relref "/infrastructure/fdio_dc_testbed_specifications" >}})**: + Specification of the physical testbed infrastructure. + - **[FD.io DC Testbed Configuration]({{< relref "/infrastructure/testbed_configuration/" >}})**: + Configuration of the physical testbed infrastructure. + - **[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]({{< 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]({{< relref "/infrastructure/vpp_startup_settings" >}})**: + List of common settings applied to all tests and test dependent settings.