From f6f05f632f85d86d397e2522bc43cb4407d9eba8 Mon Sep 17 00:00:00 2001 From: Christian Trautman Date: Thu, 11 Aug 2016 08:53:20 -0400 Subject: doc_fixup: Grammar and link fixes to documentation Fixes minor grammar and link issues. JIRA: VSPERF-349 Change-Id: Id8708aee5b099287b5c99e79ca6da9ab8778897f Signed-off-by: Christian Trautman --- docs/configguide/installation.rst | 4 ++-- docs/configguide/trafficgen.rst | 8 ++++---- docs/userguide/integration.rst | 4 ++++ docs/userguide/testusage.rst | 12 +++++++++++- 4 files changed, 21 insertions(+), 7 deletions(-) (limited to 'docs') diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst index 70572b07..2dabfc7f 100755 --- a/docs/configguide/installation.rst +++ b/docs/configguide/installation.rst @@ -162,8 +162,8 @@ hugepage amounts to support running these configurations. It is recommended to configure 1GB hugepages as the pagesize. The amount of hugepages needed depends on your configuration files in vsperf. -Each guest image requires 4096 by default according to the default settings in -the ``04_vnf.conf`` file. +Each guest image requires 4096 MB by default according to the default settings +in the ``04_vnf.conf`` file. .. code:: bash diff --git a/docs/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst index c698b8d6..28b34a6b 100644 --- a/docs/configguide/trafficgen.rst +++ b/docs/configguide/trafficgen.rst @@ -57,7 +57,7 @@ follows: }, } -The framesize paramter can be overridden from the configuration +The framesize parameter can be overridden from the configuration files by adding the following to your custom configuration file ``10_custom.conf``: @@ -169,7 +169,7 @@ IxNetwork -> IxNetwork\_$(VER\_NUM) -> IxNetwork TCL Server) Right click on IxNetwork TCL Server, select properties - Under shortcut tab in the Target dialogue box make sure there is the argument "-tclport xxxx" -where xxxx is your port number (take note of this port number you will +where xxxx is your port number (take note of this port number as you will need it for the 10\_custom.conf file). .. image:: TCLServerProperties.png @@ -329,7 +329,7 @@ Xena Networks Installation ~~~~~~~~~~~~ -Xena Networks traffic generator requires certain files and packages to be +Xena Networks traffic generator requires specific files and packages to be installed. It is assumed the user has access to the Xena2544.exe file which must be placed in VSPerf installation location under the tools/pkt_gen/xena folder. Contact Xena Networks for the latest version of this file. The user @@ -406,7 +406,7 @@ https://github.com/emmericp/MoonGen * Note: Today, MoonGen with VSPERF only supports 10Gbps line speeds. -For VSPerf use, MoonGen should be cloned from here (as opposed to the afore +For VSPerf use, MoonGen should be cloned from here (as opposed to the previously mentioned GitHub): git clone https://github.com/atheurer/MoonGen diff --git a/docs/userguide/integration.rst b/docs/userguide/integration.rst index e45f2dc1..c7886536 100755 --- a/docs/userguide/integration.rst +++ b/docs/userguide/integration.rst @@ -435,6 +435,10 @@ Executing Tunnel encapsulation tests The VXLAN OVS DPDK encapsulation tests requires IPs, MAC addresses, bridge names and WHITELIST_NICS for DPDK. +NOTE: Only Ixia traffic generators currently support the execution of the tunnel +encapsulation tests. Support for other traffic generators may come in a future +release. + Default values are already provided. To customize for your environment, override the following variables in you user_settings.py file: diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst index b5f47998..c020b6ca 100755 --- a/docs/userguide/testusage.rst +++ b/docs/userguide/testusage.rst @@ -16,6 +16,10 @@ support in VSPERF includes: - Spirent traffic generator (TestCenter hardware chassis or TestCenter virtual in a VM) and a VM to run the Spirent Virtual Deployment Service image, formerly known as "Spirent LabServer". +- Xena Network traffic generator (Xena hardware chassis) that houses the Xena + Traffic generator modules. +- Moongen software traffic generator. Requires a separate machine running + moongen to execute packet generation. If you want to use another traffic generator, please select the Dummy generator option as shown in `Traffic generator instructions @@ -114,6 +118,12 @@ deployment scenarios. The image can be downloaded from $ wget http://artifacts.opnfv.org/vswitchperf/vloop-vnf-ubuntu-14.04_20151216.qcow2 +Newer vloop_vnf images are available. Please reference the +installation instructions for information on these images +`installation instructions +`__ + + vloop_vnf forwards traffic through a VM using one of: * DPDK testpmd * Linux Bridge @@ -645,5 +655,5 @@ More information ^^^^^^^^^^^^^^^^ For more information and details refer to the vSwitchPerf user guide at: -http://artifacts.opnfv.org/vswitchperf/brahmaputra/userguide/index.html +http://artifacts.opnfv.org/vswitchperf/docs/userguide/index.html -- cgit 1.2.3-korg