CSIT-612 Report: Minimization of hand-crafted content.

- replace dynamic text content and links by variables.

Change-Id: I1a7ec371fc80af3c9dd416bf91dd2c639097cf1e
Signed-off-by: Peter Mikus <pmikus@cisco.com>

diff --git a/docs/report/honeycomb_functional_tests/documentation.rst b/docs/report/honeycomb_functional_tests/documentation.rst
index e53052d..7ded3d4 100644 (file)
--- a/docs/report/honeycomb_functional_tests/documentation.rst
+++ b/docs/report/honeycomb_functional_tests/documentation.rst
@@ -1,6 +1,5 @@
 Documentation\r
 =============\r
 \r
-`CSIT Honeycomb Functional Tests Documentation\r
-<https://docs.fd.io/csit/master/doc/tests.func.html>`_ contains detailed\r
+`CSIT Honeycomb Functional Tests Documentation`_ contains detailed\r
 functional description and input parameters for each test case.\r

diff --git a/docs/report/honeycomb_functional_tests/test_environment.rst b/docs/report/honeycomb_functional_tests/test_environment.rst
index 028911f..92431c6 100644 (file)
--- a/docs/report/honeycomb_functional_tests/test_environment.rst
+++ b/docs/report/honeycomb_functional_tests/test_environment.rst
@@ -13,20 +13,19 @@ versions:
 Current VPP tests have been executed on a single VM operating system and\r
 version only, as described in the following paragraphs.\r
 \r
-In CSIT terminology, the VM operating system for both SUTs and TG that VPP 17.04\r
-has been tested with, is the following:\r
+In CSIT terminology, the VM operating system for both SUTs and TG that\r
+|vpp-release| has been tested with, is the following:\r
 \r
-  ubuntu-16.04.1_2017-02-23_1.8\r
+  |virl-image-ubuntu|\r
 \r
-This image implies Ubuntu 16.04.1 LTS, current as of 2017/02/23 (that is,\r
+This image implies Ubuntu 16.04.1 LTS, current as of yyyy-mm-dd (that is,\r
 package versions are those that would have been installed by a "apt-get update",\r
-"apt-get upgrade" on February 23), produced by CSIT disk image build scripts\r
-version 1.8.\r
+"apt-get upgrade" on that day), produced by CSIT disk image build scripts.\r
 \r
 The exact list of installed packages and their versions (including the Linux\r
 kernel package version) are included in CSIT source repository:\r
 \r
-  resources/tools/disk-image-builder/ubuntu/lists/ubuntu-16.04.1_2017-02-23_1.8\r
+  resources/tools/disk-image-builder/ubuntu/lists/|virl-image-ubuntu|\r
 \r
 A replica of this VM image can be built by running the "build.sh" script in CSIT\r
 repository resources/tools/disk-image-builder/ubuntu.\r

diff --git a/docs/report/introduction/csit_tag_description.rst b/docs/report/introduction/csit_tag_description.rst
index 968db02..5ea6c7f 100644 (file)
--- a/docs/report/introduction/csit_tag_description.rst
+++ b/docs/report/introduction/csit_tag_description.rst
@@ -5,7 +5,7 @@ All CSIT test cases are labelled with Robot Framework tags used to allow for
 easy test case type identification, test case grouping and selection for
 execution. Following sections list currently used CSIT TAGs and their
 documentation based on the content of
-`tag_documentation rst file <https://git.fd.io/csit/tree/docs/tag_documentation.rst?h=rls1704>`_.
+`tag documentation rst file`_.
 
 Topology TAGs
 -------------

diff --git a/docs/report/introduction/csit_test_naming.rst b/docs/report/introduction/csit_test_naming.rst
index a4de765..682fcd9 100644 (file)
--- a/docs/report/introduction/csit_test_naming.rst
+++ b/docs/report/introduction/csit_test_naming.rst
@@ -5,12 +5,12 @@ Background
 ----------\r
 \r
 CSIT |release| follows a common structured naming convention for all\r
-performance and system functional tests, introduced in CSIT rls1701.\r
+performance and system functional tests, introduced in CSIT |release-1|.\r
 \r
 The naming should be intuitive for majority of the tests. Complete\r
 description of CSIT test naming convention is provided on\r
-`CSIT test naming wiki page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_. Below\r
-few illustrative examples of the naming usage for test suites across CSIT\r
+`CSIT test naming wiki page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.\r
+Below few illustrative examples of the naming usage for test suites across CSIT\r
 performance, functional and HoneyComb management test areas.\r
 \r
 Naming Convention\r

