+++ /dev/null
-.. 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
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation, AT&T and others.
+.. _vsperf-installation:
+
======================
Installing vswitchperf
======================
* version with development tools required for build of DPDK and l2fwd
+.. _vsperf-installation-script:
+
Installation
------------
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation, AT&T and others.
+.. _trafficgen-installation:
+
===========================
'vsperf' Traffic Gen Guide
===========================
$ ./vsperf --test-params "TRAFFICGEN_PKT_SIZES=(x,y);TRAFFICGEN_DURATION=10;" \
"TRAFFICGEN_RFC2544_TESTS=1" $TESTNAME
+.. _trafficgen-dummy:
+
Dummy
-----
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
============================
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,
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
=============================
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:
stream_type
traffic_type
-.. _configuration-of-traffic-dictionary: http://artifacts.opnfv.org/vswitchperf/docs/index.html#configuration-of-traffic-dictionary
+++ /dev/null
-.. 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
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.
def disconnect(self):
pass
+.. _step-5-supported-traffic-types:
+
Step 5 - supported traffic types
================================
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**
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
-
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation, AT&T and others.
+.. _vsperf-design:
+
======================
VSPERF Design Document
======================
.. image:: vsperf.png
+.. _design-configuration:
Configuration
=============
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
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
-----------------------------------
Data type: int (NOTE: must fit to 1 bit)
Default value: 0
+.. _configuration-of-guest-options:
+
Configuration of GUEST options
------------------------------
* Project Artifacts: https://artifacts.opnfv.org/vswitchperf.html
* Continuous Integration 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
+
+ ./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
- ./configguide/index.rst
- ./userguide/index.rst
- ./design/index.rst
- ./requirements/index.rst
- ./release/index.rst
- ./results/index.rst
+ ./requirements/vswitchperf_ltp.rst
+ ./requirements/vswitchperf_ltd.rst
+
+.. toctree::
+ :titlesonly:
+ :maxdepth: 3
+
+ ./release/NEWS.rst
+
+**************
+VSPERF Results
+**************
+
+.. toctree::
+ :maxdepth: 3
+
+ ./results/scenario.rst
+ ./results/results.rst
Indices
=======
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation, AT&T and others.
+***********
+VSPERF News
+***********
+
OPNFV Danube Release
====================
+++ /dev/null
-.. 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
+++ /dev/null
-.. 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
-
.. 3.2.2.1.1
+.. _PacketLossRatio:
+
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>`__
.. 3.2.2.1.2
+.. _PacketLossRatioFrameModification:
+
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>`__
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
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
.. 3.2.2.1.5
+.. _BackToBackFrames:
+
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
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
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
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.
- 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
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
.. 3.2.2.3.1
+.. _Scalability0PacketLoss:
+
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
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>`__
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
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
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
.. 3.2.2.6.1
+.. _CPU0PacketLoss:
+
Test ID: LTD.Stress.RFC2544.0PacketLoss
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. 3.2.5.1.1
+.. _Phy2Phy:
+
Physical port → vSwitch → physical port
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
.. 3.2.5.1.2
+.. _PVP:
+
Physical port → vSwitch → VNF → vSwitch → physical port
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
.. 3.2.5.1.3
+.. _PVVP:
+
Physical port → vSwitch → VNF → vSwitch → VNF → vSwitch → physical port
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. 3.2.5.2.1
+.. _default-test-parameters:
+
Default Test Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+++ /dev/null
-.. 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
===================== ===========================================================
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:
* 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
-
+++ /dev/null
-.. 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
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation, AT&T and others.
+.. _integration-tests:
+
Integration tests
=================
* ``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:
- 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
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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:
-
-* DPDK testpmd
-* Linux Bridge
-* l2fwd kernel Module.
+Please see the installation instructions for information on :ref:`vloop-vnf`
+images.
-Alternatively you can use your own QEMU image.
+.. _l2fwd-module:
l2fwd Kernel Module
^^^^^^^^^^^^^^^^^^^
``--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:
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.
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.
Code Review / vswitchperf.git / commitdiff