docs: updates and final fixes

Migrate the installation guide for vsperf to a configguide directory,
update the links to the installation guide. Re-add top level index.rst
and remove the all directory. Update release documentation with vsperf
Rel B support.

Change-Id: Ib643b9d3581d8109b85c377027c8cc6be4b797fc
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Radek Zetik <radekx.zetik@intel.com>
Reviewed-by: Dino Simeon Madarang <dino.simeonx.madarang@intel.com>
Reviewed-by: Brian Castelli <brian.castelli@spirent.com>

diff --git a/docs/userguides/TCLServerProperties.png b/docs/configguide/TCLServerProperties.png
similarity index 100%
rename from docs/userguides/TCLServerProperties.png
rename to docs/configguide/TCLServerProperties.png

diff --git a/docs/userguides/index.rst b/docs/configguide/index.rst
similarity index 74%
rename from docs/userguides/index.rst
rename to docs/configguide/index.rst
index c796e6c..3aaf238 100644 (file)
--- a/docs/userguides/index.rst
+++ b/docs/configguide/index.rst
@@ -1,11 +1,10 @@
 ******************************
-VSPERF Guides and Installation
+VSPERF Installation Guide
 ******************************
 
 .. toctree::
    :numbered:
    :maxdepth: 3
 
-   quickstart.rst
    installation.rst
    trafficgen.rst

diff --git a/docs/userguides/installation.rst b/docs/configguide/installation.rst
similarity index 69%
rename from docs/userguides/installation.rst
rename to docs/configguide/installation.rst
index abd09cb..ebc73ba 100755 (executable)
--- a/docs/userguides/installation.rst
+++ b/docs/configguide/installation.rst
@@ -2,6 +2,40 @@
 Installing vswitchperf
 ======================
 
+Supported Operating Systems
+---------------------------
+
+* CentOS 7
+* Fedora 20
+* Fedora 21
+* Fedora 22
+* Ubuntu 14.04
+
+Supported vSwitches
+-------------------
+The vSwitch must support Open Flow 1.3 or greater.
+
+* OVS (built from source).
+* OVS with DPDK (built from source).
+
+Supported Hypervisors
+---------------------
+
+* Qemu version 2.3.
+
+Available VNFs
+--------------
+A simple VNF that forwards traffic through a VM, using:
+
+* DPDK testpmd
+* Linux Brigde
+* custom l2fwd module
+
+The VM image can be downloaded from:
+http://artifacts.opnfv.org/vswitchperf/vloop-vnf-ubuntu-14.04_20151216.qcow2
+
+Other Requirements
+------------------
 The test suite requires Python 3.3 and relies on a number of other
 packages. These need to be installed for the test suite to function.
 
@@ -10,7 +44,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
+**Please Note**: Password-less sudo access must be configured for given
 user account before script is executed.
 
 Execution of installation script:
@@ -20,18 +54,10 @@ Execution of installation script:
     $ cd systems
     $ ./build_base_machine.sh
 
-Please note: you don't need to go into any of the systems subdirectories,
+**Please Note**: you don't need to go into any of the systems subdirectories,
 simply run the top level **build_base_machine.sh**, your OS will be detected
 automatically.
 
-Currently supported operating systems are:
-
-    - CentOS 7
-    - Fedora 20
-    - Fedora 21
-    - Fedora 22
-    - Ubuntu 14.04
-
 Script **build_base_machine.sh** will install all the vsperf dependencies
 in terms of system packages, Python 3.x and required Python modules.
 In case of CentOS 7 it will install Python 3.3 from an additional repository
@@ -43,7 +69,8 @@ in a directory called **vsperfenv** in $HOME.
 You will need to activate the virtual environment every time you start a
 new shell session. Its activation is specific to your OS:
 
-CentOS 7:
+CentOS 7
+========
 
 .. code:: bash
 
@@ -51,16 +78,14 @@ CentOS 7:
     $ cd $HOME/vsperfenv
     $ source bin/activate
 
-Fedora and Ubuntu:
+Fedora and Ubuntu
+=================
 
 .. code:: bash
 
     $ cd $HOME/vsperfenv
     $ source bin/activate
 
-
---------------
-
 Working Behind a Proxy
 ======================
 

diff --git a/docs/userguides/trafficgen.rst b/docs/configguide/trafficgen.rst
similarity index 100%
rename from docs/userguides/trafficgen.rst
rename to docs/configguide/trafficgen.rst

diff --git a/docs/all/index.rst b/docs/index.rst
similarity index 53%
rename from docs/all/index.rst
rename to docs/index.rst
index 311a2e2..2c19230 100755 (executable)
--- a/docs/all/index.rst
+++ b/docs/index.rst
@@ -3,12 +3,7 @@
 ======
 VSPERF
 ======
-Welcome to VSPERF's documentation !
-
-.. _VSPERF: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
-.. _REPO: https://gerrit.opnfv.org/gerrit/#/q/vswitchperf
-
-VSPERF_ is an OPNFV testing project.
+VSPERF is an OPNFV testing project.
 
 VSPERF will develop a generic and architecture agnostic vSwitch testing
 framework and associated tests, that will serve as a basis for validating the
@@ -17,14 +12,19 @@ environment. The output of this project will be utilized by the OPNFV
 Performance and Test group and its associated projects, as part of OPNFV
 Platform and VNF level testing and validation.
 
