diff options
Diffstat (limited to 'docs/testing')
-rw-r--r-- | docs/testing/developer/index.rst | 26 | ||||
-rw-r--r-- | docs/testing/user/configguide/index.rst | 10 | ||||
-rw-r--r-- | docs/testing/user/userguide/index.rst | 5 | ||||
-rw-r--r-- | docs/testing/user/userguide/testusage.rst | 59 |
4 files changed, 72 insertions, 28 deletions
diff --git a/docs/testing/developer/index.rst b/docs/testing/developer/index.rst index c89f27fc..408cc69f 100644 --- a/docs/testing/developer/index.rst +++ b/docs/testing/developer/index.rst @@ -34,9 +34,9 @@ VSPERF Developer Guide **************************** .. toctree:: - :caption: VSPERF Developer Guide - :maxdepth: 5 - :numbered: 5 + :caption: Traffic Gen Integration, VSPERF Design, Test Design, Test Plan + :maxdepth: 2 + :numbered: 2 ./design/trafficgen_integration_guide.rst ./design/vswitchperf_design.rst @@ -45,17 +45,15 @@ VSPERF Developer Guide ./requirements/vswitchperf_ltp.rst ***************************** -VSPERF - IETF Internet Draft +VSPERF IETF Internet Draft ***************************** .. toctree:: - :caption: IETF Internet Draft - :maxdepth: 5 - :numbered: 5 + :caption: vSwitch Internet Draft + :maxdepth: 2 + :numbered: -`Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_ - -Drafts (xml) are maintained in IETF repo. https://tools.ietf.org/html/ +This IETF INternet Draft on `Benchmarking Virtual Switches in OPNFV <https://tools.ietf.org/html/draft-ietf-bmwg-vswitch-opnfv-01>`_ was developed by VSPERF contributors and is maintained in the IETF repo. at https://tools.ietf.org/html/ ******************************** VSPERF Scenarios and CI Results @@ -63,12 +61,8 @@ VSPERF Scenarios and CI Results .. toctree:: :caption: VSPERF Scenarios & Results - :maxdepth: 5 - :numbered: 5 + :maxdepth: 2 + :numbered: ./results/scenario.rst ./results/results.rst - -Indices -======= -* :ref:`search` diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst index 4e082261..2b19591d 100644 --- a/docs/testing/user/configguide/index.rst +++ b/docs/testing/user/configguide/index.rst @@ -33,9 +33,9 @@ VSPERF User Guide ****************************** .. toctree:: - :caption: VSPERF User Guide - :maxdepth: 5 - :numbered: 5 + :caption: VSPERF Install, Upgrade, Traffic Generator Guide, Test Suite Guide + :maxdepth: 2 + :numbered: ./installation.rst ./upgrade.rst @@ -45,7 +45,3 @@ VSPERF User Guide ../userguide/teststeps.rst ../userguide/integration.rst ../userguide/yardstick.rst - -Indices -======= -* :ref:`search` diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst index 5c6886bf..4443a393 100644 --- a/docs/testing/user/userguide/index.rst +++ b/docs/testing/user/userguide/index.rst @@ -3,8 +3,3 @@ .. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others. .. OPNFV VSPERF Documentation master file. - - -Indices -======= -* :ref:`search` diff --git a/docs/testing/user/userguide/testusage.rst b/docs/testing/user/userguide/testusage.rst index c6037aaf..03068911 100644 --- a/docs/testing/user/userguide/testusage.rst +++ b/docs/testing/user/userguide/testusage.rst @@ -645,6 +645,65 @@ environment. on the same numa as the NIC in use if possible/applicable. Testpmd should be assigned at least (nb_cores +1) total cores with the cpu mask. +Jumbo Frame Testing +^^^^^^^^^^^^^^^^^^^ + +VSPERF provides options to support jumbo frame testing with a jumbo frame supported +NIC and traffic generator for the following vswitches: + +1. OVSVanilla + +2. OvsDpdkVhostUser + +3. TestPMD loopback with or without a guest + +**NOTE:** There is currently no support for SR-IOV or VPP at this time with jumbo +frames. + +All packet forwarding applications for pxp testing is supported. + +To enable jumbo frame testing simply enable the option in the conf files and set the +maximum size that will be used. + +.. code-block:: python + + VSWITCH_JUMBO_FRAMES_ENABLED = True + VSWITCH_JUMBO_FRAMES_SIZE = 9000 + +To enable jumbo frame testing with OVSVanilla the NIC in test on the host must have +its mtu size changed manually using ifconfig or applicable tools: + +.. code-block:: console + + ifconfig eth1 mtu 9000 up + +**NOTE:** To make the setting consistent across reboots you should reference the OS +documents as it differs from distribution to distribution. + +To start a test for jumbo frames modify the conf file packet sizes or pass the option +through the VSPERF command line. + +.. code-block:: python + + TEST_PARAMS = {'TRAFFICGEN_PKT_SIZES':(2000,9000)} + +.. code-block:: python + + ./vsperf --test-params "TRAFFICGEN_PKT_SIZES=2000,9000" + +It is recommended to increase the memory size for OvsDpdkVhostUser testing from the default +1024. Your size required may vary depending on the number of guests in your testing. 4096 +appears to work well for most typical testing scenarios. + +.. code-block:: python + + DPDK_SOCKET_MEM = ['4096', '0'] + +**NOTE:** For Jumbo frames to work with DpdkVhostUser, mergable buffers will be enabled by +default. If testing with mergable buffers in QEMU is desired, disable Jumbo Frames and only +test non jumbo frame sizes. Test Jumbo Frames sizes separately to avoid this collision. + + Executing Packet Forwarding tests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |