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