summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMartin Klozik <martinx.klozik@intel.com>2016-01-13 14:57:07 +0000
committerMaryam Tahhan <maryam.tahhan@intel.com>2016-01-22 10:03:52 +0000
commit864832fd348efa21155b24a314dab22fe967c8c3 (patch)
tree04c918abbbf7b81672a9ddac19b6ebcc3df1e224 /docs
parent2a2baf3f5f348539b50194a456b49b4ccb32b775 (diff)
pkt_gen: support of standalone execution of traffic generator
Support for multiple modes of VSPERF operation has been added. These modes can be used for standalone execution of traffic generator or for manual testing or for execution of unsupported traffic generator. Supported modes are: "normal" - execute vSwitch, VNF and traffic generator; "trafficgen" - execute only traffic generator; "trafficgen-off" - execute vSwitch and VNF. Normal mode is selected by default. In case that trafficgen mode is selected, then various --test-params could be specified to affect traffic generator configuration. These parameters include traffic type, frame rate, bidirectional and scalability settings. Selection of transport protocol is not supported by IxNet yet (UDP is enforced), thus modification of transport protocol from command line is not supported too. Fixes of testpmd and qemu warning patches are inclduded. Change-Id: Idac10fe03e724075268a01ec3eb0817fba830aec JIRA: VSPERF-173 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com>
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/userguides/quickstart.rst57
1 files changed, 52 insertions, 5 deletions
diff --git a/docs/userguides/quickstart.rst b/docs/userguides/quickstart.rst
index caf3be04..fa951e0e 100755
--- a/docs/userguides/quickstart.rst
+++ b/docs/userguides/quickstart.rst
@@ -294,9 +294,9 @@ To run tests using Vanilla OVS:
or use --test-param
- ./vsperf --conf-file=<path_to_custom_conf>/10_custom.conf
- --test-param "vanilla_tgen_tx_ip=n.n.n.n;
- vanilla_tgen_tx_mac=nn:nn:nn:nn:nn:nn"
+ $ ./vsperf --conf-file=<path_to_custom_conf>/10_custom.conf
+ --test-param "vanilla_tgen_tx_ip=n.n.n.n;
+ vanilla_tgen_tx_mac=nn:nn:nn:nn:nn:nn"
2. Recompile src for Vanilla OVS testing
@@ -356,7 +356,7 @@ following configuration parameter should be configured:
or use --vswitch and --fwdapp
- ./vsperf --conf-file user_settings.py
+ $ ./vsperf --conf-file user_settings.py
--vswitch none
--fwdapp TestPMD
@@ -386,8 +386,55 @@ for selected Packet Forwarder:
.. code-block:: console
- ./vsperf --conf-file <path_to_settings_py>
+ $ ./vsperf --conf-file <path_to_settings_py>
+VSPERF modes of operation
+-------------------------
+VSPERF can be run in different modes. By default it will configure vSwitch,
+traffic generator and VNF. However it can be used just for configuration
+and execution of traffic generator. Another option is execution of all
+components except traffic generator itself.
+
+Mode of operation is driven by configuration parameter -m or --mode
+
+.. code-block:: console
+
+ -m MODE, --mode MODE vsperf mode of operation;
+ Values:
+ "normal" - execute vSwitch, VNF and traffic generator
+ "trafficgen" - execute only traffic generator
+ "trafficgen-off" - execute vSwitch and VNF
+
+In case, that VSPERF is executed in "trafficgen" mode, then configuration
+of traffic generator should be configured through --test-param option.
+Supported CLI options useful for traffic generator configuration are:
+
+.. code-block:: console
+
+ 'traffic_type' - One of the supported traffic types. E.g. rfc2544,
+ back2back or continuous
+ Default value is "rfc2544".
+ 'bidirectional' - Specifies if generated traffic will be full-duplex (true)
+ or half-duplex (false)
+ Default value is "false".
+ 'iload' - Defines desired percentage of frame rate used during
+ continuous stream tests.
+ Default value is 100.
+ 'multistream' - Defines number of flows simulated by traffic generator.
+ Value 0 disables MultiStream feature
+ Default value is 0.
+ 'stream_type' - Stream Type is an extension of the "MultiStream" feature.
+ If MultiStream is disabled, then Stream Type will be
+ ignored. Stream Type defines ISO OSI network layer used
+ for simulation of multiple streams.
+ Default value is "L4".
+
+Example of execution of VSPERF in "trafficgen" mode:
+
+.. code-block:: console
+
+ $ ./vsperf -m trafficgen --trafficgen IxNet --conf-file vsperf.conf
+ --test-params "traffic_type=continuous;bidirectional=True;iload=60"
Code change verification by pylint
----------------------------------