aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAna C <ana.cunha@ericsson.com>2016-02-10 19:07:13 +0100
committerAna C <ana.cunha@ericsson.com>2016-02-11 09:39:59 +0100
commit702eebbf78b29fb9046436dd71575b4f210f4731 (patch)
treee7ef6278850111d67e414a44561066ec00061331
parentfd3dd37a734a741a823962dbc646480ece70b3bb (diff)
Add license info and update structure
This change adds license to all .rst files under userguide. It also combines all configguide files into user guide. New reference.rst with list of links. Updated glossary, removed separate directories for apexlake and yardstick framework. Change-Id: I6532ed073905b0fa85a17e759ea7dc3c24acb91f Signed-off-by: Ana C <ana.cunha@ericsson.com>
-rw-r--r--docs/configguide/yardstick_testcases/01-introduction.rst38
-rw-r--r--docs/configguide/yardstick_testcases/glossary.rst33
-rw-r--r--docs/configguide/yardstick_testcases/index.rst12
-rw-r--r--docs/userguide/01-introduction.rst61
-rw-r--r--docs/userguide/02-methodology.rst (renamed from docs/configguide/yardstick_testcases/02-methodology.rst)31
-rw-r--r--docs/userguide/03-installation.rst (renamed from docs/userguide/yardstick_framework/03-installation.rst)21
-rw-r--r--docs/userguide/03-list-of-tcs.rst (renamed from docs/configguide/yardstick_testcases/03-list-of-tcs.rst)5
-rw-r--r--docs/userguide/04-vtc-overview.rst (renamed from docs/configguide/yardstick_testcases/04-vtc-overview.rst)30
-rwxr-xr-xdocs/userguide/Yardstick_task_templates.rst (renamed from docs/configguide/yardstick_testcases/Yardstick_task_templates.rst)5
-rw-r--r--docs/userguide/apexlake_api.rst (renamed from docs/userguide/apexlake_framework/apexlake_api.rst)12
-rw-r--r--docs/userguide/apexlake_framework/index.rst11
-rw-r--r--docs/userguide/apexlake_installation.rst (renamed from docs/userguide/apexlake_framework/apexlake_installation.rst)105
-rw-r--r--docs/userguide/glossary.rst65
-rw-r--r--docs/userguide/index.rst21
-rw-r--r--docs/userguide/opnfv_yardstick_tc001.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc001.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc002.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc002.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc005.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc005.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc006.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc006.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc007.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc007.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc008.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc008.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc009.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc009.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc010.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc010.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc011.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc011.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc012.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc012.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc014.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc014.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc019.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc019.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc020.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc020.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc021.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc021.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc024.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc024.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc025.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc025.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc027.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc027.rst)7
-rw-r--r--docs/userguide/opnfv_yardstick_tc028.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc028.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc037.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc037.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc038.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc038.rst)5
-rw-r--r--docs/userguide/opnfv_yardstick_tc040.rst (renamed from docs/configguide/yardstick_testcases/opnfv_yardstick_tc040.rst)5
-rw-r--r--docs/userguide/references.rst50
-rw-r--r--docs/userguide/testcase_description_v2_template.rst (renamed from docs/configguide/yardstick_testcases/testcase_description_v2_template.rst)8
-rw-r--r--docs/userguide/yardstick_framework/index.rst9
38 files changed, 448 insertions, 176 deletions
diff --git a/docs/configguide/yardstick_testcases/01-introduction.rst b/docs/configguide/yardstick_testcases/01-introduction.rst
deleted file mode 100644
index 6cca2875e..000000000
--- a/docs/configguide/yardstick_testcases/01-introduction.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-============
-Introduction
-============
-
-**Welcome to Yardstick's documentation !**
-
-.. _Yardstick: https://wiki.opnfv.org/yardstick
-
-Yardstick_ is an OPNFV Project.
-
-The project's goal is to verify infrastructure compliance, from the perspective
-of a :term:`VNF`.
-
-The Project's scope is the development of a test framework, *Yardstick*, test
-cases and test stimuli to enable :term:`NFVI` verification.
-The Project also includes a sample :term:`VNF`, the :term:`VTC` and its
-experimental framework, *ApexLake* !
-
-The chapter :doc:`02-methodology` describes the methodology implemented by the
-Yardstick Project for :term:`NFVI` verification. The chapter
-:doc:`03-list-of-tcs` includes a list of available Yardstick test cases.
-
-Yardstick is used for verifying the OPNFV infrastructure and some of the OPNFV
-features, listed in :doc:`03-list-of-tcs`.
-
-The *Yardstick* framework is deployed in several OPNFV community labs. It is
-installer, infrastructure and application independent.
-
-.. _Pharos: https://wiki.opnfv.org/pharos
-
-.. seealso:: Pharos_ for information on OPNFV community labs.
-
-Contact Yardstick
-=================
-
-Feedback? `Contact us`_
-
-.. _Contact us: opnfv-users@lists.opnfv.org
diff --git a/docs/configguide/yardstick_testcases/glossary.rst b/docs/configguide/yardstick_testcases/glossary.rst
deleted file mode 100644
index 8ce9a6ba0..000000000
--- a/docs/configguide/yardstick_testcases/glossary.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-==================
-Yardstick Glossary
-==================
-
-.. glossary::
- :sorted:
-
- DPI
- Deep Packet Inspection
-
- DSCP
- Differentiated Services Code Point
-
- PBFS
- Packet Based per Flow State
-
- QoS
- Quality of Service
-
- VNF
- Virtual Network Function
-
- VNFC
- Virtual Network Function Component
-
- NFVI
- Network Function Virtualization Infrastructure
-
- ToS
- Type of Service
-
- VTC
- Virtual Traffic Classifier
diff --git a/docs/configguide/yardstick_testcases/index.rst b/docs/configguide/yardstick_testcases/index.rst
deleted file mode 100644
index 55d4ea3e1..000000000
--- a/docs/configguide/yardstick_testcases/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-==================
-Yardstick Overview
-==================
-
-.. toctree::
- :maxdepth: 2
-
- 01-introduction
- 02-methodology
- 04-vtc-overview
- 03-list-of-tcs
- glossary
diff --git a/docs/userguide/01-introduction.rst b/docs/userguide/01-introduction.rst
new file mode 100644
index 000000000..90c112a47
--- /dev/null
+++ b/docs/userguide/01-introduction.rst
@@ -0,0 +1,61 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+============
+Introduction
+============
+
+**Welcome to Yardstick's documentation !**
+
+.. _Pharos: https://wiki.opnfv.org/pharos
+.. _Yardstick: https://wiki.opnfv.org/yardstick
+.. _Presentation: https://wiki.opnfv.org/_media/opnfv_summit_-_yardstick_project.pdf
+
+Yardstick_ is an OPNFV Project.
+
+The project's goal is to verify infrastructure compliance, from the perspective
+of a Virtual Network Function (:term:`VNF`).
+
+The Project's scope is the development of a test framework, *Yardstick*, test
+cases and test stimuli to enable Network Function Virtualization Infrastructure
+(:term:`NFVI`) verification.
+The Project also includes a sample :term:`VNF`, the Virtual Traffic Classifier
+(:term:`VTC`) and its experimental framework, *ApexLake* !
+
+*Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
+the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
+community labs. It is *installer*, *infrastructure* and *application*
+independent.
+
+.. seealso:: Pharos_ for information on OPNFV community labs and this
+ Presentation_ for an overview of *Yardstick*
+
+
+About This Document
+===================
+
+This document consists of the following chapters:
+
+* Chapter :doc:`02-methodology` describes the methodology implemented by the
+ Yardstick Project for :term:`NFVI` verification.
+
+* Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`.
+
+* Chapter :doc:`apexlake_installation` provides instructions to install the
+ experimental framework *ApexLake* and chapter :doc:`apexlake_api` explains
+ how this framework is integrated in *Yardstick*.
+
+* Chapter :doc:`03-installation` provides instructions to install *Yardstick*.
+
+* Chapter :doc:`03-list-of-tcs` includes a list of available Yardstick
+ test cases.
+
+
+Contact Yardstick
+=================
+
+Feedback? `Contact us`_
+
+.. _Contact us: opnfv-users@lists.opnfv.org
diff --git a/docs/configguide/yardstick_testcases/02-methodology.rst b/docs/userguide/02-methodology.rst
index 5097c566b..7fdb5f64f 100644
--- a/docs/configguide/yardstick_testcases/02-methodology.rst
+++ b/docs/userguide/02-methodology.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
===========
Methodology
===========
@@ -6,12 +11,14 @@ Abstract
========
This chapter describes the methodology implemented by the Yardstick project for
-verifying the NFV Infrastructure from the perspective of a VNF.
+verifying the :term:`NFVI` from the perspective of a :term:`VNF`.
ETSI-NFV
========
.. _NFV-TST001: https://docbox.etsi.org/ISG/NFV/Open/Drafts/TST001_-_Pre-deployment_Validation/
+.. _Yardsticktst: https://wiki.opnfv.org/_media/opnfv_summit_-_bridging_opnfv_and_etsi.pdf
+
The document ETSI GS NFV-TST001_, "Pre-deployment Testing; Report on Validation
of NFV Environments and Services", recommends methods for pre-deployment
@@ -20,17 +27,19 @@ testing of the functional components of an NFV environment.
The Yardstick project implements the methodology described in chapter 6, "Pre-
deployment validation of NFV infrastructure".
-The methodology consists in decomposing the typical VNF work-load performance
-metrics into a number of characteristics/performance vectors, which each can be
-represented by distinct test-cases.
+The methodology consists in decomposing the typical :term:`VNF` work-load
+performance metrics into a number of characteristics/performance vectors, which
+each can be represented by distinct test-cases.
The methodology includes five steps:
-* *Step1:* Define Infrastruture - the HW, SW and corresponding configuration
- target for validation; the OPNFV infrastructure, in OPNFV community labs.
+* *Step1:* Define Infrastruture - the Hardware, Software and corresponding
+ configuration target for validation; the OPNFV infrastructure, in OPNFV
+ community labs.
-* *Step2:* Identify VNF type - the application for which the infrastructure is
- to be validated, and its requirements on the underlying infrastructure.
+* *Step2:* Identify :term:`VNF` type - the application for which the
+ infrastructure is to be validated, and its requirements on the underlying
+ infrastructure.
* *Step3:* Select test cases - depending on the workload that represents the
application for which the infrastruture is to be validated, the relevant
@@ -41,6 +50,8 @@ The methodology includes five steps:
* *Step5:* Collect results - using the common API for result collection.
+.. seealso:: Yardsticktst_ for material on alignment ETSI TST001 and Yardstick.
+
Metrics
=======
@@ -157,8 +168,8 @@ options).
| Category| Performance/Speed | Capacity/Scale | Availability/Reliability |
| | | | |
+---------+-------------------+----------------+------------------------------+
-| Compute | TC003 | TC003 | TC013 [1]_ |
-| | TC004 | TC004 | TC015 [1]_ |
+| Compute | TC003 [1]_ | TC003 [1]_ | TC013 [1]_ |
+| | TC004 [1]_ | TC004 [1]_ | TC015 [1]_ |
| | TC014 | TC010 | |
| | TC024 | TC012 | |
| | | | |
diff --git a/docs/userguide/yardstick_framework/03-installation.rst b/docs/userguide/03-installation.rst
index 31f8a922e..47a3ea834 100644
--- a/docs/userguide/yardstick_framework/03-installation.rst
+++ b/docs/userguide/03-installation.rst
@@ -1,14 +1,13 @@
-..
- TODO As things will change, then this document has to be revised before the
- next release. Steps:
- 1. Verify that the instructions below are correct and have not been changed.
- 2. Add everything that is currently missing and should be included in this document.
- 3. Make sure each title has a paragraph or an introductory sentence under it.
- 4. Make sure each sentence is grammatically correct and easily understandable.
- 5. Remove this comment section.
-
-Installation
-==============
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+Yardstick Installation
+======================
+
+Abstract
+--------
Yardstick currently supports installation on Ubuntu 14.04 or by using a Docker
image. Detailed steps about installing Yardstick using both of these options
diff --git a/docs/configguide/yardstick_testcases/03-list-of-tcs.rst b/docs/userguide/03-list-of-tcs.rst
index bb3fbbac5..de48c7bc7 100644
--- a/docs/configguide/yardstick_testcases/03-list-of-tcs.rst
+++ b/docs/userguide/03-list-of-tcs.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
====================
Yardstick Test Cases
====================
diff --git a/docs/configguide/yardstick_testcases/04-vtc-overview.rst b/docs/userguide/04-vtc-overview.rst
index 95159a9bc..82b20cad5 100644
--- a/docs/configguide/yardstick_testcases/04-vtc-overview.rst
+++ b/docs/userguide/04-vtc-overview.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, National Center of Scientific Research "Demokritos" and others.
+
==========================
Virtual Traffic Classifier
==========================
@@ -16,10 +21,11 @@ Additional documentation is available in TNOVAresults_.
Overview
========
-The virtual Traffic Classifier :term:`VNF`, the :term:`VTC`, comprises of a
-:term:`VNFC`. The :term:`VNFC` contains both the Traffic Inspection module, and
-the Traffic forwarding module, needed to run the VNF. The exploitation of
-:term:`DPI` methods for traffic classification is built around two basic
+The virtual Traffic Classifier (:term:`VTC`) :term:`VNF`, comprises of a
+Virtual Network Function Component (:term:`VNFC`). The :term:`VNFC` contains
+both the Traffic Inspection module, and the Traffic forwarding module, needed
+to run the :term:`VNF`. The exploitation of Deep Packet Inspection
+(:term:`DPI`) methods for traffic classification is built around two basic
assumptions:
* third parties unaffiliated with either source or recipient are able to
@@ -32,9 +38,10 @@ The proposed :term:`DPI` based approach will only use an indicative, small
number of the initial packets from each flow in order to identify the content
and not inspect each packet.
-In this respect it follows the :term:`PBFS`. This method uses a table to track
-each session based on the 5-tuples (src address, dest address, src port,dest
-port, transport protocol) that is maintained for each flow.
+In this respect it follows the Packet Based per Flow State (term:`PBFS`). This
+method uses a table to track each session based on the 5-tuples (src address,
+dest address, src port,dest port, transport protocol) that is maintained for
+each flow.
Concepts
========
@@ -46,8 +53,8 @@ identification of network traffic that passes through the :term:`VTC`.
network interface to a pre-defined outgoing network interface.
* *Traffic Rule Application*: The process of packet tagging, based on a
-predefined set of rules. Packet tagging may include e.g. :term:`ToS` field
-modification.
+predefined set of rules. Packet tagging may include e.g. Type of Service
+(:term:`ToS`) field modification.
Architecture
============
@@ -67,8 +74,9 @@ which then applies any required policy updates.
The Traffic Forwarding moudle is responsible for routing and packet forwarding.
It accepts incoming network traffic, consults the flow table for classification
information for each incoming flow and then applies pre-defined policies
-marking e.g. :term:`ToS`/:term:`DSCP` multimedia traffic for :term:`QoS`
-enablement on the forwarded traffic.
+marking e.g. :term:`ToS`/Differentiated Services Code Point (:term:`DSCP`)
+multimedia traffic for Quality of Service (:term:`QoS`) enablement on the
+forwarded traffic.
It is assumed that the traffic is forwarded using the default policy until it
is identified and new policies are enforced.
diff --git a/docs/configguide/yardstick_testcases/Yardstick_task_templates.rst b/docs/userguide/Yardstick_task_templates.rst
index 8185062b2..e8130dd2a 100755
--- a/docs/configguide/yardstick_testcases/Yardstick_task_templates.rst
+++ b/docs/userguide/Yardstick_task_templates.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
Task Template Syntax
====================
diff --git a/docs/userguide/apexlake_framework/apexlake_api.rst b/docs/userguide/apexlake_api.rst
index 2ef3e43f5..35a1dbe3e 100644
--- a/docs/userguide/apexlake_framework/apexlake_api.rst
+++ b/docs/userguide/apexlake_api.rst
@@ -1,8 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
+
=================================
Apexlake API Interface Definition
=================================
-The API interface provided by the framework to enable the execution of test cases is defined as follows.
+Abstract
+--------
+
+The API interface provided by the framework to enable the execution of test
+cases is defined as follows.
init
diff --git a/docs/userguide/apexlake_framework/index.rst b/docs/userguide/apexlake_framework/index.rst
deleted file mode 100644
index 47ebfcdf4..000000000
--- a/docs/userguide/apexlake_framework/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-********************************
-Apexlake Framework Documentation
-********************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- apexlake_installation
- apexlake_api
-
diff --git a/docs/userguide/apexlake_framework/apexlake_installation.rst b/docs/userguide/apexlake_installation.rst
index 2e129bfa2..4870c2e21 100644
--- a/docs/userguide/apexlake_framework/apexlake_installation.rst
+++ b/docs/userguide/apexlake_installation.rst
@@ -1,3 +1,9 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
+
.. _DPDK: http://dpdk.org/doc/nics
.. _DPDK-pktgen: https://github.com/Pktgen/Pktgen-DPDK/
.. _SRIOV: https://wiki.openstack.org/wiki/SR-IOV-Passthrough-For-Networking
@@ -7,35 +13,46 @@
============================
Apexlake Installation Guide
============================
-ApexLake is a framework that provides automatic execution of experiments and related data collection to enable
-a user validate infrastructure from the perspective of a Virtual Network Function (VNF).
-In the context of Yardstick, a virtual Traffic Classifier (vTC) network function is utilized.
+
+Abstract
+--------
+
+ApexLake is a framework that provides automatic execution of experiments and
+related data collection to enable a user validate infrastructure from the
+perspective of a Virtual Network Function (:term:`VNF`).
+
+In the context of Yardstick, a virtual Traffic Classifier (:term:`VTC`) network
+function is utilized.
Framework Hardware Dependencies
===============================
-In order to run the framework there are some hardware related dependencies for ApexLake.
+
+In order to run the framework there are some hardware related dependencies for
+ApexLake.
The framework needs to be installed on the same physical node where DPDK-pktgen_
is installed.
-The installation requires the physical node hosting the packet generator must have 2 NICs
-which are DPDK_ compatible.
-The 2 NICs will be connected to the switch where the OpenStack VM network is managed.
+The installation requires the physical node hosting the packet generator must
+have 2 NICs which are DPDK_ compatible.
-The switch used must support multicast traffic and IGMP snooping.
+The 2 NICs will be connected to the switch where the OpenStack VM
+network is managed.
+
+The switch used must support multicast traffic and :term:`IGMP` snooping.
Further details about the configuration are provided at the following here_.
-The corresponding ports to which the cables are connected need to be configured as VLAN trunks
-using two of the VLAN IDs available for Neutron.
+The corresponding ports to which the cables are connected need to be configured
+as VLAN trunks using two of the VLAN IDs available for Neutron.
Note the VLAN IDs used as they will be required in later configuration steps.
Framework Software Dependencies
===============================
Before starting the framework, a number of dependencies must first be installed.
-The following describes the set of instructions to be executed via the Linux shell in order to install
-and configure the required dependencies.
+The following describes the set of instructions to be executed via the Linux
+shell in order to install and configure the required dependencies.
1. Install Dependencies.
@@ -66,10 +83,11 @@ After entering the Apexlake directory, run the following command.
4. Create Two Networks based on VLANs in Neutron.
-To enable network communications between the packet generator and the compute node,
-two networks must be created via Neutron and mapped to the VLAN IDs
+To enable network communications between the packet generator and the compute
+node, two networks must be created via Neutron and mapped to the VLAN IDs
that were previously used in the configuration of the physical switch.
-The following shows the typical set of commands required to configure Neutron correctly.
+The following shows the typical set of commands required to configure Neutron
+correctly.
::
@@ -100,17 +118,24 @@ The following shows the typical set of commands required to configure Neutron co
The VLAN tags must also be included in the test case Yardstick yaml file
as parameters for the following test cases:
- - TC 006
- - TC 007
- - TC 020
- - TC 021
+
+ * :doc:`opnfv_yardstick_tc006`
+
+ * :doc:`opnfv_yardstick_tc007`
+
+ * :doc:`opnfv_yardstick_tc020`
+
+ * :doc:`opnfv_yardstick_tc021`
Install and Configure DPDK Pktgen
+++++++++++++++++++++++++++++++++
+
Execution of the framework is based on DPDK Pktgen.
-If DPDK Pktgen has not installed, it is necessary to download, install, compile and configure it.
-The user can create a directory and download the dpdk packet generator source code:
+If DPDK Pktgen has not installed, it is necessary to download, install, compile
+and configure it.
+The user can create a directory and download the dpdk packet generator source
+code:
::
@@ -118,17 +143,20 @@ The user can create a directory and download the dpdk packet generator source co
mkdir dpdk_pktgen
git clone https://github.com/pktgen/Pktgen-DPDK.git
-For instructions on the installation and configuration of DPDK and DPDK Pktgen please follow the official
-DPDK Pktgen README file.
-Once the installation is completed, it is necessary to load the DPDK kernel driver, as follow:
+For instructions on the installation and configuration of DPDK and DPDK Pktgen
+please follow the official DPDK Pktgen README file.
+Once the installation is completed, it is necessary to load the DPDK kernel
+driver, as follow:
::
insmod uio
insmod DPDK_DIR/x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
-It is necessary to set the configuration file to support the desired Pktgen configuration.
-A description of the required configuration parameters and supporting examples is provided in the following:
+It is necessary to set the configuration file to support the desired Pktgen
+configuration.
+A description of the required configuration parameters and supporting examples
+is provided in the following:
::
@@ -166,18 +194,21 @@ A description of the required configuration parameters and supporting examples i
To find the parameters related to names of the NICs and the addresses of the PCI buses
-the user may find it useful to run the DPDK tool nic_bind as follows:
+the user may find it useful to run the :term:`DPDK` tool nic_bind as follows:
::
DPDK_DIR/tools/dpdk_nic_bind.py --status
Lists the NICs available on the system, and shows the available drivers and bus addresses for each interface.
-Please make sure to select NICs which are DPDK compatible.
+Please make sure to select NICs which are :term:`DPDK` compatible.
Installation and Configuration of smcroute
++++++++++++++++++++++++++++++++++++++++++
-The user is required to install smcroute which is used by the framework to support multicast communications.
+
+The user is required to install smcroute which is used by the framework to
+support multicast communications.
+
The following is the list of commands required to download and install smroute.
::
@@ -193,7 +224,8 @@ The following is the list of commands required to download and install smroute.
sudo make install
cd ..
-It is also requires the creation a configuration file using the following command:
+It is also requires the creation a configuration file using the following
+command:
SMCROUTE_NIC=(name of the nic)
@@ -211,7 +243,8 @@ Then create the smcroute configuration file /etc/smcroute.conf
echo mgroup from $SMCROUTE_NIC group 224.192.16.1 > /etc/smcroute.conf
-At the end of this procedure it will be necessary to perform the following actions to add the user to the sudoers:
+At the end of this procedure it will be necessary to perform the following
+actions to add the user to the sudoers:
::
@@ -221,7 +254,9 @@ At the end of this procedure it will be necessary to perform the following actio
Experiment using SR-IOV Configuration on the Compute Node
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-To enable SR-IOV interfaces on the physical NIC of the compute node, a compatible NIC is required.
-NIC configuration depends on model and vendor. After proper configuration to support SR-IOV,
-a proper configuration of OpenStack is required.
-For further information, please refer to the _SRIOV configuration guide
+
+To enable :term:`SR-IOV` interfaces on the physical NIC of the compute node, a
+compatible NIC is required.
+NIC configuration depends on model and vendor. After proper configuration to
+support :term:`SR-IOV`, a proper configuration of OpenStack is required.
+For further information, please refer to the SRIOV_ configuration guide
diff --git a/docs/userguide/glossary.rst b/docs/userguide/glossary.rst
new file mode 100644
index 000000000..f8ff41887
--- /dev/null
+++ b/docs/userguide/glossary.rst
@@ -0,0 +1,65 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+========
+Glossary
+========
+
+.. glossary::
+ :sorted:
+
+ API
+ Application Programming Interface
+
+ DPI
+ Deep Packet Inspection
+
+ DPDK
+ Data Plane Development Kit
+
+ DSCP
+ Differentiated Services Code Point
+
+ IGMP
+ Internet Group Management Protocol
+
+ IOPS
+ Input/Output Operations Per Second
+
+ NIC
+ Network Interface Controller
+
+ PBFS
+ Packet Based per Flow State
+
+ QoS
+ Quality of Service
+
+ VLAN
+ Virtual LAN
+
+ VM
+ Virtual Machine
+
+ VNF
+ Virtual Network Function
+
+ VNFC
+ Virtual Network Function Component
+
+ NFVI
+ Network Function Virtualization Infrastructure
+
+ SR-IOV
+ Single Root IO Virtualization
+
+ SUT
+ System Under Test
+
+ ToS
+ Type of Service
+
+ VTC
+ Virtual Traffic Classifier
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
new file mode 100644
index 000000000..3cad237e2
--- /dev/null
+++ b/docs/userguide/index.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+==================
+Yardstick Overview
+==================
+
+.. toctree::
+ :maxdepth: 2
+
+ 01-introduction
+ 02-methodology
+ 04-vtc-overview
+ apexlake_installation
+ apexlake_api
+ 03-installation
+ 03-list-of-tcs
+ glossary
+ references
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc001.rst b/docs/userguide/opnfv_yardstick_tc001.rst
index 810bad489..4cf4b94a4 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc001.rst
+++ b/docs/userguide/opnfv_yardstick_tc001.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC001
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc002.rst b/docs/userguide/opnfv_yardstick_tc002.rst
index 56350f5bb..193fc531f 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc002.rst
+++ b/docs/userguide/opnfv_yardstick_tc002.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC002
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc005.rst b/docs/userguide/opnfv_yardstick_tc005.rst
index 83b6aedd6..a181aa9f7 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc005.rst
+++ b/docs/userguide/opnfv_yardstick_tc005.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
*************************************
Yardstick Test Case Description TC005
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc006.rst b/docs/userguide/opnfv_yardstick_tc006.rst
index b68315078..2ccb417c1 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc006.rst
+++ b/docs/userguide/opnfv_yardstick_tc006.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
*************************************
Yardstick Test Case Description TC006
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc007.rst b/docs/userguide/opnfv_yardstick_tc007.rst
index a7a4776d5..87663f816 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc007.rst
+++ b/docs/userguide/opnfv_yardstick_tc007.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
*************************************
Yardstick Test Case Description TC007
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc008.rst b/docs/userguide/opnfv_yardstick_tc008.rst
index e176e633a..a4ecaf6ae 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc008.rst
+++ b/docs/userguide/opnfv_yardstick_tc008.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC008
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc009.rst b/docs/userguide/opnfv_yardstick_tc009.rst
index e4002a884..d6f445361 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc009.rst
+++ b/docs/userguide/opnfv_yardstick_tc009.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC009
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc010.rst b/docs/userguide/opnfv_yardstick_tc010.rst
index ebb74ea30..ab793de76 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc010.rst
+++ b/docs/userguide/opnfv_yardstick_tc010.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC010
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc011.rst b/docs/userguide/opnfv_yardstick_tc011.rst
index 6760ce067..1c643cd72 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc011.rst
+++ b/docs/userguide/opnfv_yardstick_tc011.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
*************************************
Yardstick Test Case Description TC011
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc012.rst b/docs/userguide/opnfv_yardstick_tc012.rst
index e7889c14e..ffce06eb9 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc012.rst
+++ b/docs/userguide/opnfv_yardstick_tc012.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC012
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc014.rst b/docs/userguide/opnfv_yardstick_tc014.rst
index 68d36ecd2..27d390ac6 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc014.rst
+++ b/docs/userguide/opnfv_yardstick_tc014.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
*************************************
Yardstick Test Case Description TC014
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc019.rst b/docs/userguide/opnfv_yardstick_tc019.rst
index 482260b48..1af502253 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc019.rst
+++ b/docs/userguide/opnfv_yardstick_tc019.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
*************************************
Yardstick Test Case Description TC019
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc020.rst b/docs/userguide/opnfv_yardstick_tc020.rst
index 9a5130f71..f2f1d408b 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc020.rst
+++ b/docs/userguide/opnfv_yardstick_tc020.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
*************************************
Yardstick Test Case Description TC020
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc021.rst b/docs/userguide/opnfv_yardstick_tc021.rst
index a493ddfc0..c7adc870a 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc021.rst
+++ b/docs/userguide/opnfv_yardstick_tc021.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and others.
+
*************************************
Yardstick Test Case Description TC021
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc024.rst b/docs/userguide/opnfv_yardstick_tc024.rst
index 1e8d4e6f3..ffdacb106 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc024.rst
+++ b/docs/userguide/opnfv_yardstick_tc024.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC024
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc025.rst b/docs/userguide/opnfv_yardstick_tc025.rst
index 0bc0b78ab..0e2e9a5f8 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc025.rst
+++ b/docs/userguide/opnfv_yardstick_tc025.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
*************************************
Yardstick Test Case Description TC025
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc027.rst b/docs/userguide/opnfv_yardstick_tc027.rst
index 56c8227df..6215e6d2a 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc027.rst
+++ b/docs/userguide/opnfv_yardstick_tc027.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
*************************************
Yardstick Test Case Description TC027
*************************************
@@ -8,7 +13,7 @@ Yardstick Test Case Description TC027
|IPv6 connectivity between nodes on the tenant network |
| |
+--------------+--------------------------------------------------------------+
-|test case id | OPNFV_YARDSTICK_TC002_IPv6 connectivity |
+|test case id | OPNFV_YARDSTICK_TC027_IPv6 connectivity |
| | |
+--------------+--------------------------------------------------------------+
|metric | RTT, Round Trip Time |
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc028.rst b/docs/userguide/opnfv_yardstick_tc028.rst
index 8ac5f49f9..24206f33f 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc028.rst
+++ b/docs/userguide/opnfv_yardstick_tc028.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co., Ltd and others.
+
*************************************
Yardstick Test Case Description TC028
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc037.rst b/docs/userguide/opnfv_yardstick_tc037.rst
index 5c91f6bf1..3ed1fa529 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc037.rst
+++ b/docs/userguide/opnfv_yardstick_tc037.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC037
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc038.rst b/docs/userguide/opnfv_yardstick_tc038.rst
index 93c2cf3d8..692c76819 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc038.rst
+++ b/docs/userguide/opnfv_yardstick_tc038.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
*************************************
Yardstick Test Case Description TC038
*************************************
diff --git a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc040.rst b/docs/userguide/opnfv_yardstick_tc040.rst
index 044ccf193..d62fbf787 100644
--- a/docs/configguide/yardstick_testcases/opnfv_yardstick_tc040.rst
+++ b/docs/userguide/opnfv_yardstick_tc040.rst
@@ -1,3 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
+
*************************************
Yardstick Test Case Description TC040
*************************************
diff --git a/docs/userguide/references.rst b/docs/userguide/references.rst
new file mode 100644
index 000000000..551926135
--- /dev/null
+++ b/docs/userguide/references.rst
@@ -0,0 +1,50 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+==========
+References
+==========
+
+
+OPNFV
+=====
+
+* Parser wiki: https://wiki.opnfv.org/parser
+* Pharos wiki: https://wiki.opnfv.org/pharos
+* VTC: https://wiki.opnfv.org/vtc
+* Yardstick CI: https://build.opnfv.org/ci/view/yardstick/
+* Yardstick and ETSI TST001 presentation: https://wiki.opnfv.org/_media/opnfv_summit_-_bridging_opnfv_and_etsi.pdf
+* Yardstick Project presentation: https://wiki.opnfv.org/_media/opnfv_summit_-_yardstick_project.pdf
+* Yardstick wiki: https://wiki.opnfv.org/yardstick
+
+References used in Test Cases
+=============================
+
+* cirros-image: https://download.cirros-cloud.net
+* cyclictest: https://rt.wiki.kernel.org/index.php/Cyclictest
+* DPDKpktgen: https://github.com/Pktgen/Pktgen-DPDK/
+* DPDK supported NICs: http://dpdk.org/doc/nics
+* fio: http://www.bluestop.org/fio/HOWTO.txt
+* iperf3: https://iperf.fr/
+* Lmbench man-pages: http://manpages.ubuntu.com/manpages/trusty/lat_mem_rd.8.html
+* Memory bandwidth man-pages: http://manpages.ubuntu.com/manpages/trusty/bw_mem.8.html
+* unixbench: https://github.com/kdlucas/byte-unixbench/blob/master/UnixBench
+* mpstat man-pages: http://manpages.ubuntu.com/manpages/trusty/man1/mpstat.1.html
+* pktgen: https://www.kernel.org/doc/Documentation/networking/pktgen.txt
+* SR-IOV: https://wiki.openstack.org/wiki/SR-IOV-Passthrough-For-Networking
+
+Research
+========
+
+* NCSRD: http://www.demokritos.gr/?lang=en
+* T-NOVA: http://www.t-nova.eu/
+* T-NOVA Results: http://www.t-nova.eu/results/
+
+Standards
+=========
+
+* ETSI NFV: http://www.etsi.org/technologies-clusters/technologies/nfv
+* ETSI GS-NFV TST 001: https://docbox.etsi.org/ISG/NFV/Open/Drafts/TST001_-_Pre-deployment_Validation/
+* RFC2544: https://www.ietf.org/rfc/rfc2544.txt
diff --git a/docs/configguide/yardstick_testcases/testcase_description_v2_template.rst b/docs/userguide/testcase_description_v2_template.rst
index 1b8754b05..91c2a7e33 100644
--- a/docs/configguide/yardstick_testcases/testcase_description_v2_template.rst
+++ b/docs/userguide/testcase_description_v2_template.rst
@@ -1,7 +1,7 @@
-.. Template to be used for test case descriptions in Yardstick Project.
- Write one .rst per test case.
- Upload the .rst for the test case in /docs/source/yardstick directory.
- Review in Gerrit.
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
*************************************
Yardstick Test Case Description TCXXX
diff --git a/docs/userguide/yardstick_framework/index.rst b/docs/userguide/yardstick_framework/index.rst
deleted file mode 100644
index f982c30ff..000000000
--- a/docs/userguide/yardstick_framework/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-=================================
-Yardstick Framework Documentation
-=================================
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- 03-installation