fix(Docs): Report section updates

Signed-off-by: pmikus <pmikus@cisco.com>
Change-Id: Icd04b75d320f067bd66402d5bb499070ee2768f3

diff --git a/docs/report/introduction/documentation/index.rst b/docs/report/introduction/documentation/index.rst
index 5975fb9..42afab7 100644 (file)
--- a/docs/report/introduction/documentation/index.rst
+++ b/docs/report/introduction/documentation/index.rst
@@ -8,6 +8,5 @@ Documentation
 
 .. toctree::
 
 
 .. toctree::
 

-    containers

     documentation
 
     documentation
 

diff --git a/docs/report/introduction/methodology.rst b/docs/report/introduction/methodology.rst
index 3e1030b..3fcd5be 100644 (file)
--- a/docs/report/introduction/methodology.rst
+++ b/docs/report/introduction/methodology.rst
@@ -24,6 +24,7 @@ Test Methodology
     methodology_reconf
     methodology_vpp_startup_settings
     methodology_kvm_vms_vhost_user
     methodology_reconf
     methodology_vpp_startup_settings
     methodology_kvm_vms_vhost_user

+    methodology_containers

     methodology_lxc_drc_container_memif
     methodology_nfv_service_density
     methodology_vpp_device_functional
     methodology_lxc_drc_container_memif
     methodology_nfv_service_density
     methodology_vpp_device_functional

diff --git a/docs/report/introduction/methodology_aws/aws_ami.rst b/docs/report/introduction/methodology_aws/aws_ami.rst
index 2a94a6b..0eebdf9 100644 (file)
--- a/docs/report/introduction/methodology_aws/aws_ami.rst
+++ b/docs/report/introduction/methodology_aws/aws_ami.rst
@@ -1,14 +1,15 @@
-AWS Amazon Machine Images
--------------------------
+Amazon Machine Images
+---------------------

 
 

-An Amazon Machine Image (AMI) provides the information required to launch an
-instance. CSIT is using Amazon EBS where the root device for an instance
-launched from the AMI is an Amazon Elastic Block Store (Amazon EBS) volume
-created from an Amazon EBS snapshot.
+An :abbr:`AMI (Amazon Machine Image)` provides the information required to
+launch an instance. CSIT is using Amazon :abbr:`EBS (Elastic Block Store)` where
+the root device for an instance launched from the AMI is a volume created from
+an Amazon EBS snapshot.

 
 A the TG and SUT instances have slightly different software requirements,
 we are defining two AMIs for TG and SUT separately. AMI details examples:
 
 
 A the TG and SUT instances have slightly different software requirements,
 we are defining two AMIs for TG and SUT separately. AMI details examples:
 

+TG:

 - AMI Name: csit_c5n_ubuntu_focal_tg
 - Platform details: Linux/UNIX
 - Architecture: x86_64
 - AMI Name: csit_c5n_ubuntu_focal_tg
 - Platform details: Linux/UNIX
 - Architecture: x86_64


@@ -19,6 +20,7 @@ we are defining two AMIs for TG and SUT separately. AMI details examples:
 - Root Device Name: /dev/sda1
 - Root Device Type: ebs
 
 - Root Device Name: /dev/sda1
 - Root Device Type: ebs
 

+SUT:

 - AMI Name: csit_c5n_ubuntu_focal_sut
 - Platform details: Linux/UNIX
 - Architecture: x86_64
 - AMI Name: csit_c5n_ubuntu_focal_sut
 - Platform details: Linux/UNIX
 - Architecture: x86_64


@@ -40,7 +42,4 @@ part of automated scripts. To create CSIT AMIs:
 
 Building AMIs requires Hashicorp Packer with Amazon plugin installed.
 
 
 Building AMIs requires Hashicorp Packer with Amazon plugin installed.
 

-Reference
----------
-

 .. [aws_ami] `Amazon Machine Images <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`_
 .. [aws_ami] `Amazon Machine Images <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html>`_

diff --git a/docs/report/introduction/methodology_aws/aws_instances.rst b/docs/report/introduction/methodology_aws/aws_instances.rst
index 204c15e..0df0321 100644 (file)
--- a/docs/report/introduction/methodology_aws/aws_instances.rst
+++ b/docs/report/introduction/methodology_aws/aws_instances.rst
@@ -1,5 +1,5 @@
-AWS Instances
--------------
+Instances
+---------

 
 CSIT is using C5n instances for high compute applications that can take
 advantage of improved network throughput and packet rate performance. C5n
 
 CSIT is using C5n instances for high compute applications that can take
 advantage of improved network throughput and packet rate performance. C5n


@@ -51,9 +51,6 @@ CPU utilization when compared to traditional virtualized network interfaces
 
 Current advertised limits are captured in [aws_limits]_.
 
 
 Current advertised limits are captured in [aws_limits]_.
 

-Reference
----------
-

 .. [aws_it] `Instance types <https://aws.amazon.com/ec2/instance-types/>`_
 .. [aws_ena] `Elastic Network Adapter <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking-ena.html>`_
 .. [aws_limits] `<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/compute-optimized-instances.html>`_
\ No newline at end of file
 .. [aws_it] `Instance types <https://aws.amazon.com/ec2/instance-types/>`_
 .. [aws_ena] `Elastic Network Adapter <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking-ena.html>`_
 .. [aws_limits] `<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/compute-optimized-instances.html>`_
\ No newline at end of file

diff --git a/docs/report/introduction/methodology_aws/index.rst b/docs/report/introduction/methodology_aws/index.rst
index 602f2c4..5da5253 100644 (file)
--- a/docs/report/introduction/methodology_aws/index.rst
+++ b/docs/report/introduction/methodology_aws/index.rst
@@ -3,6 +3,6 @@ Amazon Web Services
 
 .. toctree::
 
 
 .. toctree::
 

