diff options
Diffstat (limited to 'docs/report/introduction')
-rw-r--r-- | docs/report/introduction/general_notes.rst | 4 | ||||
-rw-r--r-- | docs/report/introduction/methodology.rst | 10 | ||||
-rw-r--r-- | docs/report/introduction/overview.rst | 18 |
3 files changed, 16 insertions, 16 deletions
diff --git a/docs/report/introduction/general_notes.rst b/docs/report/introduction/general_notes.rst index b94a82e2dc..25f08ab8e8 100644 --- a/docs/report/introduction/general_notes.rst +++ b/docs/report/introduction/general_notes.rst @@ -62,14 +62,14 @@ is listed separately, as follows: virtual FD.io testbeds focusing on NSH_SFC of VPP. Tests cover a range of CRUD operations executed against VPP. -In addition to above, CSIT |release| report does also include VPP unit test +In addition to above, |csit-release| report does also include VPP unit test results. VPP unit tests are developed within the FD.io VPP project and as they complement CSIT system functional tests, they are provided mainly as a reference and to provide a more complete view of automated testing executed against |vpp-release|. FD.io CSIT system is developed using two main coding platforms :abbr:`RF (Robot -Framework)` and Python2.7. CSIT |release| source code for the executed test +Framework)` and Python2.7. |csit-release| source code for the executed test suites is available in CSIT branch |release| in the directory :file:`./tests/<name_of_the_test_suite>`. A local copy of CSIT source code can be obtained by cloning CSIT git repository - :command:`git clone diff --git a/docs/report/introduction/methodology.rst b/docs/report/introduction/methodology.rst index 0b1182b9b9..b5b737ec69 100644 --- a/docs/report/introduction/methodology.rst +++ b/docs/report/introduction/methodology.rst @@ -117,7 +117,7 @@ Enabled mode (two logical cores per each physical core). HT setting is applied in BIOS and requires server SUT reload for it to take effect, making it impractical for continuous changes of HT mode of operation. -CSIT |release| performance tests are executed with server SUTs' Intel +|csit-release| performance tests are executed with server SUTs' Intel XEON processors configured with Intel Hyper-Threading Disabled for all Xeon Haswell testbeds (3n-hsw) and with Intel Hyper-Threading Enabled for all Xeon Skylake testbeds. @@ -128,7 +128,7 @@ More information about physical testbeds is provided in Multi-core Tests ~~~~~~~~~~~~~~~~ -CSIT |release| multi-core tests are executed in the following VPP worker +|csit-release| multi-core tests are executed in the following VPP worker thread and physical core configurations: #. Intel Xeon Haswell testbeds (3n-hsw) with Intel HT disabled @@ -239,7 +239,7 @@ following environment settings: LXC/DRC Container Memif ----------------------- -CSIT |release| includes tests taking advantage of VPP memif virtual +|csit-release| includes tests taking advantage of VPP memif virtual interface (shared memory interface) to interconnect VPP running in Containers. VPP vswitch instance runs in bare-metal user-mode handling NIC interfaces and connecting over memif (Slave side) to VPPs running in @@ -261,7 +261,7 @@ in :ref:`container_orchestration_in_csit`. K8s Container Memif ------------------- -CSIT |release| includes tests of VPP topologies running in K8s +|csit-release| includes tests of VPP topologies running in K8s orchestrated Pods/Containers and connected over memif virtual interfaces. In order to provide simple topology coding flexibility and extensibility container orchestration is done with `Kubernetes @@ -290,7 +290,7 @@ combination with HW cryptodev devices - Intel QAT 8950 50G - present in LF FD.io physical testbeds. DPDK cryptodev can be used for all IPSec data plane functions supported by VPP. -Currently CSIT |release| implements following IPSec test cases: +Currently |csit-release| implements following IPSec test cases: - AES-GCM, CBC-SHA1 ciphers, in combination with IPv4 routed-forwarding with Intel xl710 NIC. diff --git a/docs/report/introduction/overview.rst b/docs/report/introduction/overview.rst index 2d5a1e0671..e16a6e175f 100644 --- a/docs/report/introduction/overview.rst +++ b/docs/report/introduction/overview.rst @@ -2,23 +2,23 @@ Overview ======== This is the **F**\ast **D**\ata **I**/**O** Project (**FD.io**) **C**\ontinuous -**S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for CSIT -|release| system testing of |vpp-release|. +**S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for +|csit-release| system testing of |vpp-release|. This is the full html version, there is also a reduced `PDF version of this report`_. The report describes CSIT functional and performance tests and their -continuous execution delivered in CSIT |release|. A high-level overview is +continuous execution delivered in |csit-release|. A high-level overview is provided for each CSIT test environment running in :abbr:`LF (Linux Foundation)` FD.io Continuous Performance Labs. This is followed by summary of all executed tests against the |vpp-release| and associated FD.io projects and sub-systems -(Honeycomb, DPDK, NSH_SFC), CSIT |release| release notes, result highlights and +(Honeycomb, DPDK, NSH_SFC), |csit-release| release notes, result highlights and known issues discovered in CSIT. More detailed description of each environment, pointers to CSIT test code documentation and detailed test resuls with links to the source data files are also provided. -CSIT |release| report contains following main sections and sub-sections: +|csit-release| report contains following main sections and sub-sections: #. **Introduction** - general introduction to CSIT project; *Overview* - this section; *CSIT Test Naming* - CSIT general naming convention for test @@ -29,7 +29,7 @@ CSIT |release| report contains following main sections and sub-sections: #. **VPP Performance Tests** - VPP performance tests executed in physical FD.io testbeds; *Overview* - tested topologies, test coverage and naming specifics, methodology for multi-core, packet throughput and latency, and - KVM VM vhost tests; *CSIT Release Notes* - changes in CSIT |release|, added + KVM VM vhost tests; *CSIT Release Notes* - changes in |csit-release|, added tests, performance changes, environment or methodology changes, known CSIT issues; *Packet Throughput Graphs* and *Packet Latency Graphs* - plotted NDR, PDR throughput and latency results from multiple @@ -41,7 +41,7 @@ CSIT |release| report contains following main sections and sub-sections: #. **DPDK Performance Tests** - DPDK performance tests executed in physical FD.io testbeds; *Overview* - tested topologies, test coverage; - *CSIT Release Notes* - changes in CSIT |release|, any known CSIT issues; + *CSIT Release Notes* - changes in |csit-release|, any known CSIT issues; *Packet Throughput Graphs* and *Packet Latency Graphs* - plotted NDR, PDR throughput and latency results from multiple test job executions; *Test Environment* - environment description; *Documentation* - @@ -49,7 +49,7 @@ CSIT |release| report contains following main sections and sub-sections: #. **VPP Functional Tests** - VPP functional tests executed in virtual FD.io testbeds; *Overview* - tested virtual topologies, test coverage and - naming specifics; *CSIT Release Notes* - changes in CSIT |release|, added + naming specifics; *CSIT Release Notes* - changes in |csit-release|, added tests, environment or methodology changes, known CSIT issues, tests to be added; *Test Environment* - environment description ; *Documentation* - source code documentation for VPP functional tests. @@ -84,4 +84,4 @@ CSIT |release| report contains following main sections and sub-sections: #. **CSIT Framework Documentation** - description of the overall CSIT framework design hierarchy, CSIT test naming convention, followed by description of Presentation and Analytics Layer (PAL) introduced in - CSIT |release|.
\ No newline at end of file + |csit-release|.
\ No newline at end of file |