Apply minor improvements to methodology docs
[csit.git] / docs / report / vpp_functional_tests / csit_release_notes.rst
index 82ad41a..8b0ae9e 100644 (file)
@@ -1,54 +1,60 @@
-CSIT Release Notes
-==================
+Release Notes
+=============
 
-Changes in CSIT |release|
+Changes in |csit-release|
 -------------------------
 
-#. Introduction of Centos7 tests
+#. TEST FRAMEWORK
 
-#. Added VPP functional tests
+   - **VPP_Device**: Added container based functional VPP device tests
+     integrated into LFN CI/CD infrastructure. VPP_Device tests run on
+     1-Node testbeds (1n-skx, 1n-arm) and rely on Linux SRIOV Virtual
+     Function (VF), dot1q VLAN tagging and external loopback cables to
+     facilitate packet passing over exernal physical links. Initial
+     focus is on few baseline tests. Existing CSIT VIRL tests can be
+     moved to VPP_Device framework by changing L1 KW(s). L2 KWs and RF
+     test definition code stay unchanged. CSIT VIRL to VPP_Device
+     migration is expected in the next CSIT release.
 
-    - more VM vhost-user tests incl. two VM four vhost interface tests
-    - more LISP tests
-    - more IPSec crypto tests
-    - IPv4 and IPv6 Equal-Cost Multi-Path routing tests
-    - Telemetry:
-      - IPFIX tests
-      - SPAN tests
+   - **Bug fixes**.
 
-Known Issues - to be updated
+#. CSIT TEST MIMGRATION
+
+   - **VPP_Path**: Continuing migration of the original FD.io CSIT VIRL
+     tests to VPP-make_test VPP integration tests for functional
+     acceptance of VPP feature path(s) driven by use case(s). See P1
+     and P2 markup in `CSIT_VIRL migration progress
+     <https://docs.google.com/spreadsheets/d/1PciV8XN9v1qHbIRUpFJoqyES29_vik7lcFDl73G1usc/edit?usp=sharing>`_
+
+Known Issues
 ------------
 
-Here is the list of known issues in CSIT |release| for VPP functional tests in VIRL: (to be updated)
-
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| # | Issue                                           | Description                                                     |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| 1 | DHCPv4 client: Client responses to DHCPv4 OFFER | Client replies with DHCPv4 REQUEST message when received DHCPv4 |
-|   | sent with different XID                         | OFFER message with different (wrong) XID.                       |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| 2 | Softwire - MAP-E: Incorrect calculation of IPv6 | IPv6 destination address is wrongly calculated in case that     |
-|   | destination address when IPv4 prefix is 0       | IPv4 prefix is equal to 0 and IPv6 prefix is less than 40.      |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| 3 | Softwire - MAP-E: Map domain is created when    | Map domain is created in case that the sum of suffix length of  |
-|   | incorrect parameters provided                   | IPv4 prefix and PSID length is greater than EA bits length.     |
-|   |                                                 | IPv6 destination address contains bits writen with PSID over    |
-|   |                                                 | the EA-bit length when IPv4 packet is sent.                     |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| 4 | IPv6 RA: Incorrect IPv6 destination address in  | Wrong IPv6 destination address (ff02::1) is used in ICMPv6      |
-|   | response to ICMPv6 Router Solicitation          | Router Advertisement packet sent as a response to received      |
-|   |                                                 | ICMPv6 Router Solicitation packet.                              |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| 5 | IPFIX: IPv6_src key name reported instead of    | The report contains IPv6_src key name instead of IPv6_dst when  |
-|   | IPv6_dst                                        | classify session is configured with IPv6 destination address.   |
-|   |                                                 | Anyhow the correct IPv6 destination address is reported.        |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| 6 | SPAN: Tx traffic is not mirrored                | Tx traffic is not mirrored from SPAN source port to SPAN        |
-|   |                                                 | destination port.                                               |
-|   |                                                 | NOTE: Fix is going to be merged in vpp stable/1701.             |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
-| 7 | SPAN: Packet trace always contains local0 as    | There is reported wrong destination port in the traffic trace:  |
-|   | destination port                                |         SPAN: mirrored GigabitEthernet0/5/0 -> local0           |
-|   |                                                 | The (Rx) traffic is mirrored to correct destination port.       |
-+---+-------------------------------------------------+-----------------------------------------------------------------+
+List of known issues in |csit-release| for VPP functional tests in VIRL:
+
++---+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
+| # | JiraID                                 | Issue Description                                                                                                       |
++===+========================================+=========================================================================================================================+
+| 1 | `CSIT-129                              | DHCPv4 client: Client responses to DHCPv4 OFFER sent with different XID.                                                |
+|   | <https://jira.fd.io/browse/CSIT-129>`_ | Client replies with DHCPv4 REQUEST message when received DHCPv4 OFFER message with different (wrong) XID.               |
+|   | `VPP-99                                |                                                                                                                         |
+|   | <https://jira.fd.io/browse/VPP-99>`_   |                                                                                                                         |
++---+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
+| 2 | `CSIT-398                              | Softwire - MAP-E: Incorrect calculation of IPv6 destination address when IPv4 prefix is 0.                              |
+|   | <https://jira.fd.io/browse/CSIT-398>`_ | IPv6 destination address is wrongly calculated in  case that IPv4 prefix is equal to 0 and IPv6 prefix is less than 40. |
+|   | `VPP-380                               |                                                                                                                         |
+|   | <https://jira.fd.io/browse/VPP-380>`_  |                                                                                                                         |
++---+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
+| 3 | `CSIT-399                              | Softwire - MAP-E: Map domain is created when incorrect parameters provided.                                             |
+|   | <https://jira.fd.io/browse/CSIT-399>`_ | Map domain is created in case that the sum of suffix length of IPv4 prefix and PSID length is greater than EA bits      |
+|   | `VPP-435                               | length. IPv6 destination address contains bits writen with PSID over the EA-bit length when IPv4 packet is sent.        |
+|   | <https://jira.fd.io/browse/VPP-435>`_  |                                                                                                                         |
++---+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
+| 4 | `CSIT-409                              | IPv6 RA: Incorrect IPv6 destination address in response to ICMPv6 Router Solicitation.                                  |
+|   | <https://jira.fd.io/browse/CSIT-409>`_ | Wrong IPv6 destination address (ff02::1) is used in ICMPv6 Router Advertisement packet sent as a response to received   |
+|   | `VPP-406                               | ICMPv6 Router Solicitation packet.                                                                                      |
+|   | <https://jira.fd.io/browse/VPP-406>`_  |                                                                                                                         |
++---+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
+| 5 | `CSIT-565                              | Vhost-user: QEMU reconnect does not work.                                                                               |
+|   | <https://jira.fd.io/browse/CSIT-565>`_ | QEMU 2.5.0 used in CSIT does not support vhost-user reconnect. Requires upgrading CSIT VIRL environment to QEMU 2.7.0.  |
++---+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------+