diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/index.rst | 16 | ||||
| -rw-r--r-- | docs/userguide/integration.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/teststeps.rst | 4 | ||||
| -rw-r--r-- | docs/userguide/testusage.rst | 49 | ||||
| -rw-r--r-- | docs/userguide/yardstick.rst | 10 |
5 files changed, 23 insertions, 58 deletions
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..4e6c0808 100644 --- a/docs/userguide/teststeps.rst +++ b/docs/userguide/teststeps.rst @@ -115,8 +115,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..0055164e 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: - -* 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 ^^^^^^^^^^^^^^^^^^^ @@ -748,8 +733,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: @@ -821,6 +805,5 @@ 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. |