-    aws_terraform
-    aws_ami

     aws_instances
     aws_instances

+    aws_ami
+    aws_terraform

diff --git a/docs/report/introduction/documentation/containers.rst b/docs/report/introduction/methodology_containers.rst
similarity index 100%
rename from docs/report/introduction/documentation/containers.rst
rename to docs/report/introduction/methodology_containers.rst

diff --git a/docs/report/vpp_performance_tests/csit_release_notes.rst b/docs/report/vpp_performance_tests/csit_release_notes.rst
index 5d85fc4..25a2c33 100644 (file)
--- a/docs/report/vpp_performance_tests/csit_release_notes.rst
+++ b/docs/report/vpp_performance_tests/csit_release_notes.rst
@@ -8,13 +8,11 @@ Changes in |csit-release|
 
 #. VPP PERFORMANCE TESTS
 
 
 #. VPP PERFORMANCE TESTS
 

-   - **Intel Xeon Ice Lake**: Added initial test data for these
-     platforms. Current CSIT-2106 report data for Intel Xeon Ice Lake
-     comes from an external source (Intel labs running CSIT code on
-     "8360Y D Stepping" and "6338N" processors). For details about the
-     physical setup see :ref:`tested_physical_topologies`. Tested
-     VPP and CSIT versions are pre-release, VPP
-     21.06-rc0~779-gd640ae52f.
+   - **Intel Xeon Ice Lake**: Added test data for these platforms. Current
+     CSIT-2110 report data for Intel Xeon Ice Lake comes from an external source
+     (Intel labs running CSIT code on "8360Y D Stepping" and "6338N"
+     processors). For details about the physical setup see
+     :ref:`tested_physical_topologies`.

 
    - **MLRsearch improvements**: Added support for multiple packet
      throughput rates in a single search, each rate is associated
 
    - **MLRsearch improvements**: Added support for multiple packet
      throughput rates in a single search, each rate is associated


@@ -84,7 +82,7 @@ List of known issues in |csit-release| for VPP performance tests:
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 | #  | JiraID                                  | Issue Description                                                                                         |
 +====+=========================================+===========================================================================================================+
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 | #  | JiraID                                  | Issue Description                                                                                         |
 +====+=========================================+===========================================================================================================+

-|  1 | `CSIT-1782                              | Multicore AVF tests are failing when trying to create interface.                                          |
+|  1 | `CSIT-1782                              | Multicore AVF tests are failing when trying to create interface. The issue persists after FVL FW upgrade. |

 |    | <https://jira.fd.io/browse/CSIT-1782>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 |  2 | `CSIT-1763                              | Adapt ramp-up phase of nat44 tests for different frame sizes.                                             |
 |    | <https://jira.fd.io/browse/CSIT-1782>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 |  2 | `CSIT-1763                              | Adapt ramp-up phase of nat44 tests for different frame sizes.                                             |


@@ -99,19 +97,16 @@ List of known issues in |csit-release| for VPP performance tests:
 |  4 | `CSIT-1789                              | AVF driver does not perform RSS in a deterministic way.                                                   |
 |    | <https://jira.fd.io/browse/CSIT-1789>`_ | This increases standard deviation of tests with small number of flows (mainly ipsec).                     |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 |  4 | `CSIT-1789                              | AVF driver does not perform RSS in a deterministic way.                                                   |
 |    | <https://jira.fd.io/browse/CSIT-1789>`_ | This increases standard deviation of tests with small number of flows (mainly ipsec).                     |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+

-|  5 | `CSIT-1790                              | Broken TRex latency measurements with TRex v2.88, DPDK 21.02 and FVL FW 6.01.                             |
-|    | <https://jira.fd.io/browse/CSIT-1790>`_ | High latency O(5msec) for all VPP and testpmd/l3fwd test cases for FVL NICs with FW 6.01.                 |
-+----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
-|  6 | `CSIT-1780                              | IPSEC SW async scheduler MRR tests failing with no traffic forwarded.                                     |
+|  5 | `CSIT-1780                              | IPSEC SW async scheduler MRR tests failing with no traffic forwarded.                                     |

 |    | <https://jira.fd.io/browse/CSIT-1780>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 |    | <https://jira.fd.io/browse/CSIT-1780>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+

-|  7 | `CSIT-1786                              | IP4 and IP6 scale tests failing with no traffic forwarded.                                                |
+|  6 | `CSIT-1786                              | IP4 and IP6 scale tests failing with no traffic forwarded.                                                |

 |    | <https://jira.fd.io/browse/CSIT-1786>`_ | Issue reported to VPP devs.                                                                               |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 |    | <https://jira.fd.io/browse/CSIT-1786>`_ | Issue reported to VPP devs.                                                                               |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+

-|  8 | `CSIT-1785                              | NAT44ED tests failing to establish all TCP sessions.                                                      |
+|  7 | `CSIT-1785                              | NAT44ED tests failing to establish all TCP sessions.                                                      |

 |    | <https://jira.fd.io/browse/CSIT-1785>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 |    | <https://jira.fd.io/browse/CSIT-1785>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+

-|  9 | `CSIT-1791                              | Performance regression in RDMA tests, due to CSIT environment changes.                                    |
+|  8 | `CSIT-1791                              | Performance regression in RDMA tests, due to CSIT environment changes.                                    |

 |    | <https://jira.fd.io/browse/CSIT-1791>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+
 
 |    | <https://jira.fd.io/browse/CSIT-1791>`_ |                                                                                                           |
 +----+-----------------------------------------+-----------------------------------------------------------------------------------------------------------+