summaryrefslogtreecommitdiffstats
path: root/docs/design
diff options
context:
space:
mode:
Diffstat (limited to 'docs/design')
-rw-r--r--docs/design/index.rst15
-rw-r--r--docs/design/trafficgen_integration_guide.rst9
-rw-r--r--docs/design/vswitchperf_design.rst11
3 files changed, 13 insertions, 22 deletions
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..9e74e599 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
------------------------------