docs/content/_index.md

   1 ---
   2 title: "FD.io CSIT"
   3 type: "docs"
   4 ---
   5
   6 # Documentation Structure
   7
   8 1. OVERVIEW: General introduction to CSIT Performance Dashboard and CSIT itself.
   9    - **[CSIT-Dash]({{< relref "/overview/c_dash/design" >}})**: The design and
  10      the structure of CSIT-Dash dashboard.
  11    - **[CSIT]({{< relref "/overview/csit/" >}})**: The design of the
  12      [FD.io](https://fd.io/) CSIT system, and the description of the test
  13      scenarios, test naming and test tags.
  14 2. METHODOLOGY
  15    - **[Overview]({{< relref "/methodology/overview/" >}})**: Terminology,
  16      per-thread resources, multi-core speedup, VPP forwarding modes and DUT
  17      state considerations.
  18    - **[Measurement]({{< relref "/methodology/measurements/" >}})**: Data plane
  19      throughput, packet latency and the telemetry.
  20    - **[Test]({{< relref "/methodology/test/" >}})**: Methodology of all tests
  21      used in CSIT.
  22    - **[Trending]({{< relref "/methodology/trending/" >}})**: A high-level
  23      design of a system for continuous performance measuring, trending and
  24      change detection for FD.io VPP SW data plane (and other performance tests
  25      run within CSIT sub-project).
  26    - **[Per-patch Testing]({{< relref "/methodology/per_patch_testing" >}})**:
  27      A methodology similar to trending analysis is used for comparing
  28      performance before a DUT code change is merged.
  29 3. RELEASE NOTES: Performance tests executed in physical FD.io testbeds.
  30    - **[{{< release_csit >}}]({{< relref "/release_notes/current/" >}})**: The
  31      release notes of the current CSIT release.
  32    - **[Previous]({{< relref "/release_notes/previous/" >}})**: Archived release
  33      notes for the past releases.
  34 4. INFRASTRUCTURE
  35    - **[FD.io DC Vexxhost Inventory]({{< relref "/infrastructure/fdio_dc_vexxhost_inventory" >}})**:
  36      Physical testbeds location.
  37    - **[FD.io DC Testbed Specifications]({{< relref "/infrastructure/fdio_dc_testbed_specifications" >}})**:
  38      Specification of the physical testbed infrastructure.
  39    - **[FD.io DC Testbed Configuration]({{< relref "/infrastructure/testbed_configuration/" >}})**:
  40      Configuration of the physical testbed infrastructure.
  41    - **[FD.io CSIT Testbed Versioning]({{< relref "/infrastructure/fdio_csit_testbed_versioning" >}})**:
  42      CSIT test environment versioning to track modifications of the test
  43      environment.
  44    - **[FD.io CSIT Logical Topologies]({{< relref "/infrastructure/fdio_csit_logical_topologies" >}})**:
  45      CSIT performance tests are executed on physical testbeds. Based on the
  46      packet path thru server SUTs, three distinct logical topology types are
  47      used for VPP DUT data plane testing.
  48    - **[VPP Startup Settings]({{< relref "/infrastructure/vpp_startup_settings" >}})**:
  49      List of common settings applied to all tests and test dependent settings.