Updating documents of D-release.

[kvmfornfv.git] / docs / userguide / packet_forwarding.userguide.rst

diff --git a/docs/userguide/packet_forwarding.userguide.rst b/docs/userguide/packet_forwarding.userguide.rst
index 594952b..31341a9 100644 (file)
--- a/docs/userguide/packet_forwarding.userguide.rst
+++ b/docs/userguide/packet_forwarding.userguide.rst
@@ -3,13 +3,13 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 =================
-PACKET FORWARDING
+Packet Forwarding
 =================
 
 About Packet Forwarding
 -----------------------
 
-Packet Forwarding is a test suite of KVMFORNFV. These latency tests measures the time taken by a
+Packet Forwarding is a test suite of KVM4NFV. These latency tests measures the time taken by a
 **Packet** generated by the traffic generator to travel from the originating device through the
 network to the destination device. Packet Forwarding is implemented using test framework
 implemented by OPNFV VSWITCHPERF project and an ``IXIA Traffic Generator``.
@@ -23,15 +23,14 @@ Version Features
 |                             |                                                   |
 +=============================+===================================================+
 |                             | - Packet Forwarding is not part of Colorado       |
-|       Colorado              |   release of KVMFORNFV                            |
+|       Colorado              |   release of KVM4NFV                              |
 |                             |                                                   |
 +-----------------------------+---------------------------------------------------+
-|                             | - Packet Forwarding is a testcase in KVMFORNFV    |
+|                             | - Packet Forwarding is a testcase in KVM4NFV      |
 |                             | - Implements three scenarios (Host/Guest/SRIOV)   |
-|                             |   as part of testing in KVMFORNFV                 |
+|                             |   as part of testing in KVM4NFV                   |
 |       Danube                | - Uses automated test framework of OPNFV          |
-|                             |    VSWITCHPERF software (PVP/PVVP)                |
-|                             |                                                   |
+|                             |   VSWITCHPERF software (PVP/PVVP)                 |
 |                             | - Works with IXIA Traffic Generator               |
 +-----------------------------+---------------------------------------------------+
 
@@ -47,7 +46,7 @@ VNF level testing and validation.
 
 For complete VSPERF documentation go to `link.`_
 
-.. _link.: http://artifacts.opnfv.org/vswitchperf/colorado/index.html
+.. _link.: http://artifacts.opnfv.org/vswitchperf/danube/index.html
 
 
 Installation
@@ -78,7 +77,7 @@ The vSwitch must support Open Flow 1.3 or greater.
 Supported Hypervisors
 ~~~~~~~~~~~~~~~~~~~~~
 
-* Qemu version 2.3.
+* Qemu version 2.6.
 
 Other Requirements
 ~~~~~~~~~~~~~~~~~~
@@ -91,8 +90,7 @@ environment and compilation of OVS, DPDK and QEMU is performed by
 script **systems/build_base_machine.sh**. It should be executed under
 user account, which will be used for vsperf execution.
 
- **Please Note:** Password-less sudo access must be configured for given user
-                  before script is executed.
+ **Please Note:** Password-less sudo access must be configured for given user before script is executed.
 
 Execution of installation script:
 
@@ -209,7 +207,7 @@ runs the IXIA client software and a CentOS Linux release 7.1.1503 (Core) host.
 Installation
 ~~~~~~~~~~~~
 
-Follow the [installation instructions] to install.
+Follow the installation instructions to install.
 
 On the CentOS 7 system
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -380,12 +378,6 @@ A Kernel Module that provides OSI Layer 2 Ipv4 termination or forwarding with
 support for Destination Network Address Translation (DNAT) for both the MAC and
 IP addresses. l2fwd can be found in <vswitchperf_dir>/src/l2fwd
 
-.. figure:: images/Guest_Scenario.png
-   :name: Guest_Scenario
-   :width: 100%
-   :align: center
-
-
 Executing tests
 ~~~~~~~~~~~~~~~~
 
@@ -488,7 +480,7 @@ Example of execution of VSPERF in "trafficgen" mode:
 Packet Forwarding Test Scenarios
 --------------------------------
 
-KVMFORNFV currently implements three scenarios as part of testing:
+KVM4NFV currently implements three scenarios as part of testing:
 
   * Host Scenario
   * Guest Scenario.
@@ -614,7 +606,7 @@ Using QEMU with PCI passthrough support
 
 Raw virtual machine throughput performance can be measured by execution of PVP
 test with direct access to NICs by PCI passthrough. To execute VM with direct
-access to PCI devices, enable vfio-pci_. In order to use virtual functions,
+access to PCI devices, enable vfio-pci. In order to use virtual functions,
 SRIOV-support_ must be enabled.
 
 Execution of test with PCI passthrough with vswitch disabled:
@@ -624,10 +616,18 @@ Execution of test with PCI passthrough with vswitch disabled:
     $ ./vsperf --conf-file=<path_to_custom_conf>/10_custom.conf \
                --vswitch none --vnf QemuPciPassthrough pvp_tput
 
-Any of supported guest-loopback-application_ can be used inside VM with
+Any of supported guest-loopback-application can be used inside VM with
 PCI passthrough support.
 
 Note: Qemu with PCI passthrough support can be used only with PVP test
 deployment.
 
-.. _guest-loopback-application:
+Results
+~~~~~~~
+
+The results for the packet forwarding test cases are uploaded to artifacts.
+The link for the same can be found below
+
+.. code:: bash
+
+   http://artifacts.opnfv.org/kvmfornfv.html