aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorStepan Andrushko <stepanx.andrushko@intel.com>2019-04-25 13:03:18 +0300
committerStepan Andrushko <stepanx.andrushko@intel.com>2019-04-25 13:16:35 +0300
commitd7d2170d987a42fd16029c716a1b97dcf4104367 (patch)
tree6675835ee3c01519a8414bd635ceb2560b97f3cd /docs
parent986468ef458f46c23247ba3880f2b9b84ec27799 (diff)
[docs] Update NSB documentation, fix warnings
Updated NSB documentation, fixed some warnings. JIRA: YARDSTICK-1612 Change-Id: I8fdb92734b63bf3b6ad23160ebfb4c17a8e6dad1 Signed-off-by: Stepan Andrushko <stepanx.andrushko@intel.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/testing/user/userguide/04-installation.rst1
-rw-r--r--docs/testing/user/userguide/12-nsb-overview.rst13
-rw-r--r--docs/testing/user/userguide/13-nsb-installation.rst94
-rw-r--r--docs/testing/user/userguide/14-nsb-operation.rst25
-rw-r--r--docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst6
5 files changed, 72 insertions, 67 deletions
diff --git a/docs/testing/user/userguide/04-installation.rst b/docs/testing/user/userguide/04-installation.rst
index 213821798..6fe42232d 100644
--- a/docs/testing/user/userguide/04-installation.rst
+++ b/docs/testing/user/userguide/04-installation.rst
@@ -72,6 +72,7 @@ Several prerequisites are needed for Yardstick:
the end of this document. That section details some tips/tricks which *may*
be of help in a proxified environment.
+.. _Install Yardstick using Docker:
Install Yardstick using Docker (first option) (**recommended**)
---------------------------------------------------------------
diff --git a/docs/testing/user/userguide/12-nsb-overview.rst b/docs/testing/user/userguide/12-nsb-overview.rst
index 012ea6c3d..45b087a47 100644
--- a/docs/testing/user/userguide/12-nsb-overview.rst
+++ b/docs/testing/user/userguide/12-nsb-overview.rst
@@ -1,7 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International
.. License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, 2016-2017 Intel Corporation.
+.. (c) OPNFV, 2016-2019 Intel Corporation.
.. Convention for heading levels in Yardstick documentation:
@@ -55,8 +55,8 @@ traffic according to user defined profiles.
NSB extension includes:
* Generic data models of Network Services, based on ETSI spec
- `ETSI GS NFV-TST 001`_
-* Standalone :term:`context` for VNF testing SRIOV, OVS, OVS-DPDK, etc
+ `ETSI GS NFV-TST001`_
+* Standalone :term:`context` for VNF testing SRIOV, OVS-DPDK, etc
* Generic VNF configuration models and metrics implemented with Python
classes
* Traffic generator features and traffic profiles
@@ -175,8 +175,8 @@ Supported testcases scenarios:
* Correlated UDP traffic using TREX traffic generator and replay VNF.
- * using different IMIX configuration like pure voice, pure video traffic etc
- * using different number IP flows e.g. 1, 1K, 16K, 64K, 256K, 1M flows
+ * Using different IMIX configuration like pure voice, pure video traffic etc
+ * Using different number IP flows e.g. 1, 1K, 16K, 64K, 256K, 1M flows
* Using different number of rules configured e.g. 1, 1K, 10K rules
For UDP correlated traffic following Key Performance Indicators are collected
@@ -194,6 +194,7 @@ There is already some reporting in NSB available, but NSB collects all KPIs for
analytics to process.
Below is an example list of basic KPIs:
+
* Throughput
* Latency
* Packet delay variation
@@ -214,7 +215,7 @@ the following collectd plug-ins are enabled for NSB testcases:
* RAM
* CPU usage
* IntelĀ® PMU
-* Intel(r) RDT
+* IntelĀ® RDT
Graphical Overview
------------------
diff --git a/docs/testing/user/userguide/13-nsb-installation.rst b/docs/testing/user/userguide/13-nsb-installation.rst
index 3a06be648..74f76c9c9 100644
--- a/docs/testing/user/userguide/13-nsb-installation.rst
+++ b/docs/testing/user/userguide/13-nsb-installation.rst
@@ -108,17 +108,19 @@ The ``nsb_setup.sh`` allows to:
Firstly, configure the network proxy, either using the environment variables or
setting the global environment file.
-Set environment::
+Set environment in the file::
http_proxy='http://proxy.company.com:port'
https_proxy='http://proxy.company.com:port'
+Set environment variables:
+
.. code-block:: console
export http_proxy='http://proxy.company.com:port'
export https_proxy='http://proxy.company.com:port'
-Download the source code and check out the latest stable branch
+Download the source code and check out the latest stable branch:
.. code-block:: console
@@ -127,7 +129,9 @@ Download the source code and check out the latest stable branch
# Switch to latest stable branch
git checkout stable/gambia
-Modify the Yardstick installation inventory used by Ansible::
+Modify the Yardstick installation inventory used by Ansible:
+
+.. code-block:: ini
cat ./ansible/install-inventory.ini
[jumphost]
@@ -161,7 +165,7 @@ Modify the Yardstick installation inventory used by Ansible::
.. warning::
Before running ``nsb_setup.sh`` make sure python is installed on servers
- added to ``yardstick-standalone`` or ``yardstick-baremetal`` groups.
+ added to ``yardstick-standalone`` and ``yardstick-baremetal`` groups.
.. note::
@@ -239,9 +243,8 @@ execute::
stty size rows 58 cols 234
It will also automatically download all the packages needed for NSB Testing
-setup. Refer chapter :doc:`04-installation` for more on Docker.
-
-**Install Yardstick using Docker (recommended)**
+setup. Refer chapter :doc:`04-installation` for more on Docker:
+:ref:`Install Yardstick using Docker`
Bare Metal context example
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -329,7 +332,9 @@ container)::
vi /etc/yardstick/yardstick.conf
Add ``trex_path``, ``trex_client_lib`` and ``bin_path`` to the ``nsb``
-section::
+section:
+
+.. code-block:: ini
[DEFAULT]
debug = True
@@ -360,16 +365,17 @@ Connect to the Yardstick container::
docker exec -it yardstick /bin/bash
If you're running ``heat`` testcases and ``nsb_setup.sh`` was not used::
+
source /etc/yardstick/openstack.creds
-In addition to the above, you need to se the ``EXTERNAL_NETWORK`` for
+In addition to the above, you need to set the ``EXTERNAL_NETWORK`` for
OpenStack::
export EXTERNAL_NETWORK="<openstack public network>"
Finally, you should be able to run the testcase::
- yardstick --debug task start ./yardstick/samples/vnf_samples/nsut/<vnf>/<test case>
+ yardstick --debug task start yardstick/samples/vnf_samples/nsut/<vnf>/<test case>
Network Service Benchmarking - Bare-Metal
-----------------------------------------
@@ -410,7 +416,7 @@ Bare-Metal Config pod.yaml
Before executing Yardstick test cases, make sure that ``pod.yaml`` reflects the
topology and update all the required fields.::
- cp ./etc/yardstick/nodes/pod.yaml.nsb.sample /etc/yardstick/nodes/pod.yaml
+ cp <yardstick>/etc/yardstick/nodes/pod.yaml.nsb.sample /etc/yardstick/nodes/pod.yaml
.. code-block:: YAML
@@ -435,7 +441,7 @@ topology and update all the required fields.::
dpdk_port_num: 1
local_ip: "152.16.40.20"
netmask: "255.255.255.0"
- local_mac: "00:00.00:00:00:02"
+ local_mac: "00:00:00:00:00:02"
-
name: vnf
@@ -490,7 +496,7 @@ SR-IOV Pre-requisites
+++++++++++++++++++++
On Host, where VM is created:
- a) Create and configure a bridge named ``br-int`` for VM to connect to
+ 1. Create and configure a bridge named ``br-int`` for VM to connect to
external network. Currently this can be done using VXLAN tunnel.
Execute the following on host, where VM is created::
@@ -519,7 +525,7 @@ On Host, where VM is created:
.. note:: Host and jump host are different baremetal servers.
- b) Modify test case management CIDR.
+ 2. Modify test case management CIDR.
IP addresses IP#1, IP#2 and CIDR must be in the same network.
.. code-block:: YAML
@@ -530,7 +536,7 @@ On Host, where VM is created:
mgmt:
cidr: '1.1.1.7/24'
- c) Build guest image for VNF to run.
+ 3. Build guest image for VNF to run.
Most of the sample test cases in Yardstick are using a guest image called
``yardstick-nsb-image`` which deviates from an Ubuntu Cloud Server image
Yardstick has a tool for building this custom image with SampleVNF.
@@ -550,8 +556,6 @@ On Host, where VM is created:
For instructions on generating a cloud image using Ansible, refer to
:doc:`04-installation`.
- for more details refer to chapter :doc:`04-installation`
-
.. note:: VM should be build with static IP and be accessible from the
Yardstick host.
@@ -618,8 +622,8 @@ topology and update all the required fields.
.. code-block:: console
- cp ./etc/yardstick/nodes/standalone/trex_bm.yaml.sample /etc/yardstick/nodes/standalone/pod_trex.yaml
- cp ./etc/yardstick/nodes/standalone/host_sriov.yaml /etc/yardstick/nodes/standalone/host_sriov.yaml
+ cp <yardstick>/etc/yardstick/nodes/standalone/trex_bm.yaml.sample /etc/yardstick/nodes/standalone/pod_trex.yaml
+ cp <yardstick>/etc/yardstick/nodes/standalone/host_sriov.yaml /etc/yardstick/nodes/standalone/host_sriov.yaml
.. note:: Update all the required fields like ip, user, password, pcis, etc...
@@ -650,7 +654,7 @@ SR-IOV Config pod_trex.yaml
dpdk_port_num: 1
local_ip: "152.16.40.20"
netmask: "255.255.255.0"
- local_mac: "00:00.00:00:00:02"
+ local_mac: "00:00:00:00:00:02"
SR-IOV Config host_sriov.yaml
+++++++++++++++++++++++++++++
@@ -666,7 +670,7 @@ SR-IOV Config host_sriov.yaml
password: ""
SR-IOV testcase update:
-``./samples/vnf_samples/nsut/vfw/tc_sriov_rfc2544_ipv4_1rule_1flow_64B_trex.yaml``
+``<yardstick>/samples/vnf_samples/nsut/vfw/tc_sriov_rfc2544_ipv4_1rule_1flow_64B_trex.yaml``
Update contexts section
'''''''''''''''''''''''
@@ -719,7 +723,7 @@ OVS-DPDK Pre-requisites
+++++++++++++++++++++++
On Host, where VM is created:
- a) Create and configure a bridge named ``br-int`` for VM to connect to
+ 1. Create and configure a bridge named ``br-int`` for VM to connect to
external network. Currently this can be done using VXLAN tunnel.
Execute the following on host, where VM is created:
@@ -750,7 +754,7 @@ On Host, where VM is created:
.. note:: Host and jump host are different baremetal servers.
- b) Modify test case management CIDR.
+ 2. Modify test case management CIDR.
IP addresses IP#1, IP#2 and CIDR must be in the same network.
.. code-block:: YAML
@@ -761,7 +765,7 @@ On Host, where VM is created:
mgmt:
cidr: '1.1.1.7/24'
- c) Build guest image for VNF to run.
+ 3. Build guest image for VNF to run.
Most of the sample test cases in Yardstick are using a guest image called
``yardstick-nsb-image`` which deviates from an Ubuntu Cloud Server image
Yardstick has a tool for building this custom image with SampleVNF.
@@ -784,11 +788,11 @@ On Host, where VM is created:
.. note:: VM should be build with static IP and should be accessible from
yardstick host.
-3. OVS & DPDK version.
- * OVS 2.7 and DPDK 16.11.1 above version is supported
+4. OVS & DPDK version:
-4. Setup `OVS-DPDK`_ on host.
+ * OVS 2.7 and DPDK 16.11.1 above version is supported
+Refer setup instructions at `OVS-DPDK`_ on host.
OVS-DPDK Config pod.yaml describing Topology
++++++++++++++++++++++++++++++++++++++++++++
@@ -856,8 +860,8 @@ OVS-DPDK 3-Node setup - Correlated Traffic
Before executing Yardstick test cases, make sure that the ``pod.yaml`` reflects
the topology and update all the required fields::
- cp ./etc/yardstick/nodes/standalone/trex_bm.yaml.sample /etc/yardstick/nodes/standalone/pod_trex.yaml
- cp ./etc/yardstick/nodes/standalone/host_ovs.yaml /etc/yardstick/nodes/standalone/host_ovs.yaml
+ cp <yardstick>/etc/yardstick/nodes/standalone/trex_bm.yaml.sample /etc/yardstick/nodes/standalone/pod_trex.yaml
+ cp <yardstick>/etc/yardstick/nodes/standalone/host_ovs.yaml /etc/yardstick/nodes/standalone/host_ovs.yaml
.. note:: Update all the required fields like ip, user, password, pcis, etc...
@@ -887,7 +891,7 @@ OVS-DPDK Config pod_trex.yaml
dpdk_port_num: 1
local_ip: "152.16.40.20"
netmask: "255.255.255.0"
- local_mac: "00:00.00:00:00:02"
+ local_mac: "00:00:00:00:00:02"
OVS-DPDK Config host_ovs.yaml
+++++++++++++++++++++++++++++
@@ -903,7 +907,7 @@ OVS-DPDK Config host_ovs.yaml
password: ""
ovs_dpdk testcase update:
-``./samples/vnf_samples/nsut/vfw/tc_ovs_rfc2544_ipv4_1rule_1flow_64B_trex.yaml``
+``<yardstick>/samples/vnf_samples/nsut/vfw/tc_ovs_rfc2544_ipv4_1rule_1flow_64B_trex.yaml``
Update contexts section
'''''''''''''''''''''''
@@ -1237,7 +1241,7 @@ DevStack installation
If you want to try out NSB, but don't have OpenStack set-up, you can use
`Devstack`_ to install OpenStack on a host. Please note, that the
``stable/pike`` branch of devstack repo should be used during the installation.
-The required ``local.conf`` configuration file are described below.
+The required ``local.conf`` configuration file is described below.
DevStack configuration file:
@@ -1248,7 +1252,7 @@ DevStack configuration file:
commands to get device and vendor id of the virtual function (VF).
.. literalinclude:: code/single-devstack-local.conf
- :language: console
+ :language: ini
Start the devstack installation on a host.
@@ -1265,7 +1269,7 @@ Run the Sample VNF test case
There is an example of Sample VNF test case ready to be executed in an
OpenStack environment with SR-IOV support: ``samples/vnf_samples/nsut/vfw/
-tc_heat_sriov_external_rfc2544_ipv4_1rule_1flow_64B_trex.yaml``.
+tc_heat_sriov_external_rfc2544_ipv4_1rule_1flow_trex.yaml``.
Install Yardstick using `Install Yardstick (NSB Testing)`_ steps for OpenStack
context.
@@ -1278,7 +1282,7 @@ container:
command to get the PF PCI address for ``vpci`` field.
.. literalinclude:: code/single-yardstick-pod.conf
- :language: console
+ :language: ini
Run the Sample vFW RFC2544 SR-IOV TC (``samples/vnf_samples/nsut/vfw/
tc_heat_sriov_external_rfc2544_ipv4_1rule_1flow_64B_trex.yaml``) in the heat
@@ -1338,12 +1342,12 @@ devstack repo should be used during the installation.
DevStack configuration file for controller host:
.. literalinclude:: code/multi-devstack-controller-local.conf
- :language: console
+ :language: ini
DevStack configuration file for compute host:
.. literalinclude:: code/multi-devstack-compute-local.conf
- :language: console
+ :language: ini
Start the devstack installation on the controller and compute hosts.
@@ -1385,13 +1389,13 @@ IxLoad
.. code-block:: console
- cp ./etc/yardstick/nodes/pod.yaml.nsb.sample.ixia \
- /etc/yardstick/nodes/pod_ixia.yaml
+ cp <repo>/etc/yardstick/nodes/pod.yaml.nsb.sample.ixia \
+ etc/yardstick/nodes/pod_ixia.yaml
Config ``pod_ixia.yaml``
.. literalinclude:: code/pod_ixia.yaml
- :language: console
+ :language: yaml
for sriov/ovs_dpdk pod files, please refer to `Standalone Virtualization`_
for ovs-dpdk/sriov configuration
@@ -1409,7 +1413,7 @@ IxLoad
4. Create a folder ``Results`` in c:\ and share the folder on the network.
5. Execute testcase in samplevnf folder e.g.
- ``./samples/vnf_samples/nsut/vfw/tc_baremetal_http_ixload_1b_Requests-65000_Concurrency.yaml``
+ ``<repo>/samples/vnf_samples/nsut/vfw/tc_baremetal_http_ixload_1b_Requests-65000_Concurrency.yaml``
IxNetwork
^^^^^^^^^
@@ -1421,13 +1425,13 @@ installed as part of the requirements of the project.
.. code-block:: console
- cp ./etc/yardstick/nodes/pod.yaml.nsb.sample.ixia \
- /etc/yardstick/nodes/pod_ixia.yaml
+ cp <repo>/etc/yardstick/nodes/pod.yaml.nsb.sample.ixia \
+ etc/yardstick/nodes/pod_ixia.yaml
Configure ``pod_ixia.yaml``
.. literalinclude:: code/pod_ixia.yaml
- :language: console
+ :language: yaml
for sriov/ovs_dpdk pod files, please refer to above
`Standalone Virtualization`_ for ovs-dpdk/sriov configuration
@@ -1442,7 +1446,7 @@ installed as part of the requirements of the project.
(or ``IxNetworkApiServer``)
3. Execute testcase in samplevnf folder e.g.
- ``./samples/vnf_samples/nsut/vfw/tc_baremetal_rfc2544_ipv4_1rule_1flow_64B_ixia.yaml``
+ ``<repo>/samples/vnf_samples/nsut/vfw/tc_baremetal_rfc2544_ipv4_1rule_1flow_64B_ixia.yaml``
Spirent Landslide
-----------------
diff --git a/docs/testing/user/userguide/14-nsb-operation.rst b/docs/testing/user/userguide/14-nsb-operation.rst
index 8d9a1108a..1f9e4d4c6 100644
--- a/docs/testing/user/userguide/14-nsb-operation.rst
+++ b/docs/testing/user/userguide/14-nsb-operation.rst
@@ -1,7 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International
.. License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) OPNFV, 2016-2018 Intel Corporation.
+.. (c) OPNFV, 2016-2019 Intel Corporation.
..
Convention for heading levels in Yardstick documentation:
@@ -265,8 +265,8 @@ to the VNF.
An example scale-up Heat testcase is:
-.. literalinclude:: /../samples/vnf_samples/nsut/vfw/tc_heat_rfc2544_ipv4_1rule_1flow_64B_trex_scale-up.yaml
- :language: yaml
+.. literalinclude:: /../samples/vnf_samples/nsut/vfw/tc_heat_rfc2544_ipv4_1rule_1flow_trex_scale-up.yaml
+ :language: yaml+jinja
This testcase template requires specifying the number of VCPUs, Memory and Ports.
We set the VCPUs and memory using the ``--task-args`` options
@@ -281,7 +281,7 @@ In order to support ports scale-up, traffic and topology templates need to be us
A example topology template is:
.. literalinclude:: /../samples/vnf_samples/nsut/vfw/vfw-tg-topology-scale-up.yaml
- :language: yaml
+ :language: yaml+jinja
This template has ``vports`` as an argument. To pass this argument it needs to
be configured in ``extra_args`` scenario definition. Please note that more
@@ -303,7 +303,7 @@ For example:
A example traffic profile template is:
.. literalinclude:: /../samples/vnf_samples/traffic_profiles/ipv4_throughput-scale-up.yaml
- :language: yaml
+ :language: yaml+jinja
There is an option to provide predefined config for SampleVNFs. Path to config
file may by specified in ``vnf_config`` scenario section.
@@ -319,11 +319,10 @@ Baremetal
^^^^^^^^^
1. Follow above traffic generator section to setup.
2. Edit num of threads in
- ``<repo>/samples/vnf_samples/nsut/vfw/tc_baremetal_rfc2544_ipv4_1rule_1flow_64B_trex_scale_up.yaml``
+ ``<repo>/samples/vnf_samples/nsut/vfw/tc_baremetal_rfc2544_ipv4_trex_scale_up.yaml``
e.g, 6 Threads for given VNF
-.. code-block:: yaml
-
+.. code-block:: yaml+jinja
schema: yardstick:task:0.1
scenarios:
@@ -382,7 +381,7 @@ Scale-out not supported on Baremetal.
.. code-block:: console
cd <repo>/ansible
- trex: standalone_ovs_scale_out_trex_test.yaml or standalone_sriov_scale_out_trex_test.yaml
+ trex: standalone_ovs_scale_out_test.yaml or standalone_sriov_scale_out_test.yaml
ixia: standalone_ovs_scale_out_ixia_test.yaml or standalone_sriov_scale_out_ixia_test.yaml
ixia_correlated: standalone_ovs_scale_out_ixia_correlated_test.yaml or standalone_sriov_scale_out_ixia_correlated_test.yaml
@@ -503,8 +502,8 @@ Sample test case file
4. Modify ``networks/phy_port`` accordingly to the baremetal setup.
5. Run test from:
-.. literalinclude:: /../samples/vnf_samples/nsut/acl/tc_ovs_rfc2544_ipv4_1rule_1flow_64B_trex.yaml
- :language: yaml
+.. literalinclude:: /../samples/vnf_samples/nsut/acl/tc_ovs_rfc2544_ipv4_1rule_1flow_trex.yaml
+ :language: yaml+jinja
Preparing test run of vEPC test case
------------------------------------
@@ -617,7 +616,7 @@ The vPE (Provider Edge Router) is a :term: `VNF` approximation
serving as an Edge Router. The vPE is approximated using the
``ip_pipeline`` dpdk application.
- .. image:: images/vPE_Diagram.png
+ .. image:: /../docs/testing/developer/devguide/images/vPE_Diagram.png
:width: 800px
:alt: NSB vPE Diagram
@@ -642,7 +641,7 @@ A testcase can be started with the following command as an example:
yardstick task start /yardstick/samples/vnf_samples/nsut/vpe/tc_baremetal_rfc2544_ipv4_1flow_64B_ixia.yaml
Preparing test run of vIPSEC test case
-------------------------------------
+--------------------------------------
Location of vIPSEC test cases: ``samples/vnf_samples/nsut/ipsec/``.
diff --git a/docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst b/docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst
index 6827b0525..3beb5303f 100644
--- a/docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst
+++ b/docs/testing/user/userguide/nsb/tc_prox_context_vpe_port.rst
@@ -3,9 +3,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, 2017 Intel Corporation.
-**********************************************
-Yardstick Test Case Description: NSB PROXi VPE
-**********************************************
+*********************************************
+Yardstick Test Case Description: NSB PROX VPE
+*********************************************
+-----------------------------------------------------------------------------+
|NSB PROX test for NFVI characterization |