+Project Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases
+Project Repository: https://gerrit.opnfv.org/gerrit/#/q/vswitchperf
+Continuous Integration https://build.opnfv.org/ci/view/vswitchperf/
+
 .. toctree::
    :maxdepth: 3
    :numbered: 5
 
-   http://artifacts.opnfv.org/vswitchperf/docs/userguides/index.html
-   http://artifacts.opnfv.org/vswitchperf/docs/design/index.html
-   http://artifacts.opnfv.org/vswitchperf/docs/requirements/index.html
-   http://artifacts.opnfv.org/vswitchperf/docs/release/index.html
+   ./configguide/index.rst
+   ./userguide/index.rst
+   ./design/index.rst
+   ./requirements/index.rst
+   ./release/index.rst
 
 
 Indices

diff --git a/docs/release/NEWS.rst b/docs/release/NEWS.rst
index 1593cb8..21c5637 100755 (executable)
--- a/docs/release/NEWS.rst
+++ b/docs/release/NEWS.rst
@@ -1,3 +1,41 @@
+OPNFV Brahmaputra Release
+=========================
+Supports both OVS and OVS with DPDK.
+
+Available tests:
+
+* phy2phy_tput:     LTD.Throughput.RFC2544.PacketLossRatio
+* back2back:        LTD.Throughput.RFC2544.BackToBackFrames
+* phy2phy_tput_mod_vlan:LTD.Throughput.RFC2544.PacketLossRatioFrameModification
+* phy2phy_cont:     Phy2Phy Continuous Stream
+* pvp_cont:         PVP Continuous Stream
+* pvvp_cont:        PVVP Continuous Stream
+* phy2phy_scalability:LTD.Scalability.RFC2544.0PacketLoss
+* pvp_tput:         LTD.Throughput.RFC2544.PacketLossRatio
+* pvp_back2back:    LTD.Throughput.RFC2544.BackToBackFrames
+* pvvp_tput:        LTD.Throughput.RFC2544.PacketLossRatio
+* pvvp_back2back:   LTD.Throughput.RFC2544.BackToBackFrames
+* phy2phy_cpu_load: LTD.CPU.RFC2544.0PacketLoss
+* phy2phy_mem_load: LTD.Memory.RFC2544.0PacketLoss
+
+Supported deployment scenarios:
+
+* Physical port -> vSwitch -> Physical port.
+* Physical port -> vSwitch -> VNF -> vSwitch -> Physical port.
+* Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch -> Physical port.
+
+Loopback applications in the Guest can be:
+
+* DPDK testpmd.
+* Linux Bridge.
+* l2fwd Kernel Module.
+
+Supported traffic generators:
+
+* Ixia: IxOS and IxNet.
+* Spirent.
+* Dummy.
+
 November 2015
 ==============
 

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644 (file)
index 0000000..1e02eb2
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,9 @@
+******************************
+VSPERF User Guide
+******************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 3
+
+   quickstart.rst

diff --git a/docs/userguides/quickstart.rst b/docs/userguide/quickstart.rst
similarity index 94%
rename from docs/userguides/quickstart.rst
rename to docs/userguide/quickstart.rst
index 229edfe..221ff69 100755 (executable)
--- a/docs/userguides/quickstart.rst
+++ b/docs/userguide/quickstart.rst
@@ -2,8 +2,8 @@
 Getting Started with 'vsperf'
 =============================
 
-Requirements
--------------
+General
+-------
 
 VSPERF requires a traffic generators to run tests, automated traffic gen
 support in VSPERF includes:
@@ -16,33 +16,19 @@ support in VSPERF includes:
 
 If you want to use another traffic generator, please select the Dummy generator
 option as shown in `Traffic generator instructions
-<http://artifacts.opnfv.org/vswitchperf/docs/userguides/trafficgen.html>`__
-
-Supported OSes include:
-
-* CentOS Linux release 7.1.1503 (Core) host.
-* Fedora 21 and 22.
-* Ubuntu 14.04
-
-vSwitch Requirements
---------------------
-
-The vSwitch must support Open Flow 1.3 or greater. VSPERF supports both:
-
-* OVS
-* OVS with DPDK
+<http://artifacts.opnfv.org/vswitchperf/docs/configguide/trafficgen.html>`__
 
 VSPERF Installation
 --------------------
-
-Follow the `installation instructions
-<http://artifacts.opnfv.org/vswitchperf/docs/userguides/installation.html>`__ to
+To see the supported Operating Systems, vSwitches and system requirements,
+please follow the `installation instructions
+<http://artifacts.opnfv.org/vswitchperf/docs/configguide/installation.html>`__ to
 install.
 
 Traffic Generator Setup
 -----------------------
 Follow the `Traffic generator instructions
-<http://artifacts.opnfv.org/vswitchperf/docs/userguides/trafficgen.html>`__ to
+<http://artifacts.opnfv.org/vswitchperf/docs/configguide/trafficgen.html>`__ to
 install and configure a suitable traffic generator.
 
 Cloning and building src dependencies
@@ -121,9 +107,18 @@ deployment scenarios. The image can be downloaded from
 
     $ wget http://artifacts.opnfv.org/vswitchperf/vloop-vnf-ubuntu-14.04_20151216.qcow2
 
+vloop_vnf forwards traffic through a VM using one of:
+* DPDK testpmd
+* Linux Bridge
+* l2fwd kernel Module.
+
 Alternatively you can use your own QEMU image.
 
---------------
+l2fwd Kernel Module
+-------------------
+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
 
 Executing tests
 ---------------