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