diff options
Diffstat (limited to 'docs')
24 files changed, 357 insertions, 253 deletions
diff --git a/docs/configguide/LICENSE b/docs/configguide/LICENSE new file mode 100644 index 00000000..7bc572ce --- /dev/null +++ b/docs/configguide/LICENSE @@ -0,0 +1,2 @@ +This work is licensed under a Creative Commons Attribution 4.0 International License. +http://creativecommons.org/licenses/by/4.0 diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst deleted file mode 100644 index b4c8575e..00000000 --- a/docs/configguide/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T and others. - -****************************** -VSPERF Installation Guide -****************************** - -.. toctree:: - :numbered: - :maxdepth: 3 - - installation.rst - upgrade.rst - trafficgen.rst diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst index b6b42bc2..1965a8f5 100644 --- a/docs/configguide/installation.rst +++ b/docs/configguide/installation.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. +.. _vsperf-installation: + ====================== Installing vswitchperf ====================== @@ -43,10 +45,9 @@ Supported Operating Systems --------------------------- * CentOS 7.3 -* Fedora 20 -* Fedora 21 -* Fedora 22 * Fedora 24 (kernel 4.8 requires DPDK 16.11 and newer) +* Fedora 25 (kernel 4.9 requires DPDK 16.11 and newer) +* openSUSE 42.2 * RedHat 7.2 Enterprise Linux * RedHat 7.3 Enterprise Linux * Ubuntu 14.04 @@ -122,6 +123,8 @@ Changelog of vloop-vnf: * version with development tools required for build of DPDK and l2fwd +.. _vsperf-installation-script: + Installation ------------ @@ -162,6 +165,22 @@ built from upstream source due to kernel incompatibilities. Please see the instructions in the vswitchperf_design document for details on configuring OVS Vanilla for binary package usage. +.. _vpp-installation: + +VPP installation +================ + +Currently vswitchperf installation scripts do not support automatic build +of VPP. In order to execute tests with VPP, it is required to install it +manually. Please refer to the official documentation of `fd.io`_ project to +install VPP from `packages`_ or from the `sources`_. + +See details about :ref:`vpp-test`. + +.. _fd.io: https://fd.io/ +.. _packages: https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages +.. _sources: https://wiki.fd.io/view/VPP/Build,_install,_and_test_images + Using vswitchperf ----------------- @@ -257,20 +276,10 @@ your configuration in the ``02_vswitch.conf`` file. .. code:: bash - VSWITCHD_DPDK_ARGS = ['-c', '0x4', '-n', '4', '--socket-mem 1024,1024'] - VSWITCHD_DPDK_CONFIG = { - 'dpdk-init' : 'true', - 'dpdk-lcore-mask' : '0x4', - 'dpdk-socket-mem' : '1024,1024', - } - -**NOTE:** Option ``VSWITCHD_DPDK_ARGS`` is used for vswitchd, which supports ``--dpdk`` -parameter. In recent vswitchd versions, option ``VSWITCHD_DPDK_CONFIG`` is -used to configure vswitchd via ``ovs-vsctl`` calls. + DPDK_SOCKET_MEM = ['1024', '0'] -With the ``--socket-mem`` argument set to use 1 hugepage on the specified sockets as -seen above, the configuration will need 10 hugepages total to run all tests -within vsperf if the pagesize is set correctly to 1GB. +**NOTE:** Option ``DPDK_SOCKET_MEM`` is used by all vSwitches with DPDK support. +It means Open vSwitch, VPP and TestPMD. VSPerf will verify hugepage amounts are free before executing test environments. In case of hugepage amounts not being free, test initialization diff --git a/docs/configguide/trafficgen.rst b/docs/configguide/trafficgen.rst index b66a1787..4e42b2be 100644 --- a/docs/configguide/trafficgen.rst +++ b/docs/configguide/trafficgen.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. +.. _trafficgen-installation: + =========================== 'vsperf' Traffic Gen Guide =========================== @@ -87,6 +89,8 @@ commandline above to: $ ./vsperf --test-params "TRAFFICGEN_PKT_SIZES=(x,y);TRAFFICGEN_DURATION=10;" \ "TRAFFICGEN_RFC2544_TESTS=1" $TESTNAME +.. _trafficgen-dummy: + Dummy ----- @@ -410,22 +414,63 @@ RFC 2544 tests using the REST interface. Configuration: ~~~~~~~~~~~~~~ -The mandatory configurations are enlisted below. 1. The Labserver and license server addresses. These parameters applies to - all the tests and are mandatory. + all the tests, and are mandatory for all tests. .. code-block:: console TRAFFICGEN_STC_LAB_SERVER_ADDR = " " TRAFFICGEN_STC_LICENSE_SERVER_ADDR = " " + TRAFFICGEN_STC_PYTHON2_PATH = " " + TRAFFICGEN_STC_TESTCENTER_PATH = " " + TRAFFICGEN_STC_TEST_SESSION_NAME = " " + TRAFFICGEN_STC_CSV_RESULTS_FILE_PREFIX = " " 2. For RFC2544 tests, the following parameters are mandatory +.. code-block:: console + + TRAFFICGEN_STC_EAST_CHASSIS_ADDR = " " + TRAFFICGEN_STC_EAST_SLOT_NUM = " " + TRAFFICGEN_STC_EAST_PORT_NUM = " " + TRAFFICGEN_STC_EAST_INTF_ADDR = " " + TRAFFICGEN_STC_EAST_INTF_GATEWAY_ADDR = " " + TRAFFICGEN_STC_WEST_CHASSIS_ADDR = "" + TRAFFICGEN_STC_WEST_SLOT_NUM = " " + TRAFFICGEN_STC_WEST_PORT_NUM = " " + TRAFFICGEN_STC_WEST_INTF_ADDR = " " + TRAFFICGEN_STC_WEST_INTF_GATEWAY_ADDR = " " + TRAFFICGEN_STC_RFC2544_TPUT_TEST_FILE_NAME + +3. RFC2889 tests: Currently, the forwarding, address-caching, and + address-learning-rate tests of RFC2889 are supported. + The testcenter-rfc2889-rest.py script implements the rfc2889 tests. + The configuration for RFC2889 involves test-case definition, and parameter + definition, as described below. New results-constants, as shown below, are + added to support these tests. + +Example of testcase definition for RFC2889 tests: + +.. code-block:: python + + { + "Name": "phy2phy_forwarding", + "Deployment": "p2p", + "Description": "LTD.Forwarding.RFC2889.MaxForwardingRate", + "Parameters" : { + "TRAFFIC" : { + "traffic_type" : "rfc2889_forwarding", + }, + }, + } + +For RFC2889 tests, specifying the locations for the monitoring ports is mandatory. +Necessary parameters are: .. code-block:: console - TRAFFICGEN_STC_RFC2544_TPUT_TEST_FILE_NAME = " " + TRAFFICGEN_STC_RFC2889_TEST_FILE_NAME TRAFFICGEN_STC_EAST_CHASSIS_ADDR = " " TRAFFICGEN_STC_EAST_SLOT_NUM = " " TRAFFICGEN_STC_EAST_PORT_NUM = " " @@ -436,13 +481,52 @@ The mandatory configurations are enlisted below. TRAFFICGEN_STC_WEST_PORT_NUM = " " TRAFFICGEN_STC_WEST_INTF_ADDR = " " TRAFFICGEN_STC_WEST_INTF_GATEWAY_ADDR = " " + TRAFFICGEN_STC_VERBOSE = "True" + TRAFFICGEN_STC_RFC2889_LOCATIONS="//10.1.1.1/1/1,//10.1.1.1/2/2" + +Other Configurations are : + +.. code-block:: console + + TRAFFICGEN_STC_RFC2889_MIN_LR = 1488 + TRAFFICGEN_STC_RFC2889_MAX_LR = 14880 + TRAFFICGEN_STC_RFC2889_MIN_ADDRS = 1000 + TRAFFICGEN_STC_RFC2889_MAX_ADDRS = 65536 + TRAFFICGEN_STC_RFC2889_AC_LR = 1000 + +The first 2 values are for address-learning test where as other 3 values are +for the Address caching capacity test. LR: Learning Rate. AC: Address Caching. +Maximum value for address is 16777216. Whereas, maximum for LR is 4294967295. -3. For RFC2889 tests, specifying the locations of the ports is mandatory. +Results for RFC2889 Tests: Forwarding tests outputs following values: .. code-block:: console - TRAFFICGEN_STC_RFC2889_TEST_FILE_NAME = " " - TRAFFICGEN_STC_RFC2889_LOCATIONS= " " + TX_RATE_FPS : "Transmission Rate in Frames/sec" + THROUGHPUT_RX_FPS: "Received Throughput Frames/sec" + TX_RATE_MBPS : " Transmission rate in MBPS" + THROUGHPUT_RX_MBPS: "Received Throughput in MBPS" + TX_RATE_PERCENT: "Transmission Rate in Percentage" + FRAME_LOSS_PERCENT: "Frame loss in Percentage" + FORWARDING_RATE_FPS: " Maximum Forwarding Rate in FPS" + + +Whereas, the address caching test outputs following values, + +.. code-block:: console + + CACHING_CAPACITY_ADDRS = 'Number of address it can cache' + ADDR_LEARNED_PERCENT = 'Percentage of address successfully learned' + +and address learning test outputs just a single value: + +.. code-block:: console + + OPTIMAL_LEARNING_RATE_FPS = 'Optimal learning rate in fps' + +Note that 'FORWARDING_RATE_FPS', 'CACHING_CAPACITY_ADDRS', +'ADDR_LEARNED_PERCENT' and 'OPTIMAL_LEARNING_RATE_FPS' are the new +result-constants added to support RFC2889 tests. .. _`Xena Networks`: diff --git a/docs/configguide/upgrade.rst b/docs/configguide/upgrade.rst index 3a970c6a..cf92572c 100644 --- a/docs/configguide/upgrade.rst +++ b/docs/configguide/upgrade.rst @@ -120,9 +120,7 @@ options: In case that any of these options is defined, then configuration must be updated. All paths to the tools are now stored inside ``PATHS`` dictionary. Please -refer to the paths-documentation_ and update your configuration where necessary. - -.. _paths-documentation: http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-paths-dictionary +refer to the :ref:`paths-documentation` and update your configuration where necessary. Configuration change via CLI ============================ @@ -134,7 +132,7 @@ possible to modify any configuration parameter via CLI or via **Parameters** section of the testcase definition. Old configuration options were obsoleted and it is required to specify configuration parameter name in the same form as it is defined inside configuration file, i.e. in uppercase. Please -refer to the overriding-parameters-documentation_ for additional details. +refer to the :ref:`overriding-parameters-documentation` for additional details. **NOTE:** In case that execution of VSPERF is automated by scripts (e.g. for CI purposes), then these scripts must be checked and updated too. It means, @@ -154,12 +152,9 @@ match to data types of original values from configuration files. In case that ``guest_nic1_name`` or ``guest_nic2_name`` is changed, then new dictionary ``GUEST_NICS`` must be modified accordingly. -Please see guest-configuration_ and ``conf/04_vnf.conf`` for additional +Please see :ref:`configuration-of-guest-options` and ``conf/04_vnf.conf`` for additional details. -.. _overriding-parameters-documentation: http://artifacts.opnfv.org/vswitchperf/docs/index.html#overriding-values-defined-in-configuration-files -.. _guest-configuration: http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-guest-options - Traffic configuration via CLI ============================= @@ -167,7 +162,7 @@ In previous releases it was possible to modify selected attributes of generated traffic via command line interface. This concept has been enhanced in Danube release and it is now possible to modify all traffic specific options via CLI or by ``TRAFFIC`` dictionary in configuration file. Detailed description -is available at configuration-of-traffic-dictionary_ section of documentation. +is available at :ref:`configuration-of-traffic-dictionary` section of documentation. Please check your automated scripts for VSPERF execution for following CLI parameters and update them according to the documentation: @@ -186,4 +181,3 @@ parameters and update them according to the documentation: stream_type traffic_type -.. _configuration-of-traffic-dictionary: http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-traffic-dictionary diff --git a/docs/design/LICENSE b/docs/design/LICENSE new file mode 100644 index 00000000..7bc572ce --- /dev/null +++ b/docs/design/LICENSE @@ -0,0 +1,2 @@ +This work is licensed under a Creative Commons Attribution 4.0 International License. +http://creativecommons.org/licenses/by/4.0 diff --git a/docs/design/index.rst b/docs/design/index.rst deleted file mode 100644 index a8a076f4..00000000 --- a/docs/design/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T and others. - -************** -VSPERF Design -************** - -.. toctree:: - :numbered: - :maxdepth: 3 - - vswitchperf_design.rst - - trafficgen_integration_guide.rst diff --git a/docs/design/trafficgen_integration_guide.rst b/docs/design/trafficgen_integration_guide.rst index 1457052b..382cedcb 100644 --- a/docs/design/trafficgen_integration_guide.rst +++ b/docs/design/trafficgen_integration_guide.rst @@ -11,8 +11,7 @@ Intended Audience This document is intended to aid those who want to integrate new traffic generator into the vsperf code. It is expected, that reader has already -read generic part of `VSPERF Design Document -<http://artifacts.opnfv.org/vswitchperf/docs/design/index.html>`__. +read generic part of :ref:`vsperf-design`. Let us create a sample traffic generator called **sample_tg**, step by step. @@ -132,6 +131,8 @@ Example in **tools/pkt_gen/sample_tg/sample_tg.py** module: def disconnect(self): pass +.. _step-5-supported-traffic-types: + Step 5 - supported traffic types ================================ @@ -192,7 +193,7 @@ functions: which are not listed below. Note: There are parameters specific to testing of tunnelling protocols, - which are discussed in detail at `integration tests userguide`_ + which are discussed in detail at :ref:`integration-tests` userguide. * param **traffic_type**: One of the supported traffic types, e.g. **rfc2544_throughput**, **rfc2544_continuous** @@ -235,5 +236,3 @@ are defined in **ResultsConstants** implemented in Throughput & Continuous and for Back2Back. The same key names should be used by all traffic generator implementations. -.. _integration tests userguide: http://artifacts.opnfv.org/vswitchperf/docs/userguide/integration.html - diff --git a/docs/design/vswitchperf_design.rst b/docs/design/vswitchperf_design.rst index bf82f9b8..da7ec6fd 100644 --- a/docs/design/vswitchperf_design.rst +++ b/docs/design/vswitchperf_design.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. +.. _vsperf-design: + ====================== VSPERF Design Document ====================== @@ -63,6 +65,7 @@ This is a typical flow of control for a test. .. image:: vsperf.png +.. _design-configuration: Configuration ============= @@ -101,11 +104,13 @@ The values in the file specified by ``--conf-file`` takes precedence over all the other configuration files and does not have to follow the naming convention. +.. _paths-documentation: + Configuration of PATHS dictionary --------------------------------- VSPERF uses external tools like Open vSwitch and Qemu for execution of testcases. These -tools may be downloaded and built automatically by `VSPERF installation scripts`_ +tools may be downloaded and built automatically (see :ref:`vsperf-installation-script`) or installed manually by user from binary packages. It is also possible to use a combination of both approaches, but it is essential to correctly set paths to all required tools. These paths are stored within a PATHS dictionary, which is evaluated before execution @@ -261,7 +266,7 @@ Note: In case of RHEL 7.3 OS usage, binary package configuration is required for Vanilla OVS tests. With the installation of a supported rpm for OVS there is a section in the ``conf\10_custom.conf`` file that can be used. -.. _VSPERF installation scripts: http://artifacts.opnfv.org/vswitchperf/docs/configguide/installation.html#other-requirements +.. _configuration-of-traffic-dictionary: Configuration of TRAFFIC dictionary ----------------------------------- @@ -388,6 +393,8 @@ Detailed description of ``TRAFFIC`` dictionary items follows: Data type: int (NOTE: must fit to 1 bit) Default value: 0 +.. _configuration-of-guest-options: + Configuration of GUEST options ------------------------------ @@ -491,6 +498,8 @@ Other Configuration ``conf.settings`` also loads configuration from the command line and from the environment. +.. _pxp-deployment: + PXP Deployment ============== diff --git a/docs/index.rst b/docs/index.rst index bce2aa61..889d4ab6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T and others. +.. (c) OPNFV, Intel Corporation, AT&T, Red Hat, Spirent, Ixia and others. .. OPNFV VSPERF Documentation master file. @@ -9,28 +9,84 @@ VSPERF ====== 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 -suitability of different vSwitch implementations in a Telco NFV deployment -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. +VSPERF provides an automated test-framework and comprehensive test suite based on +industry standards for measuring data-plane performance of Telco NFV switching +technologies as well as physical and virtual network interfaces (NFVI). The VSPERF +architecture is switch and traffic generator agnostic and provides full control of +software component versions and configurations as well as test-case customization. -* Project Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases -* Project Repository: https://git.opnfv.org/vswitchperf -* Project Artifacts: https://artifacts.opnfv.org/vswitchperf.html -* Continuous Integration https://build.opnfv.org/ci/view/vswitchperf/ +The Danube release of VSPERF includes improvements in documentation and capabilities. +This includes additional test-cases such as RFC 5481 Latency test and RFC-2889 +address-learning-rate test. Hardware traffic generator support is now provided for +Spirent and Xena in addition to Ixia. The Moongen software traffic generator is also +now fully supported. VSPERF can be used in a variety of modes for configuration and +setup of the network and/or for control of the test-generator and test execution. + +* Wiki: https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases +* Repository: https://git.opnfv.org/vswitchperf +* Artifacts: https://artifacts.opnfv.org/vswitchperf.html +* Continuous Integration status: https://build.opnfv.org/ci/view/vswitchperf/ + +****************************** +VSPERF Installation Guide +****************************** .. toctree:: - :maxdepth: 3 + :caption: VSPERF Installation Guide + :maxdepth: 5 + :numbered: 5 + + ./configguide/installation.rst + ./configguide/upgrade.rst + ./configguide/trafficgen.rst + +****************************** +VSPERF User Guide +****************************** + +.. toctree:: + :caption: VSPERF User Guide + :maxdepth: 5 :numbered: 5 - ./configguide/index.rst - ./userguide/index.rst - ./design/index.rst - ./requirements/index.rst - ./release/index.rst - ./results/index.rst + ./userguide/testusage.rst + ./userguide/teststeps.rst + ./userguide/integration.rst + Yardstick integration <./userguide/yardstick.rst> + +************** +VSPERF Design +************** + +.. toctree:: + :caption: VSPERF Design + :maxdepth: 5 + :numbered: 5 + + ./design/vswitchperf_design.rst + ./design/trafficgen_integration_guide.rst + +******************* +VSPERF Requirements +******************* + +.. toctree:: + :caption: VSPERF Requirements + :maxdepth: 5 + :numbered: 5 + + ./requirements/vswitchperf_ltp.rst + ./requirements/vswitchperf_ltd.rst + +************** +VSPERF Results +************** + +.. toctree:: + :maxdepth: 3 + + ./results/scenario.rst + ./results/results.rst Indices ======= diff --git a/docs/release/index.rst b/docs/release/index.rst deleted file mode 100644 index bf0b9d18..00000000 --- a/docs/release/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T and others. - -*********** -VSPERF News -*********** - -.. toctree:: - :numbered: - :maxdepth: 3 - - NEWS.rst diff --git a/docs/release/NEWS.rst b/docs/release/release-notes/vsperf-release.rst index a31e2738..52a01abc 100644 --- a/docs/release/NEWS.rst +++ b/docs/release/release-notes/vsperf-release.rst @@ -2,6 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. +******************** +VSPERF Release Notes +******************** + OPNFV Danube Release ==================== @@ -16,6 +20,7 @@ OPNFV Danube Release * Support for Ubuntu 16.04 LTS and 16.10 * Support for RHEL7.3 * Support for CentOS7.3 + * Support for openSUSE Leap 42.2 * Traffic Generators: diff --git a/docs/requirements/LICENSE b/docs/requirements/LICENSE new file mode 100644 index 00000000..7bc572ce --- /dev/null +++ b/docs/requirements/LICENSE @@ -0,0 +1,2 @@ +This work is licensed under a Creative Commons Attribution 4.0 International License. +http://creativecommons.org/licenses/by/4.0 diff --git a/docs/requirements/ietf_draft/LICENSE b/docs/requirements/ietf_draft/LICENSE new file mode 100644 index 00000000..7fc9ae14 --- /dev/null +++ b/docs/requirements/ietf_draft/LICENSE @@ -0,0 +1,12 @@ +Copyright (c) 2016 IETF Trust and the persons identified as the +document authors. All rights reserved. + +This document is subject to BCP 78 and the IETF Trust's Legal +Provisions Relating to IETF Documents +(http://trustee.ietf.org/license-info) in effect on the date of +publication of this document. Please review these documents +carefully, as they describe your rights and restrictions with respect +to this document. Code Components extracted from this document must +include Simplified BSD License text as described in Section 4.e of +the Trust Legal Provisions and are provided without warranty as +described in the Simplified BSD License. diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst deleted file mode 100644 index 311ddb07..00000000 --- a/docs/requirements/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T and others. - -.. toctree:: - :maxdepth: 3 - :numbered: 5 - - vswitchperf_ltp.rst - vswitchperf_ltd.rst - diff --git a/docs/requirements/vswitchperf_ltd.rst b/docs/requirements/vswitchperf_ltd.rst index 69497c5c..e1372520 100644 --- a/docs/requirements/vswitchperf_ltd.rst +++ b/docs/requirements/vswitchperf_ltd.rst @@ -127,6 +127,8 @@ expected that more will be added. .. 3.2.2.1.1 +.. _PacketLossRatio: + Test ID: LTD.Throughput.RFC2544.PacketLossRatio ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -144,8 +146,8 @@ Test ID: LTD.Throughput.RFC2544.PacketLossRatio Note: Other values can be tested if required by the user. - The selected frame sizes are those previously defined under `Default - Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + The selected frame sizes are those previously defined under + :ref:`default-test-parameters`. The test can also be used to determine the average latency of the traffic. Under the `RFC2544 <https://www.rfc-editor.org/rfc/rfc2544.txt>`__ @@ -178,6 +180,8 @@ Test ID: LTD.Throughput.RFC2544.PacketLossRatio .. 3.2.2.1.2 +.. _PacketLossRatioFrameModification: + Test ID: LTD.Throughput.RFC2544.PacketLossRatioFrameModification ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -196,8 +200,8 @@ Test ID: LTD.Throughput.RFC2544.PacketLossRatioFrameModification Note: Other values can be tested if required by the user. - The selected frame sizes are those previously defined under `Default - Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + The selected frame sizes are those previously defined under + :ref:`default-test-parameters`. The test can also be used to determine the average latency of the traffic. Under the `RFC2544 <https://www.rfc-editor.org/rfc/rfc2544.txt>`__ @@ -267,8 +271,8 @@ Test ID: LTD.Throughput.RFC2544.Profile and latency as the offered rate increases is slow and graceful or sudden and severe. - The selected frame sizes are those previously defined under `Default - Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + The selected frame sizes are those previously defined under + :ref:`default-test-parameters`. The offered traffic rate is described as a percentage delta with respect to the DUT's RFC 2544 Throughput as determined by @@ -319,8 +323,7 @@ Test ID: LTD.Throughput.RFC2544.SystemRecoveryTime The aim of this test is to determine the length of time it takes the DUT to recover from an overload condition for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those - previously defined under `Default Test Parameters - <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__, + previously defined under :ref:`default-test-parameters`, traffic should be sent to the DUT under normal conditions. During the duration of the test and while the traffic flows are passing though the DUT, at least one situation leading to an overload condition for the DUT @@ -359,6 +362,8 @@ Test ID: LTD.Throughput.RFC2544.SystemRecoveryTime .. 3.2.2.1.5 +.. _BackToBackFrames: + Test ID: LTD.Throughput.RFC2544.BackToBackFrames ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -372,9 +377,7 @@ Test ID: LTD.Throughput.RFC2544.BackToBackFrames The aim of this test is to characterize the ability of the DUT to process back-to-back frames. For each frame size previously defined - under `Default Test Parameters - <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__, - a burst of traffic + under :ref:`default-test-parameters`, a burst of traffic is sent to the DUT with the minimum inter-frame gap between each frame. If the number of received frames equals the number of frames that were transmitted, the burst size should be increased and traffic is sent to @@ -527,8 +530,7 @@ Test ID: LTD.Throughput.RFC6201.ResetTime Both reset methods SHOULD be exercised. - For each frame size previously defined under `Default Test - Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__, + For each frame size previously defined under :ref:`default-test-parameters`, traffic should be sent to the DUT under normal conditions. During the duration of the test and while the traffic flows are passing through the DUT, the DUT should be reset and the Reset @@ -613,8 +615,7 @@ Test ID: LTD.Throughput.RFC2889.MaxForwardingRate This test measures the DUT's Max Forwarding Rate when the Offered Load is varied between the throughput and the Maximum Offered Load for fixed length frames at a fixed time interval. The selected frame sizes are - those previously defined under `Default Test - Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + those previously defined under :ref:`default-test-parameters`. The throughput is the maximum offered load with 0% frame loss (measured by the prerequisite test), and the Maximum Offered Load (as defined by @@ -749,8 +750,7 @@ Test ID: LTD.Throughput.RFC2889.BroadcastFrameForwarding The aim of this test is to determine the maximum forwarding rate of the DUT when forwarding broadcast traffic. For each frame previously defined - under `Default Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__, - the traffic should + under :ref:`default-test-parameters`, the traffic should be set up as broadcast traffic. The traffic throughput of the DUT should be measured. @@ -917,8 +917,8 @@ Test ID: LTD.Throughput.Overlay.Network.<tech>.RFC2544.PacketLossRatio - De-encapsulate the packet, if required - Switch the packet to the correct port - The selected frame sizes are those previously defined under `Default - Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + The selected frame sizes are those previously defined under + :ref:`default-test-parameters`. Thus, each test comprises an overlay technology, a network function, and a packet size *with* overlay network overhead included @@ -1041,8 +1041,8 @@ Test ID: LTD.Throughput.RFC2544.MatchAction.PacketLossRatio The default loss percentages to be tested are: - X = 0% - X = 10^-7% Other values can be tested if required by the user. The selected - frame sizes are those previously defined under `Default Test Parameters - <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + frame sizes are those previously defined under + :ref:`default-test-parameters`. The test can also be used to determine the average latency of the traffic when a match action is applied to packets in a flow. Under @@ -1189,6 +1189,8 @@ It is expected that more will be added. .. 3.2.2.3.1 +.. _Scalability0PacketLoss: + Test ID: LTD.Scalability.Flows.RFC2544.0PacketLoss ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1207,8 +1209,7 @@ Test ID: LTD.Scalability.Flows.RFC2544.0PacketLoss through the fastpath, as such the flows need to be installed on the DUT before passing traffic. - For each frame size previously defined under `Default Test - Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__ + For each frame size previously defined under :ref:`default-test-parameters` and for each of the following number of flows: - 1,000 @@ -1336,8 +1337,8 @@ Test ID: LTD.Scalability.VNF.RFC2544.PacketLossRatio would be to continue to add VNFs without bringing down the DUT. The approach used needs to be documented as part of the test report. - The selected frame sizes are those previously defined under `Default - Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + The selected frame sizes are those previously defined under + :ref:`default-test-parameters`. The test can also be used to determine the average latency of the traffic. Under the `RFC2544 <https://www.rfc-editor.org/rfc/rfc2544.txt>`__ @@ -1397,8 +1398,8 @@ Test ID: LTD.Scalability.VNF.RFC2544.PacketLossProfile and graceful, or sudden and severe. The minimum number of VNFs to be tested is 3. - The selected frame sizes are those previously defined under `Default - Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + The selected frame sizes are those previously defined under + :ref:`default-test-parameters`. The offered traffic rate is described as a percentage delta with respect to the DUT's RFC 2544 Throughput as determined by @@ -1479,8 +1480,7 @@ Test ID: LTD.Activation.RFC2889.AddressCachingCapacity MAC learning. The aim of this test is to determine the address caching capacity of the DUT for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined - under `Default Test Parameters - <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__. + under :ref:`default-test-parameters`. In order to run this test the aging time, that is the maximum time the DUT will keep a learned address in its flow table, and a set of initial @@ -1533,8 +1533,7 @@ Test ID: LTD.Activation.RFC2889.AddressLearningRate MAC learning. The aim of this test is to determine the rate of address learning of the DUT for a constant load (fixed length frames at a fixed interval time). The selected frame sizes are those previously defined - under `Default Test Parameters <http://artifacts.opnfv.org/vswitchperf/docs/index.html#default-test-parameters>`__, - traffic should be + under :ref:`default-test-parameters`, traffic should be sent with each IPv4/IPv6 address incremented by one. The rate at which the DUT learns a new address should be measured. The maximum caching capacity from LTD.Memory.RFC2889.AddressCachingCapacity should be taken @@ -1626,6 +1625,8 @@ should be required. It is expected that more will be added. .. 3.2.2.6.1 +.. _CPU0PacketLoss: + Test ID: LTD.Stress.RFC2544.0PacketLoss ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/requirements/vswitchperf_ltp.rst b/docs/requirements/vswitchperf_ltp.rst index 14303de5..2b74d676 100644 --- a/docs/requirements/vswitchperf_ltp.rst +++ b/docs/requirements/vswitchperf_ltp.rst @@ -303,6 +303,8 @@ datapaths to physical ports (to NICs) and to logical ports (to VNFs): .. 3.2.5.1.1 +.. _Phy2Phy: + Physical port → vSwitch → physical port ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console @@ -326,6 +328,8 @@ Physical port → vSwitch → physical port .. 3.2.5.1.2 +.. _PVP: + Physical port → vSwitch → VNF → vSwitch → physical port ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console @@ -365,6 +369,8 @@ Physical port → vSwitch → VNF → vSwitch → physical port .. 3.2.5.1.3 +.. _PVVP: + Physical port → vSwitch → VNF → vSwitch → VNF → vSwitch → physical port ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -639,6 +645,8 @@ Suitable real Telco workload VNFs are yet to be identified. .. 3.2.5.2.1 +.. _default-test-parameters: + Default Test Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/results/index.rst b/docs/results/index.rst deleted file mode 100644 index 04899b5a..00000000 --- a/docs/results/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T and others. - -************** -VSPERF Results -************** - -.. toctree:: - :numbered: - :maxdepth: 3 - - scenario.rst - results.rst diff --git a/docs/results/scenario.rst b/docs/results/scenario.rst index cb42c8dc..49ff626a 100644 --- a/docs/results/scenario.rst +++ b/docs/results/scenario.rst @@ -9,34 +9,33 @@ Available Tests and aspects of scenarios: ===================== =========================================================== Framework Test Definition ===================== =========================================================== -phy2phy_tput PacketLossRatio_ for Phy2Phy_ -back2back BackToBackFrames_ for Phy2Phy_ -phy2phy_tput_mod_vlan PacketLossRatioFrameModification_ for Phy2Phy_ -phy2phy_cont Phy2Phy_ blast vswitch at x% TX rate and measure throughput -pvp_cont PVP_ blast vswitch at x% TX rate and measure throughput -pvvp_cont PVVP_ blast vswitch at x% TX rate and measure throughput -phy2phy_scalability Scalability0PacketLoss_ for Phy2Phy_ -pvp_tput PacketLossRatio_ for PVP_ -pvp_back2back BackToBackFrames_ for PVP_ -pvvp_tput PacketLossRatio_ for PVVP_ -pvvp_back2back BackToBackFrames_ for PVVP_ -phy2phy_cpu_load CPU0PacketLoss_ for Phy2Phy_ -phy2phy_mem_load Same as CPU0PacketLoss_ but using a memory intensive app +phy2phy_tput :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`Phy2Phy <Phy2Phy>` +back2back :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`Phy2Phy <Phy2Phy>` +phy2phy_tput_mod_vlan :ref:`PacketLossRatioFrameModification <PacketLossRatioFrameModification>` for :ref:`Phy2Phy <Phy2Phy>` +phy2phy_cont :ref:`Phy2Phy <Phy2Phy>` blast vswitch at x% TX rate and measure throughput +pvp_cont :ref:`PVP <PVP>` blast vswitch at x% TX rate and measure throughput +pvvp_cont :ref:`PVVP <PVVP>` blast vswitch at x% TX rate and measure throughput +phy2phy_scalability :ref:`Scalability0PacketLoss <Scalability0PacketLoss>` for :ref:`Phy2Phy <Phy2Phy>` +pvp_tput :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`PVP <PVP>` +pvp_back2back :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`PVP <PVP>` +pvvp_tput :ref:`PacketLossRatio <PacketLossRatio>` for :ref:`PVVP <PVVP>` +pvvp_back2back :ref:`BackToBackFrames <BackToBackFrames>` for :ref:`PVVP <PVVP>` +phy2phy_cpu_load :ref:`CPU0PacketLoss <CPU0PacketLoss>` for :ref:`Phy2Phy <Phy2Phy>` +phy2phy_mem_load Same as :ref:`CPU0PacketLoss <CPU0PacketLoss>` but using a memory intensive app ===================== =========================================================== Supported deployment scenarios: -* Phy2Phy_: Physical port -> vSwitch -> Physical port. -* PVP_: Physical port -> vSwitch -> VNF -> vSwitch -> Physical port. -* PVVP_: Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch -> +* :ref:`Phy2Phy <Phy2Phy>`: Physical port -> vSwitch -> Physical port. +* :ref:`PVP <PVP>`: Physical port -> vSwitch -> VNF -> vSwitch -> Physical port. +* :ref:`PVVP <PVVP>`: Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch -> Physical port. Loopback applications in the Guest can be: * `DPDK testpmd <http://dpdk.org/doc/guides/testpmd_app_ug/index.html>`_. * Linux Bridge. -* `l2fwd - <http://artifacts.opnfv.org/vswitchperf/docs/userguide/testusage.html#l2fwd-kernel-module>`_. +* :ref:`l2fwd-module` Supported traffic generators: @@ -44,19 +43,3 @@ Supported traffic generators: * Spirent. * Dummy. -.. _PacketLossRatio: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-throughput-rfc2544-packetlossratio - -.. _BackToBackFrames: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-throughput-rfc2544-backtobackframes - -.. _PacketLossRatioFrameModification: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-throughput-rfc2544-packetlossratioframemodification - -.. _Scalability0PacketLoss: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-scalability-flows-rfc2544-0packetloss - -.. _CPU0PacketLoss: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html#test-id-ltd-stress-rfc2544-0packetloss - -.. _Phy2Phy : http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltp.html#physical-port-vswitch-physical-port - -.. _PVP: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltp.html#physical-port-vswitch-vnf-vswitch-physical-port - -.. _PVVP: http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltp.html#physical-port-vswitch-vnf-vswitch-vnf-vswitch-physical-port - diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index a1cce262..00000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation, AT&T and others. - -****************************** -VSPERF User Guide -****************************** - -.. toctree:: - :numbered: - :maxdepth: 3 - - testusage.rst - teststeps.rst - integration.rst - yardstick.rst diff --git a/docs/userguide/integration.rst b/docs/userguide/integration.rst index 60ed9245..83b29da6 100644 --- a/docs/userguide/integration.rst +++ b/docs/userguide/integration.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. +.. _integration-tests: + Integration tests ================= diff --git a/docs/userguide/teststeps.rst b/docs/userguide/teststeps.rst index 5029f538..870c3d80 100644 --- a/docs/userguide/teststeps.rst +++ b/docs/userguide/teststeps.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. +.. _step-driven-tests: + Step driven tests ================= @@ -115,8 +117,8 @@ of supported objects and their most common functions follows: * ``send_traffic traffic`` - starts a traffic based on the vsperf configuration and given ``traffic`` dictionary. More details about ``traffic`` dictionary - and its possible values are available at `Traffic Generator Integration Guide - <http://artifacts.opnfv.org/vswitchperf/docs/design/trafficgen_integration_guide.html#step-5-supported-traffic-types>`__ + and its possible values are available at :ref:`Traffic Generator Integration Guide + <step-5-supported-traffic-types>` Examples: diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst index 721fd635..c6037aaf 100644 --- a/docs/userguide/testusage.rst +++ b/docs/userguide/testusage.rst @@ -21,23 +21,19 @@ support in VSPERF includes: - 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 -<http://artifacts.opnfv.org/vswitchperf/docs/configguide/trafficgen.html>`__ +If you want to use another traffic generator, please select the :ref:`trafficgen-dummy` +generator. VSPERF Installation ^^^^^^^^^^^^^^^^^^^ 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. +please follow the `installation instructions <vsperf-installation>`. Traffic Generator Setup ^^^^^^^^^^^^^^^^^^^^^^^ -Follow the `Traffic generator instructions -<http://artifacts.opnfv.org/vswitchperf/docs/configguide/trafficgen.html>`__ to +Follow the `Traffic generator instructions <trafficgen-installation>` to install and configure a suitable traffic generator. Cloning and building src dependencies @@ -86,8 +82,8 @@ contents. Any configuration item mentioned in any .conf file in the custom configuration value. Further details about configuration files evaluation and special behaviour -of options with ``GUEST_`` prefix could be found at `design document -<http://artifacts.opnfv.org/vswitchperf/docs/design/vswitchperf_design.html#configuration>`__. +of options with ``GUEST_`` prefix could be found at :ref:`design document +<design-configuration>`. Using a custom settings file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -111,8 +107,10 @@ described like so (1 = max priority): 4. Configuration file(s) Further details about configuration files evaluation and special behaviour -of options with ``GUEST_`` prefix could be found at `design document -<http://artifacts.opnfv.org/vswitchperf/docs/design/vswitchperf_design.html#configuration>`__. +of options with ``GUEST_`` prefix could be found at :ref:`design document +<design-configuration>`. + +.. _overriding-parameters-documentation: Overriding values defined in configuration files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -163,27 +161,14 @@ section of test case definition. It is also forbidden to redefine a value of vloop_vnf ^^^^^^^^^ -vsperf uses a VM image called vloop_vnf for looping traffic in the deployment +VSPERF uses a VM image called vloop_vnf for looping traffic in the deployment scenarios involving VMs. The image can be downloaded from `<http://artifacts.opnfv.org/>`__. -.. code-block:: console - - $ 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 -<http://artifacts.opnfv.org/vswitchperf/docs/configguide/installation.html>`__ - - -vloop_vnf forwards traffic through a VM using one of: +Please see the installation instructions for information on :ref:`vloop-vnf` +images. -* DPDK testpmd -* Linux Bridge -* l2fwd kernel Module. - -Alternatively you can use your own QEMU image. +.. _l2fwd-module: l2fwd Kernel Module ^^^^^^^^^^^^^^^^^^^ @@ -350,6 +335,43 @@ To run tests using Vanilla OVS: $ ./vsperf --conf-file<path_to_custom_conf>/10_custom.conf +.. _vpp-test: + +Executing VPP tests +^^^^^^^^^^^^^^^^^^^ + +Currently it is not possible to use standard scenario deployments for execution of +tests with VPP. It means, that deployments ``p2p``, ``pvp``, ``pvvp`` and in general any +:ref:`pxp-deployment` won't work with VPP. However it is possible to use VPP in +:ref:`step-driven-tests`. A basic set of VPP testcases covering ``phy2phy``, ``pvp`` +and ``pvvp`` tests are already prepared. + +List of performance tests with VPP support follows: + +* phy2phy_tput_vpp: VPP: LTD.Throughput.RFC2544.PacketLossRatio +* phy2phy_cont_vpp: VPP: Phy2Phy Continuous Stream +* phy2phy_back2back_vpp: VPP: LTD.Throughput.RFC2544.BackToBackFrames +* pvp_tput_vpp: VPP: LTD.Throughput.RFC2544.PacketLossRatio +* pvp_cont_vpp: VPP: PVP Continuous Stream +* pvp_back2back_vpp: VPP: LTD.Throughput.RFC2544.BackToBackFrames +* pvvp_tput_vpp: VPP: LTD.Throughput.RFC2544.PacketLossRatio +* pvvp_cont_vpp: VPP: PVP Continuous Stream +* pvvp_back2back_vpp: VPP: LTD.Throughput.RFC2544.BackToBackFrames + +In order to execute testcases with VPP it is required to: + +* install VPP manually, see :ref:`vpp-installation` +* configure ``WHITELIST_NICS``, with two physical NICs connected to the traffic generator +* configure traffic generator, see :ref:`trafficgen-installation` + +After that it is possible to execute VPP testcases listed above. + +For example: + +.. code-block:: console + + $ ./vsperf --conf-file=<path_to_custom_conf> phy2phy_tput_vpp + .. _vfio-pci: Using vfio_pci with DPDK @@ -704,7 +726,8 @@ application to use the correct number of nb-cores. .. code-block:: python - VSWITCHD_DPDK_ARGS = ['-l', '46,44,42,40,38', '-n', '4', '--socket-mem 1024,0'] + DPDK_SOCKET_MEM = ['1024', '0'] + VSWITCHD_DPDK_ARGS = ['-l', '46,44,42,40,38', '-n', '4'] TESTPMD_ARGS = ['--nb-cores=4', '--txq=1', '--rxq=1'] For guest TestPMD 3 VCpus should be assigned with the following TestPMD params. @@ -748,8 +771,7 @@ of traffic generator can be modified through ``TRAFFIC`` dictionary passed to th ``--test-params`` option. It is not needed to specify all values of ``TRAFFIC`` dictionary. It is sufficient to specify only values, which should be changed. Detailed description of ``TRAFFIC`` dictionary can be found at -`Configuration of TRAFFIC dictionary -<http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-traffic-dictionary>`__ +:ref:`configuration-of-traffic-dictionary`. Example of execution of VSPERF in "trafficgen" mode: @@ -806,21 +828,21 @@ an appropriate amount of memory: .. code-block:: python - VSWITCHD_DPDK_ARGS = ['-c', '0x4', '-n', '4', '--socket-mem 1024,0'] + DPDK_SOCKET_MEM = ['1024', '0'] + VSWITCHD_DPDK_ARGS = ['-c', '0x4', '-n', '4'] VSWITCHD_DPDK_CONFIG = { 'dpdk-init' : 'true', 'dpdk-lcore-mask' : '0x4', 'dpdk-socket-mem' : '1024,0', } -Note: Option VSWITCHD_DPDK_ARGS is used for vswitchd, which supports --dpdk -parameter. In recent vswitchd versions, option VSWITCHD_DPDK_CONFIG will be -used to configure vswitchd via ovs-vsctl calls. +Note: Option ``VSWITCHD_DPDK_ARGS`` is used for vswitchd, which supports ``--dpdk`` +parameter. In recent vswitchd versions, option ``VSWITCHD_DPDK_CONFIG`` will be +used to configure vswitchd via ``ovs-vsctl`` calls. More information ^^^^^^^^^^^^^^^^ -For more information and details refer to the vSwitchPerf user guide at: -http://artifacts.opnfv.org/vswitchperf/docs/userguide/index.html +For more information and details refer to the rest of vSwitchPerfuser documentation. diff --git a/docs/userguide/yardstick.rst b/docs/userguide/yardstick.rst index c906df8e..b5e5c72d 100644 --- a/docs/userguide/yardstick.rst +++ b/docs/userguide/yardstick.rst @@ -65,14 +65,10 @@ Preparation of custom VM image In general, any Linux distribution supported by vswitchperf can be used as a base image for vswitchperf. One of the possibilities is to modify vloop-vnf -image, which can be downloaded from `<http://artifacts.opnfv.org/vswitchperf.html/>`__. +image, which can be downloaded from `<http://artifacts.opnfv.org/vswitchperf.html/>`__ +(see :ref:`vloop-vnf`). -.. code-block:: console - - $ wget http://artifacts.opnfv.org/vswitchperf/vnf/vloop-vnf-ubuntu-14.04_20160823.qcow2 - -Please follow the `installation instructions -<http://artifacts.opnfv.org/vswitchperf/docs/configguide/installation.html>`__ to +Please follow the :ref:`vsperf-installation` to install vswitchperf inside vloop-vnf image. As vswitchperf will be run in trafficgen mode, it is possible to skip installation and compilation of OVS, QEMU and DPDK to keep image size smaller. |