diff --git a/docs/report/introduction/general_notes.rst b/docs/report/introduction/general_notes.rst
index ebb73cd..5015b6b 100644 (file)
--- a/docs/report/introduction/general_notes.rst
+++ b/docs/report/introduction/general_notes.rst
@@ -40,9 +40,11 @@ is listed separately, as follows:
    functionality of VPP. Tests cover a range of CRUD operations executed\r
    against VPP.\r
 \r
-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\r
-provide a more complete view of automated testing executed against\r
-VPP-17.04 release.\r
+In addition to above, CSIT |release| report does also include VPP unit test\r
+results. VPP unit tests are developed within the FD.io VPP project and as they\r
+complement CSIT system functional tests, they are provided mainly as a reference\r
+and to provide a more complete view of automated testing executed against\r
+|vpp-release|.\r
 \r
 FD.io CSIT system is developed using two main coding platforms: Robot\r
 Framework (RF) and Python. CSIT |release| source code for the executed test\r
@@ -52,4 +54,4 @@ obtained by cloning CSIT git repository - "git clone
 https://gerrit.fd.io/r/csit". The CSIT testing virtual environment can be run\r
 on a local computer workstation (laptop, server) using Vagrant by following\r
 the instructions in `CSIT tutorials\r
-<https://wiki.fd.io/view/CSIT#Tutorials>`_.
\ No newline at end of file
+<https://wiki.fd.io/view/CSIT#Tutorials>`_.\r

diff --git a/docs/report/introduction/overview.rst b/docs/report/introduction/overview.rst
index 97b6abc..30f62a9 100644 (file)
--- a/docs/report/introduction/overview.rst
+++ b/docs/report/introduction/overview.rst
@@ -3,17 +3,17 @@ Overview
 \r
 This is the **F**\ast **D**\ata **I**/**O** Project (**FD.io**) **C**\ontinuous\r
 **S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for CSIT\r
-|release| system testing of VPP-17.04 release.\r
+|release| system testing of |vpp-release|.\r
 \r
 The report describes CSIT functional and performance tests and their\r
 continuous execution delivered in CSIT |release|. A high-level overview is\r
 provided for each CSIT test environment running in Linux Foundation (LF) FD.io\r
 Continuous Performance Labs. This is followed by summary of all executed tests\r
-against the VPP-17.04 release and associated FD.io projects and sub-systems (HoneyComb, DPDK),\r
-CSIT |release| release notes, result highlights and known issues discovered in CSIT. More\r
-detailed description of each environment, pointers to CSIT test code\r
-documentation and detailed test resuls with links to the source data files are\r
-also provided.\r
+against the |vpp-release| and associated FD.io projects and sub-systems\r
+(HoneyComb, DPDK), CSIT |release| release notes, result highlights and known\r
+issues discovered in CSIT. More detailed description of each environment,\r
+pointers to CSIT test code documentation and detailed test resuls with links to\r
+the source data files are also provided.\r
 \r
 CSIT |release| report contains following main sections and sub-sections:\r
 \r

diff --git a/docs/report/testpmd_performance_tests/documentation.rst b/docs/report/testpmd_performance_tests/documentation.rst
index 4a0fe5d..67aae66 100644 (file)
--- a/docs/report/testpmd_performance_tests/documentation.rst
+++ b/docs/report/testpmd_performance_tests/documentation.rst
@@ -1,6 +1,5 @@
 Documentation\r
 =============\r
 \r
-`CSIT Testpmd Performance Tests Documentation\r
-<https://docs.fd.io/csit/rls1704/doc/tests.perf.html>`_ contains  detailed\r
+`CSIT Testpmd Performance Tests Documentation`_ contains  detailed\r
 functional description and input parameters for each test case.\r

diff --git a/docs/report/testpmd_performance_tests/overview.rst b/docs/report/testpmd_performance_tests/overview.rst
index 2182a00..78d2148 100644 (file)
--- a/docs/report/testpmd_performance_tests/overview.rst
+++ b/docs/report/testpmd_performance_tests/overview.rst
@@ -42,7 +42,8 @@ tested NIC models include:
 #. 2port40GE VIC1385 Cisco.
 #. 2port40GE XL710 Intel.
 
-For detailed LF FD.io test bed specification and physical topology please refer to `LF FDio CSIT testbed wiki page <https://wiki.fd.io/view/CSIT/CSIT_LF_testbed>`_.
+For detailed LF FD.io test bed specification and physical topology please refer
+to `LF FDio CSIT testbed wiki page <https://wiki.fd.io/view/CSIT/CSIT_LF_testbed>`_.
 
 Performance Tests Coverage
 --------------------------
@@ -150,4 +151,4 @@ Reported latency values are measured using following methodology:
 - TRex setup introduces an always-on error of about 2*2usec per latency flow -
   additonal Tx/Rx interface latency induced by TRex SW writing and reading
   packet timestamps on CPU cores without HW acceleration on NICs closer to the
-  interface line.
\ No newline at end of file
+  interface line.

diff --git a/docs/report/testpmd_performance_tests/packet_latency_graphs/index.rst b/docs/report/testpmd_performance_tests/packet_latency_graphs/index.rst
index fb16912..7252e2e 100644 (file)
--- a/docs/report/testpmd_performance_tests/packet_latency_graphs/index.rst
+++ b/docs/report/testpmd_performance_tests/packet_latency_graphs/index.rst
@@ -7,21 +7,20 @@ latency per test.
 
 *Title of each graph* is a regex (regular expression) matching all
 throughput test cases plotted on this graph, *X-axis labels* are indices
-of individual test suites executed by csit-dpdk-perf-1704-all job that
-created result output file used as data source for the graph, *Y-axis
-labels* are measured packet Latency [uSec] values, and the *Graph
-legend* lists the plotted test suites and their indices. Latency is
-reported for concurrent symmetric bi-directional flows, separately for
-each direction: i) West-to-East: TGint1-to-SUT1-to-SUT2-to-TGint2, and
-ii) East-to-West: TGint2-to-SUT2-to-SUT1-to-TGint1.
+of individual test suites executed by
+`FD.io test executor dpdk performance jobs`_ that created result output file
+used as data source for the graph, *Y-axis labels* are measured packet Latency
+[uSec] values, and the *Graph legend* lists the plotted test suites and their
+indices. Latency is reported for concurrent symmetric bi-directional flows,
+separately for each direction: i) West-to-East:
+TGint1-to-SUT1-to-SUT2-to-TGint2, and ii) East-to-West:
+TGint2-to-SUT2-to-SUT1-to-TGint1.
 
 .. note::
 
-    Test results have been generated by FD.io test executor jobs
-    `csit-dpdk-perf-1704-all
-    <https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-1704-all/>`_,
-    with Robot Framework result files csit-dpdk-perf-1704-all-1.zip
-    `archived here <../../_static/archive/>`_.
+    Test results have been generated by
+    `FD.io test executor dpdk performance jobs`_ with Robot Framework result
+    files csit-dpdk-perf-\*.zip `archived here <../../_static/archive/>`_.
 
 .. toctree::
 

diff --git a/docs/report/testpmd_performance_tests/packet_throughput_graphs/index.rst b/docs/report/testpmd_performance_tests/packet_throughput_graphs/index.rst
index d607b6e..84d0603 100644 (file)
--- a/docs/report/testpmd_performance_tests/packet_throughput_graphs/index.rst
+++ b/docs/report/testpmd_performance_tests/packet_throughput_graphs/index.rst
@@ -19,20 +19,19 @@ have the same value, only a horizontal line is plotted.
 
 *Title of each graph* is a regex (regular expression) matching all
 throughput test cases plotted on this graph, *X-axis labels* are indices
-of individual test suites executed by csit-dpdk-perf-1704-all jobs that
-created result output files used as data sources for the graph, *Y-axis
-labels* are measured Packets Per Second [pps] values, and the *Graph
-legend* lists the plotted test suites and their indices.
+of individual test suites executed by
+`FD.io test executor dpdk performance jobs`_ jobs that created result output
+files used as data sources for the graph, *Y-axis labels* are measured Packets
+Per Second [pps] values, and the *Graph legend* lists the plotted test suites
+and their indices.
 
 .. note::
 
-    Test results have been generated by FD.io test executor jobs
-    `csit-dpdk-perf-1704-all
-    <https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-1704-all/>`_,
-    with Robot Framework result files csit-dpdk-perf-1704-all-<id>.zip
-    `archived here <../../_static/archive/>`_. Plotted data set size per
-    test case is equal to the number of job executions presented in this
-    report version: **10**.
+    Test results have been generated by
+    `FD.io test executor dpdk performance jobs`_ with Robot Framework result
+    files csit-dpdk-perf-\*.zip `archived here <../../_static/archive/>`_.
+    Plotted data set size per test case is equal to the number of job executions
+    presented in this report version: **10**.
 
 .. toctree::
 

diff --git a/docs/report/testpmd_performance_tests/test_environment.rst b/docs/report/testpmd_performance_tests/test_environment.rst
index dd51137..d7d960f 100644 (file)
--- a/docs/report/testpmd_performance_tests/test_environment.rst
+++ b/docs/report/testpmd_performance_tests/test_environment.rst
@@ -3498,7 +3498,7 @@ DUT Configuration - DPDK
 \r
 **DPDK Version**\r
 \r
-17.02\r
+|dpdk-release|\r
 \r
 **DPDK Compile Parameters**\r
 \r
@@ -3535,15 +3535,15 @@ TG Configuration - TRex
 \r
 **TG Version**\r
 \r
-TRex v2.09\r
+|trex-release|\r
 \r
 **DPDK version**\r
 \r
-DPDK v16.07 (20e2b6eba13d9eb61b23ea75f09f2aa966fa6325 - in DPDK repo)\r
+DPDK v17.02 (f4decdc59e9323ecff5ddb5de7ebf0c79d50a960 - in DPDK repo)\r
 \r
 **TG Build Script used**\r
 \r
-https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-installer.sh;h=e89b06f9b12499996df18e5e3399fcd660ebc017;hb=refs/heads/rls1701\r
+`TRex intallation`_\r
 \r
 **TG Startup Configuration**\r
 \r
@@ -3561,5 +3561,5 @@ https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-in
 \r
 **TG common API - pointer to driver**\r
 \r
-https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-stateless.py;h=24f4a997389ba3f10ad42e1f9564ef915fd58b44;hb=refs/heads/rls1701\r
+`TRex driver`_\r
 \r

diff --git a/docs/report/vpp_functional_tests/documentation.rst b/docs/report/vpp_functional_tests/documentation.rst
index d34877b..e0f180c 100644 (file)
--- a/docs/report/vpp_functional_tests/documentation.rst
+++ b/docs/report/vpp_functional_tests/documentation.rst
@@ -1,7 +1,6 @@
 Documentation\r
 =============\r
 \r
-`CSIT VPP Functional Tests Documentation\r
-<https://docs.fd.io/csit/rls1704/doc/tests.func.html>`_ contains detailed\r
+`CSIT VPP Functional Tests Documentation`_ contains detailed\r
 functional description and input parameters for each test case.\r
 \r

diff --git a/docs/report/vpp_functional_tests/overview.rst b/docs/report/vpp_functional_tests/overview.rst
index 0fa15a5..a6de3f3 100644 (file)
--- a/docs/report/vpp_functional_tests/overview.rst
+++ b/docs/report/vpp_functional_tests/overview.rst
@@ -132,7 +132,7 @@ Functional Tests Naming
 -----------------------\r
 \r
 CSIT |release| follows a common structured naming convention for all\r
-performance and system functional tests, introduced in CSIT rls1701.\r
+performance and system functional tests, introduced in CSIT |release-1|.\r
 \r
 The naming should be intuitive for majority of the tests. Complete\r
 description of CSIT test naming convention is provided on `CSIT test naming\r

diff --git a/docs/report/vpp_functional_tests/test_environment.rst b/docs/report/vpp_functional_tests/test_environment.rst
index fc7c633..8add531 100644 (file)
--- a/docs/report/vpp_functional_tests/test_environment.rst
+++ b/docs/report/vpp_functional_tests/test_environment.rst
@@ -30,14 +30,14 @@ SUT Configuration - VIRL Guest VM
 Configuration of the SUT VMs is defined in file\r
 \r
    /csit/resources/tools/virl/topologies/double-ring-nested.xenial.virl\r
-   \r
+\r
 - List of SUT VM interfaces:::\r
 \r
     <interface id="0" name="GigabitEthernet0/4/0"/>\r
     <interface id="1" name="GigabitEthernet0/5/0"/>\r
     <interface id="2" name="GigabitEthernet0/6/0"/>\r
     <interface id="3" name="GigabitEthernet0/7/0"/>\r
-    \r
+\r
 - Number of 2MB hugepages: 1024\r
 \r
 - Maximum number of memory map areas: 20000\r
@@ -47,25 +47,24 @@ Configuration of the SUT VMs is defined in file
 SUT Configuration - VIRL Guest OS Linux\r
 ---------------------------------------\r
 \r
-In CSIT terminology, the VM operating system for both SUTs that VPP 17.01 has\r
+In CSIT terminology, the VM operating system for both SUTs that |vpp-release| has\r
 been tested with, is the following:\r
 \r
-**#. ubuntu-16.04.1_2016-12-19_1.6**\r
+**#. |virl-image-ubuntu|**\r
 \r
-This image implies Ubuntu 16.04.1 LTS, current as of 2016/12/19 (that is,\r
+This image implies Ubuntu 16.04.1 LTS, current as of yyyy-mm-dd (that is,\r
 package versions are those that would have been installed by a "apt-get update",\r
-"apt-get upgrade" on December 19), produced by CSIT disk image build scripts\r
-version 1.6.\r
+"apt-get upgrade" on that day), produced by CSIT disk image build scripts.\r
 \r
 The exact list of installed packages and their versions (including the Linux\r
 kernel package version) are included in CSIT source repository:\r
 \r
-  resources/tools/disk-image-builder/ubuntu/lists/ubuntu-16.04.1_2016-12-19_1.6\r
+  resources/tools/disk-image-builder/ubuntu/lists/|virl-image-ubuntu|\r
 \r
 A replica of this VM image can be built by running the "build.sh" script in CSIT\r
 repository resources/tools/disk-image-builder/ubuntu.\r
 \r
-**#. centos-7.3-1611_2017-01-24_1.2**\r
+**#. |virl-image-centos|**\r
 \r
 The Centos7.3 image is ready to be used but no tests running on it now.\r
 Corresponding Jenkins jobs are under preparation.\r
@@ -73,7 +72,7 @@ Corresponding Jenkins jobs are under preparation.
 The exact list of installed packages and their versions (including the Linux\r
 kernel package version) are included in CSIT source repository:\r
 \r
-  resources/tools/disk-image-builder/ubuntu/lists/centos-7.3-1611_2017-01-24_1.2\r
+  resources/tools/disk-image-builder/ubuntu/lists/|virl-image-centos|\r
 \r
 A replica of this VM image can be built by running the "build.sh" script in CSIT\r
 repository resources/tools/disk-image-builder/centos.\r
@@ -106,7 +105,7 @@ Port configuration of DUTs is defined in topology file that is generated per
 VIRL simulation based on the definition stored in file\r
 \r
    /csit/resources/tools/virl/topologies/double-ring-nested.xenial.yaml\r
-   \r
+\r
 Example of DUT nodes configuration:::\r
 \r
     DUT1:\r
@@ -224,7 +223,7 @@ Example of DUT nodes configuration:::
 \r
 **VPP Version**\r
 \r
-17.01-release_amd64\r
+|vpp-release|\r
 \r
 **VPP Installed Packages**\r
 ::\r
@@ -235,13 +234,13 @@ Example of DUT nodes configuration:::
     |/ Err?=(none)/Reinst-required (Status,Err: uppercase=bad)\r
     ||/ Name           Version       Architecture Description\r
     +++-==============-=============-============-=============================================\r
-    ii  vpp            17.01-release amd64        Vector Packet Processing--executables\r
-    ii  vpp-dbg        17.01-release amd64        Vector Packet Processing--debug symbols\r
-    ii  vpp-dev        17.01-release amd64        Vector Packet Processing--development support\r
-    ii  vpp-dpdk-dev   17.01-release amd64        Vector Packet Processing--development support\r
-    ii  vpp-dpdk-dkms  17.01-release amd64        DPDK 2.1 igb_uio_driver\r
-    ii  vpp-lib        17.01-release amd64        Vector Packet Processing--runtime libraries\r
-    ii  vpp-plugins    17.01-release amd64        Vector Packet Processing--runtime plugins\r
+    ii  vpp            17.07-release amd64        Vector Packet Processing--executables\r
+    ii  vpp-dbg        17.07-release amd64        Vector Packet Processing--debug symbols\r
+    ii  vpp-dev        17.07-release amd64        Vector Packet Processing--development support\r
+    ii  vpp-dpdk-dev   17.07-release amd64        Vector Packet Processing--development support\r
+    ii  vpp-dpdk-dkms  17.07-release amd64        DPDK 2.1 igb_uio_driver\r
+    ii  vpp-lib        17.07-release amd64        Vector Packet Processing--runtime libraries\r
+    ii  vpp-plugins    17.07-release amd64        Vector Packet Processing--runtime plugins\r
 \r
 **VPP Startup Configuration**\r
 \r
@@ -439,5 +438,5 @@ Example of TG node configuration:::
 **Traffic generator**\r
 \r
 Functional tests utilize Scapy as a traffic generator. There was used Scapy\r
-v2.3.1 for VPP 17.01 tests.\r
+v2.3.1 for |vpp-release| tests.\r
 \r

diff --git a/docs/report/vpp_performance_tests/csit_release_notes.rst b/docs/report/vpp_performance_tests/csit_release_notes.rst
index 2c0aaf7..a4077c1 100644 (file)
--- a/docs/report/vpp_performance_tests/csit_release_notes.rst
+++ b/docs/report/vpp_performance_tests/csit_release_notes.rst
@@ -48,7 +48,7 @@ Performance Improvements
 Substantial improvements in measured packet throughput have been\r
 observed in a number of CSIT |release| tests listed below, with relative\r
 increase  of double-digit percentage points. Relative improvements are\r
-calculated against the test results listed in CSIT rls1701 report.\r
+calculated against the test results listed in CSIT |release-1| report.\r
 VPP-16.09 numbers are provided for reference.\r
 \r
 NDR Throughput\r
@@ -119,7 +119,7 @@ Other Performance Changes
 Other changes in measured packet throughput, with either minor relative\r
 increase or decrease, have been observed in a number of CSIT |release|\r
 tests listed below. Relative changes are calculated against the test\r
-results listed in CSIT rls1701 report.\r
+results listed in CSIT |release-1| report.\r
 \r
 NDR Throughput\r
 ~~~~~~~~~~~~~~\r

diff --git a/docs/report/vpp_performance_tests/documentation.rst b/docs/report/vpp_performance_tests/documentation.rst
index b282c2a..9f0d0a4 100644 (file)
--- a/docs/report/vpp_performance_tests/documentation.rst
+++ b/docs/report/vpp_performance_tests/documentation.rst
@@ -1,6 +1,5 @@
 Documentation\r
 =============\r
 \r
-`CSIT VPP Performance Tests Documentation\r
-<https://docs.fd.io/csit/rls1704/doc/tests.perf.html>`_ contains detailed\r
+`CSIT VPP Performance Tests Documentation`_ contains detailed\r
 functional description and input parameters for each test case.\r

diff --git a/docs/report/vpp_performance_tests/overview.rst b/docs/report/vpp_performance_tests/overview.rst
index 3ee9b2b..ccf8063 100644 (file)
--- a/docs/report/vpp_performance_tests/overview.rst
+++ b/docs/report/vpp_performance_tests/overview.rst
@@ -194,7 +194,7 @@ Performance Tests Naming
 ------------------------
 
 CSIT |release| follows a common structured naming convention for all
-performance and system functional tests, introduced in CSIT rls1701.
+performance and system functional tests, introduced in CSIT |release-1|.
 
 The naming should be intuitive for majority of the tests. Complete
 description of CSIT test naming convention is provided on `CSIT test naming wiki
@@ -313,8 +313,8 @@ Methodology: KVM VM vhost
 -------------------------
 
 CSIT |release| introduced environment configuration changes to KVM Qemu vhost-
-user tests in order to more representatively measure VPP-17.04 performance in
-configurations with vhost-user interfaces and VMs.
+user tests in order to more representatively measure |vpp-release| performance
+in configurations with vhost-user interfaces and VMs.
 
 Current setup of CSIT FD.io performance lab is using tuned settings for more
 optimal performance of KVM Qemu:
@@ -357,7 +357,7 @@ specific configuration.
 TRex is installed and run on the TG compute node. The typical procedure is:
 
     - If the TRex is not already installed on TG, it is installed in the
-      suite setup phase - see `TRex intallation <https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-installer.sh;h=8090b7568327ac5f869e82664bc51b24f89f603f;hb=refs/heads/rls1704>`_.
+      suite setup phase - see `TRex intallation`_.
     - TRex configuration is set in its configuration file
       ::
 
@@ -366,7 +366,7 @@ TRex is installed and run on the TG compute node. The typical procedure is:
     - TRex is started in the background mode
       ::
 
-        sh -c 'cd /opt/trex-core-2.22/scripts/ && sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &' > /dev/null
+        sh -c 'cd /opt/trex-core-2.25/scripts/ && sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &' > /dev/null
 
     - There are traffic streams dynamically prepared for each test. The traffic
       is sent and the statistics obtained using trex_stl_lib.api.STLClient.

diff --git a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
index f717094..307bf3c 100644 (file)
--- a/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_latency_graphs/index.rst
@@ -7,21 +7,20 @@ latency per test.
 
 *Title of each graph* is a regex (regular expression) matching all
 throughput test cases plotted on this graph, *X-axis labels* are indices
-of individual test suites executed by csit-vpp-perf-1704-all job that
-created result output file used as data source for the graph, *Y-axis
-labels* are measured packet Latency [uSec] values, and the *Graph
-legend* lists the plotted test suites and their indices. Latency is
-reported for concurrent symmetric bi-directional flows, separately for
-each direction: i) West-to-East: TGint1-to-SUT1-to-SUT2-to-TGint2, and
-ii) East-to-West: TGint2-to-SUT2-to-SUT1-to-TGint1.
+of individual test suites executed by
+`FD.io test executor vpp performance jobs`_ that created result output file
+used as data source for the graph, *Y-axis labels* are measured packet Latency
+[uSec] values, and the *Graph legend* lists the plotted test suites and their
+indices. Latency is reported for concurrent symmetric bi-directional flows,
+separately for each direction: i) West-to-East:
+TGint1-to-SUT1-to-SUT2-to-TGint2, and ii) East-to-West:
+TGint2-to-SUT2-to-SUT1-to-TGint1.
 
 .. note::
 
-    Test results have been generated by FD.io test executor jobs
-    `csit-vpp-perf-1704-all
-    <https://jenkins.fd.io/view/csit/job/csit-vpp-perf-1704-all/>`_,
-    with Robot Framework result files csit-vpp-perf-1704-all-6.zip
-    `archived here <../../_static/archive/>`_.
+    Test results have been generated by
+    `FD.io test executor vpp performance jobs`_ with Robot Framework result
+    files csit-vpp-perf-\*.zip `archived here <../../_static/archive/>`_.
 
 .. toctree::
 

diff --git a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
index d744ef0..c203aa1 100644 (file)
--- a/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
+++ b/docs/report/vpp_performance_tests/packet_throughput_graphs/index.rst
@@ -19,20 +19,20 @@ have the same value, only a horizontal line is plotted.
 
 *Title of each graph* is a regex (regular expression) matching all
 throughput test cases plotted on this graph, *X-axis labels* are indices
-of individual test suites executed by csit-vpp-perf-1704-all jobs that
-created result output files used as data sources for the graph, *Y-axis
-labels* are measured Packets Per Second [pps] values, and the *Graph
-legend* lists the plotted test suites and their indices.
+of individual test suites executed by
+`FD.io test executor vpp performance jobs`_ jobs that created result output
+files used as data sources for the graph, *Y-axis labels* are measured Packets
+Per Second [pps] values, and the *Graph legend* lists the plotted test suites
+and their indices.
+
 
 .. note::
 
-    Test results have been generated by FD.io test executor jobs
-    `csit-vpp-perf-1704-all
-    <https://jenkins.fd.io/view/csit/job/csit-vpp-perf-1704-all/>`_,
-    with Robot Framework result files csit-vpp-perf-1704-all-<id>.zip
-    `archived here <../../_static/archive/>`_. Plotted data set size per
-    test case is equal to the number of job executions presented in this
-    report version: **10**.
+    Test results have been generated by
+    `FD.io test executor vpp performance jobs`_ with Robot Framework result
+    files csit-vpp-perf-\*.zip `archived here <../../_static/archive/>`_.
+    Plotted data set size per test case is equal to the number of job executions
+    presented in this report version: **10**.
 
 .. toctree::
 

diff --git a/docs/report/vpp_performance_tests/test_environment.rst b/docs/report/vpp_performance_tests/test_environment.rst
index 7198b01..a232650 100644 (file)
--- a/docs/report/vpp_performance_tests/test_environment.rst
+++ b/docs/report/vpp_performance_tests/test_environment.rst
@@ -3497,11 +3497,11 @@ DUT Configuration - VPP
 \r
 **VPP Version**\r
 \r
-17.01-release_amd64\r
+|vpp-release|\r
 \r
 **VPP Compile Parameters**\r
 \r
-VPP Compile Job: https://jenkins.fd.io/view/vpp/job/vpp-merge-1701-ubuntu1604/\r
+`FD.io VPP compile job`_\r
 \r
 **VPP Install Parameters**\r
 \r
@@ -3539,6 +3539,7 @@ Tagged by **1T1C**::
         dev 0000:0a:00.0\r
         no-multi-seg\r
     }\r
+    heapsize 3G\r
     ip6 {\r
         hash-buckets 2000000\r
         heap-size 3G\r
@@ -3559,6 +3560,7 @@ Tagged by **2T1C**::
     cpu {\r
         main-core 0 corelist-workers 1,2\r
     }\r
+    heapsize 3G\r
     dpdk {\r
         socket-mem 1024,1024\r
         dev default {\r
@@ -3588,6 +3590,7 @@ Tagged by **4T4C**::
     cpu {\r
         main-core 0 corelist-workers 1,2,3,4\r
     }\r
+    heapsize 3G\r
     dpdk {\r
         socket-mem 1024,1024\r
         dev default {\r
@@ -3608,7 +3611,7 @@ TG Configuration - TRex
 \r
 **TG Version**\r
 \r
-TRex v2.22\r
+|trex-release|\r
 \r
 **DPDK version**\r
 \r
@@ -3616,7 +3619,7 @@ DPDK v17.02 (f4decdc59e9323ecff5ddb5de7ebf0c79d50a960 - in DPDK repo)
 \r
 **TG Build Script used**\r
 \r
-https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-installer.sh;h=8090b7568327ac5f869e82664bc51b24f89f603f;hb=refs/heads/rls1704\r
+`TRex intallation`_\r
 \r
 **TG Startup Configuration**\r
 \r
@@ -3634,4 +3637,4 @@ https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-in
 \r
 **TG common API - pointer to driver**\r
 \r
-https://gerrit.fd.io/r/gitweb?p=csit.git;a=blob;f=resources/tools/t-rex/t-rex-stateless.py;h=ae8d18767013ebecb0bec6c732ac66e483408661;hb=refs/heads/rls1704\r
+`TRex driver`_\r

diff --git a/docs/report/vpp_unit_tests/documentation.rst b/docs/report/vpp_unit_tests/documentation.rst
index 6a8ed89..304db11 100644 (file)
--- a/docs/report/vpp_unit_tests/documentation.rst
+++ b/docs/report/vpp_unit_tests/documentation.rst
@@ -3,4 +3,4 @@ Documentation
 \r
 For complete description of the VPP Test Framework including anatomy of a test\r
 case and detailed documentation of existing VPP unit test cases please refer\r
-to the `VPP test framework documentation <https://docs.fd.io/vpp/17.04/vpp_make_test/html/>`_.\r
+to the `VPP test framework documentation`_.\r

diff --git a/docs/report/vpp_unit_tests/overview.rst b/docs/report/vpp_unit_tests/overview.rst
index 4ef50f5..c980883 100644 (file)
--- a/docs/report/vpp_unit_tests/overview.rst
+++ b/docs/report/vpp_unit_tests/overview.rst
@@ -5,7 +5,7 @@ Overview
 \r
     This section includes an abbreviated version of the VPP Test Framework\r
     overview maintained within the VPP project. Complete overview can be found\r
-    in `VPP test framework documentation <https://docs.fd.io/vpp/17.04/vpp_make_test/html/>`_.\r
+    in `VPP test framework documentation`_.\r
 \r
 VPP Unit Test Framework\r
 -----------------------\r
@@ -27,7 +27,7 @@ Framework.
 \r
 For complete description of the VPP Test Framework including anatomy of a test\r
 case and detailed documentation of existing VPP unit test cases please refer\r
-to the `VPP test framework documentation <https://docs.fd.io/vpp/17.04/vpp_make_test/html/>`_\r
+to the `VPP test framework documentation`_\r
 \r
 Unit Tests Coverage\r
 -------------------\r

diff --git a/resources/tools/report_gen/conf.py b/resources/tools/report_gen/conf.py
index 12944e4..50523d4 100644 (file)
--- a/resources/tools/report_gen/conf.py
+++ b/resources/tools/report_gen/conf.py
@@ -57,6 +57,28 @@ author = u'FD.io CSIT'
 # The full version, including alpha/beta/rc tags.
 #release = u''
 
+rst_epilog = """
+.. |release-1| replace:: rls1704
+.. |vpp-release| replace:: VPP-17.07 release
+.. |vpp-release-1| replace:: VPP-17.04 release
+.. |dpdk-release| replace:: DPDK 17.02
+.. |trex-release| replace:: TRex v2.25
+.. |virl-image-ubuntu| replace:: ubuntu-16.04.1_2017-02-23_1.8
+.. |virl-image-centos| replace:: centos-7.3-1611_2017-02-23_1.4
+
+.. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h=rls1704
+.. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/t-rex/t-rex-installer.sh?h=rls1704
+.. _TRex driver: https://git.fd.io/csit/tree/resources/tools/t-rex/t-rex-stateless.py?h=rls1704
+.. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.func.html
+.. _CSIT Testpmd Performance Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.perf.html
+.. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.func.html
+.. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/rls1704/doc/tests.perf.html
+.. _VPP test framework documentation: https://docs.fd.io/vpp/17.04/vpp_make_test/html/
+.. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-1704-all
+.. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-1704-all
+.. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-1704-ubuntu1604/
+"""
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
@@ -107,7 +129,7 @@ html_context = {
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = u'CSIT 17.01 report'
+htmlhelp_basename = u'CSIT 17.07 report'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -133,7 +155,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'CSIT1701report.tex', u'CSIT 17.01 report',
+    (master_doc, 'CSIT1707report.tex', u'CSIT 17.07 report',
      u'cisco', 'manual'),
 ]
 
@@ -143,7 +165,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'csit1701report', u'CSIT 17.01 report',
+    (master_doc, 'csit1707report', u'CSIT 17.07 report',
      [author], 1)
 ]
 
@@ -154,7 +176,7 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'CSIT1701report', u'CSIT 17.01 report',
-     author, 'CSIT1701report', 'One line description of project.',
+    (master_doc, 'CSIT1707report', u'CSIT 17.07 report',
+     author, 'CSIT1707report', 'One line description of project.',
      'Miscellaneous'),
 ]