diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/testing/user/userguide/01-introduction.rst | 29 | ||||
| -rwxr-xr-x | docs/testing/user/userguide/03-architecture.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/userguide/04-installation.rst (renamed from docs/testing/user/userguide/09-installation.rst) | 205 | ||||
| -rw-r--r-- | docs/testing/user/userguide/05-yardstick_plugin.rst (renamed from docs/testing/user/userguide/10-yardstick_plugin.rst) | 7 | ||||
| -rw-r--r-- | docs/testing/user/userguide/06-result-store-InfluxDB.rst (renamed from docs/testing/user/userguide/11-result-store-InfluxDB.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/user/userguide/07-grafana.rst (renamed from docs/testing/user/userguide/12-grafana.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/user/userguide/08-vtc-overview.rst (renamed from docs/testing/user/userguide/04-vtc-overview.rst) | 7 | ||||
| -rw-r--r-- | docs/testing/user/userguide/09-apexlake_installation.rst (renamed from docs/testing/user/userguide/05-apexlake_installation.rst) | 2 | ||||
| -rw-r--r-- | docs/testing/user/userguide/10-apexlake_api.rst (renamed from docs/testing/user/userguide/06-apexlake_api.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/user/userguide/11-nsb-overview.rst (renamed from docs/testing/user/userguide/07-nsb-overview.rst) | 106 | ||||
| -rw-r--r-- | docs/testing/user/userguide/12-nsb_installation.rst (renamed from docs/testing/user/userguide/08-nsb_installation.rst) | 61 | ||||
| -rw-r--r-- | docs/testing/user/userguide/images/Yardstick_framework_architecture_in_D.png | bin | 0 -> 74121 bytes | |||
| -rw-r--r-- | docs/testing/user/userguide/index.rst | 18 | ||||
| -rw-r--r-- | docs/testing/user/userguide/opnfv_yardstick_tc076.rst | 63 |
14 files changed, 353 insertions, 151 deletions
diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst index 0e0eea002..2aa870c2a 100755 --- a/docs/testing/user/userguide/01-introduction.rst +++ b/docs/testing/user/userguide/01-introduction.rst @@ -37,35 +37,38 @@ About This Document This document consists of the following chapters: +* Chapter :doc:`01-introduction` provides a brief introduction to yardstick + project's goal and scope and gives the structure of this document. + * Chapter :doc:`02-methodology` describes the methodology implemented by the Yardstick Project for :term:`NFVI` verification. * Chapter :doc:`03-architecture` provides information on the software architecture of yardstick. -* Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`. +* Chapter :doc:`04-installation` provides instructions to install *Yardstick*. + +* Chapter :doc:`05-yardstick_plugin` provides information on how to integrate + other OPNFV testing projects into *Yardstick*. + +* Chapter :doc:`06-result-store-InfluxDB` provides inforamtion on how to run + plug-in test cases and store test results into community's InfluxDB. + +* Chapter :doc:`07-vtc-overview` provides information on the :term:`VTC`. -* Chapter :doc:`05-apexlake_installation` provides instructions to install the +* Chapter :doc:`08-apexlake_installation` provides instructions to install the experimental framework *ApexLake* -* Chapter :doc:`06-apexlake_api` explains how this framework is integrated in +* Chapter :doc:`09-apexlake_api` explains how this framework is integrated in *Yardstick*. -* Chapter :doc:`07-nsb-overview` describes the methodology implemented by the +* Chapter :doc:`10-nsb-overview` describes the methodology implemented by the yardstick - Network service benchmarking to test real world usecase for a given VNF -* Chapter :doc:`08-nsb_installation` provides instructions to install +* Chapter :doc:`11-nsb_installation` provides instructions to install *Yardstick - Network service benchmarking testing*. -* Chapter :doc:`09-installation` provides instructions to install *Yardstick*. - -* Chapter :doc:`10-yardstick_plugin` provides information on how to integrate - other OPNFV testing projects into *Yardstick*. - -* Chapter :doc:`11-result-store-InfluxDB` provides inforamtion on how to run - plug-in test cases and store test results into community's InfluxDB. - * Chapter :doc:`12-list-of-tcs` includes a list of available Yardstick test cases. diff --git a/docs/testing/user/userguide/03-architecture.rst b/docs/testing/user/userguide/03-architecture.rst index 03bf00f58..95fe050e8 100755 --- a/docs/testing/user/userguide/03-architecture.rst +++ b/docs/testing/user/userguide/03-architecture.rst @@ -187,9 +187,9 @@ run test measurement scripts through the ssh tunnel. After all TestScenaio is finished, TaskCommands will undeploy the heat stack. Then the whole test is finished. -.. image:: images/Logical_view.png +.. image:: images/Yardstick_framework_architecture_in_D.png :width: 800px - :alt: Yardstick Logical View + :alt: Yardstick framework architecture in Danube Process View (Test execution flow) ================================== @@ -236,7 +236,7 @@ Yardstick Directory structure **yardstick/** - Yardstick main directory. -*ci/* - Used for continuous integration of Yardstick at different PODs and +*/tests/ci/* - Used for continuous integration of Yardstick at different PODs and with support for different installers. *docs/* - All documentation is stored here, such as configuration guides, diff --git a/docs/testing/user/userguide/09-installation.rst b/docs/testing/user/userguide/04-installation.rst index 9c2082a27..c1db21220 100644 --- a/docs/testing/user/userguide/09-installation.rst +++ b/docs/testing/user/userguide/04-installation.rst @@ -6,11 +6,12 @@ Yardstick Installation ====================== + Abstract -------- -Yardstick supports installation on Ubuntu 14.04 or via a Docker image. The -installation procedure on Ubuntu 14.04 or via the docker image are detailed in +Yardstick supports installation by Docker or directly in Ubuntu. The +installation procedure for Docker and direct installation are detailed in the section below. To use Yardstick you should have access to an OpenStack environment, with at @@ -57,47 +58,18 @@ the end of this document. The section details some tips/tricks which *may* be of help in a proxified environment. -Installing Yardstick on Ubuntu 14.04 ------------------------------------- - -.. _install-framework: - -You can install Yardstick framework directly on Ubuntu 14.04 or in an Ubuntu -14.04 Docker image. No matter which way you choose to install Yardstick -framework, the following installation steps are identical. - -If you choose to use the Ubuntu 14.04 Docker image, You can pull the Ubuntu -14.04 Docker image from Docker hub: - -:: - - docker pull ubuntu:14.04 - -Installing Yardstick framework -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Download source code and install python dependencies: - -:: - - git clone https://gerrit.opnfv.org/gerrit/yardstick - cd yardstick - ./install.sh - - Installing Yardstick using Docker --------------------------------- -Yardstick has a Docker image, this Docker image (**Yardstick-stable**) -serves as a replacement for installing the Yardstick framework in a virtual -environment (for example as done in :ref:`install-framework`). -It is recommended to use this Docker image to run Yardstick test. +Yardstick has a Docker image, +**It is recommended to use this Docker image to run Yardstick test**. Pulling the Yardstick Docker image ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _dockerhub: https://hub.docker.com/r/opnfv/yardstick/ -Pull the Yardstick Docker image ('opnfv/yardstick') from the public dockerhub +Pull the Yardstick Docker image (**opnfv/yardstick**) from the public dockerhub registry under the OPNFV account: [dockerhub_], with the following docker command:: @@ -110,15 +82,114 @@ following docker command:: REPOSITORY TAG IMAGE ID CREATED SIZE opnfv/yardstick stable a4501714757a 1 day ago 915.4 MB -Run the Docker image: +Run the Docker image to get a Yardstick container +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: - docker run --privileged=true -it opnfv/yardstick:stable /bin/bash + docker run -itd --privileged -v /var/run/docker.sock:/var/run/docker.sock -p 8888:5000 -e INSTALLER_IP=192.168.200.2 -e INSTALLER_TYPE=compass --name yardstick opnfv/yardstick:stable + +note: + ++----------------------------------------------+------------------------------+ +| parameters | Detail | ++==============================================+==============================+ +| -itd | -i: interactive, Keep STDIN | +| | open even if not attached. | +| | -t: allocate a pseudo-TTY. | +| | -d: run container in | +| | detached mode, in the | +| | background. | ++----------------------------------------------+------------------------------+ +| --privileged | If you want to build | +| | yardstick-image in yardstick | +| | container, this parameter is | +| | needed. | ++----------------------------------------------+------------------------------+ +| -e INSTALLER_IP=192.168.200.2 | If you want to use yardstick | +| | env prepare command(or | +| -e INSTALLER_TYPE=compass | related API) to load the | +| | images that yardstick needs, | +| | these parameters should be | +| | provided. | +| | The INSTALLER_IP and | +| | INSTALLER_TYPE are depending | +| | on your OpenStack installer, | +| | currently apex, compass, | +| | fuel and joid are supported. | +| | If you use other installers, | +| | such as devstack, these | +| | parameters can be ignores. | ++----------------------------------------------+------------------------------+ +| -p 8888:5000 | If you want to call | +| | yardstick API out of | +| | yardstick container, this | +| | parameter is needed. | ++----------------------------------------------+------------------------------+ +| -v /var/run/docker.sock:/var/run/docker.sock | If you want to use yardstick | +| | env grafana/influxdb to | +| | create a grafana/influxdb | +| | container out of yardstick | +| | container, this parameter is | +| | needed. | ++----------------------------------------------+------------------------------+ +| --name yardstick | The name for this container, | +| | not needed and can be | +| | defined by the user. | ++----------------------------------------------+------------------------------+ + +Enter Yardstick container +^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: -In the container the Yardstick repository is located in the /home/opnfv/repos + docker exec -it yardstick /bin/bash + +In the container, the Yardstick repository is located in the /home/opnfv/repos directory. +In Danube release, we have improved the Yardstick installation steps. +Now Yardstick provides a CLI to prepare openstack environment variables and +load yardstick images:: + + yardstick env prepare + +If you ues this command. you can skip the following sections about how to +prepare openstack environment variables, load yardstick images and load +yardstick flavor manually. + + +Installing Yardstick directly in Ubuntu +--------------------------------------- + +.. _install-framework: + +Alternatively you can install Yardstick framework directly in Ubuntu or in an Ubuntu Docker +image. No matter which way you choose to install Yardstick framework, the +following installation steps are identical. + +If you choose to use the Ubuntu Docker image, You can pull the Ubuntu +Docker image from Docker hub: + +:: + + docker pull ubuntu:16.04 + + +Installing Yardstick framework +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Download source code and install Yardstick framework: + +:: + + git clone https://gerrit.opnfv.org/gerrit/yardstick + cd yardstick + ./install.sh + +For installing yardstick directly in Ubuntu, the **yardstick env command** is not available. +You need to prepare openstack environment variables, load yardstick images and load +yardstick flavor manually. + OpenStack parameters and credentials ------------------------------------ @@ -193,8 +264,6 @@ by following the commands above): :: - export YARD_IMG_ARCH="amd64" - sudo echo "Defaults env_keep += \"YARD_IMG_ARCH\"" >> /etc/sudoers sudo ./tools/yardstick-img-modify tools/ubuntu-server-cloudimg-modify.sh **Warning:** the script will create files by default in: @@ -215,12 +284,28 @@ Example command: --disk-format qcow2 --container-format bare \ --file /tmp/workspace/yardstick/yardstick-image.img -Some Yardstick test cases use a Cirros image, you can find one at -http://download.cirros-cloud.net/0.3.3/cirros-0.3.3-x86_64-disk.img +Some Yardstick test cases use a Cirros image and a Ubuntu 14.04 image, you can find one at +http://download.cirros-cloud.net/0.3.3/cirros-0.3.3-x86_64-disk.img, https://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-disk1.img + +Add cirros and ubuntu image to OpenStack: +:: + + openstack image create \ + --disk-format qcow2 \ + --container-format bare \ + --file $cirros_image_file \ + cirros-0.3.3 + + openstack image create \ + --disk-format qcow2 \ + --container-format bare \ + --file $ubuntu_image_file \ + Ubuntu-14.04 Automatic flavor and image creation ------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Yardstick has a script for automatic creating yardstick flavor and building guest images. This script is mainly used in CI, but you can still use it in your local environment. @@ -229,18 +314,9 @@ Example command: :: - export YARD_IMG_ARCH="amd64" - sudo echo "Defaults env_keep += \"YARD_IMG_ARCH\"" >> /etc/sudoers source $YARDSTICK_REPO_DIR/tests/ci/load_images.sh -Yardstick default key pair -^^^^^^^^^^^^^^^^^^^^^^^^^^ -Yardstick uses a SSH key pair to connect to the guest image. This key pair can -be found in the ``resources/files`` directory. To run the ``ping-hot.yaml`` test -sample, this key pair needs to be imported to the OpenStack environment. - - Examples and verifying the install ---------------------------------- @@ -251,7 +327,7 @@ image can be found in glance and openrc file is sourced. Below is an example invocation of yardstick help command and ping.py test sample: :: - yardstick –h + yardstick -h yardstick task start samples/ping.yaml Each testing tool supported by Yardstick has a sample configuration file. @@ -263,6 +339,30 @@ Default location for the output is ``/tmp/yardstick.out``. Deploy InfluxDB and Grafana locally ------------------------------------ +The 'yardstick env' command can also help you to build influxDB and Grafana in +your local environment. + +Create InfluxDB container and config with the following command:: + + yardstick env influxdb + + +Create Grafana container and config:: + + yardstick env grafana + +Then you can run a test case and visit http://host_ip:3000(user:admin,passwd:admin) to see the results. + +note: Using **yardstick env** command to deploy InfluxDB and Grafana requires +Jump Server's docker API version => 1.24. You can use the following command to +check the docker API version: + +:: + + docker version + +The following sections describe how to deploy influxDB and Grafana manually. + .. pull docker images Pull docker images @@ -398,4 +498,3 @@ the ci environment. "task_args" is where you can specify the task arguments for All in all, to create a test suite in yardstick, you just need to create a suite yaml file and add test cases and constraint or task arguments if necessary. - diff --git a/docs/testing/user/userguide/10-yardstick_plugin.rst b/docs/testing/user/userguide/05-yardstick_plugin.rst index f16dedd02..b724b361b 100644 --- a/docs/testing/user/userguide/10-yardstick_plugin.rst +++ b/docs/testing/user/userguide/05-yardstick_plugin.rst @@ -84,9 +84,10 @@ script can be used to generate it. echo "OS_PROJECT_NAME="$PROJECT_NAME >> ~/storperf_admin-rc echo "OS_TENANT_ID="$TENANT_ID >> ~/storperf_admin-rc +The generated "storperf_admin-rc" file will be stored under the root directory. If you installed Yardstick using Docker, this file will be located in the container. You may need to copy it to the root directory of the deployed host. Step 1: Plug-in configuration file preparation -++++++++++++++++++++++++++++++++++++++++++++++ +>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> To install a plug-in, first you need to prepare a plug-in configuration file in YAML format and store it in the "plugin" directory. The plugin configration file @@ -111,7 +112,7 @@ Here the Storperf will be installed on IP 192.168.23.2 which is the Jump Host in my local environment. Step 2: Plug-in install/remove scripts preparation -++++++++++++++++++++++++++++++++++++++++++++++++++ +>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> Under "yardstick/resource/scripts directory", there are two folders: a "install" folder and a "remove" folder. You need to store the plug-in install/remove script @@ -124,7 +125,7 @@ For example, the install and remove scripts for Storperf are both named to "stor Step 3: Install and remove Storperf -+++++++++++++++++++++++++++++++++++ +>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> To install Storperf, simply execute the following command :: diff --git a/docs/testing/user/userguide/11-result-store-InfluxDB.rst b/docs/testing/user/userguide/06-result-store-InfluxDB.rst index a0bb48a80..a0bb48a80 100644 --- a/docs/testing/user/userguide/11-result-store-InfluxDB.rst +++ b/docs/testing/user/userguide/06-result-store-InfluxDB.rst diff --git a/docs/testing/user/userguide/12-grafana.rst b/docs/testing/user/userguide/07-grafana.rst index 416857b71..416857b71 100644 --- a/docs/testing/user/userguide/12-grafana.rst +++ b/docs/testing/user/userguide/07-grafana.rst diff --git a/docs/testing/user/userguide/04-vtc-overview.rst b/docs/testing/user/userguide/08-vtc-overview.rst index 82b20cad5..f30bf7cc5 100644 --- a/docs/testing/user/userguide/04-vtc-overview.rst +++ b/docs/testing/user/userguide/08-vtc-overview.rst @@ -114,9 +114,12 @@ run the build.sh with root privileges Run === -sudo ./pfbridge -a eth1 -b eth2 +:: + + sudo ./pfbridge -a eth1 -b eth2 + Development Environment ======================= -Ubuntu 14.04 +Ubuntu 14.04 Ubuntu 16.04 diff --git a/docs/testing/user/userguide/05-apexlake_installation.rst b/docs/testing/user/userguide/09-apexlake_installation.rst index d4493e0f8..0d8ef143f 100644 --- a/docs/testing/user/userguide/05-apexlake_installation.rst +++ b/docs/testing/user/userguide/09-apexlake_installation.rst @@ -251,6 +251,8 @@ It is required to do the reset to the specified commit ID. It is also requires the creation a configuration file using the following command: +:: + SMCROUTE_NIC=(name of the nic) where name of the nic is the name used previously for the variable "name_if_2". diff --git a/docs/testing/user/userguide/06-apexlake_api.rst b/docs/testing/user/userguide/10-apexlake_api.rst index 35a1dbe3e..35a1dbe3e 100644 --- a/docs/testing/user/userguide/06-apexlake_api.rst +++ b/docs/testing/user/userguide/10-apexlake_api.rst diff --git a/docs/testing/user/userguide/07-nsb-overview.rst b/docs/testing/user/userguide/11-nsb-overview.rst index 19719f1a7..6dfa521d1 100644 --- a/docs/testing/user/userguide/07-nsb-overview.rst +++ b/docs/testing/user/userguide/11-nsb-overview.rst @@ -23,33 +23,53 @@ benchmarking with repeatable and deterministic methods. The Network Service Benchmarking (NSB) extends the yardstick framework to do VNF characterization and benchmarking in three different execution -environments viz., bare metal i.e. native Linux environment, standalone virtual +environments - bare metal i.e. native Linux environment, standalone virtual environment and managed virtualized environment (e.g. Open stack etc.). It also brings in the capability to interact with external traffic generators both hardware & software based for triggering and validating the traffic according to user defined profiles. NSB extension includes: - • Generic data models of Network Services, based on ETSI specs - • New Standalone context for VNF testing like SRIOV, OVS, OVS-DPDK etc - • Generic VNF configuration models and metrics implemented with Python + + - Generic data models of Network Services, based on ETSI spec (ETSI GS NFV-TST 001) + .. _ETSI GS NFV-TST 001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_nfv-tst001v010101p.pdf + + - New Standalone context for VNF testing like SRIOV, OVS, OVS-DPDK etc + + - Generic VNF configuration models and metrics implemented with Python classes - • Traffic generator features and traffic profiles - • L1-L3 state-less traffic profiles - • L4-L7 state-full traffic profiles - • Tunneling protocol / network overlay support - • Test case samples - • Ping - • Trex - • vPE,vCGNAT, vFirewall etc - ipv4 throughput, latency etc - • Traffic generators like Trex, ab/nginx, ixia, iperf etc - • KPIs for a given use case: - • System agent support for collecting NFvi KPI. This includes: - o CPU statistic - o Memory BW - o OVS-DPDK Stats - • Network KPIs – eg, inpackets, outpackets, thoughput, latency etc - • VNF KPIs – packet_in, packet_drop, packet_fwd etc + + - Traffic generator features and traffic profiles + + - L1-L3 state-less traffic profiles + + - L4-L7 state-full traffic profiles + + - Tunneling protocol / network overlay support + + - Test case samples + + - Ping + + - Trex + + - vPE,vCGNAT, vFirewall etc - ipv4 throughput, latency etc + + - Traffic generators like Trex, ab/nginx, ixia, iperf etc + + - KPIs for a given use case: + + - System agent support for collecting NFVi KPI. This includes: + + - CPU statistic + + - Memory BW + + - OVS-DPDK Stats + + - Network KPIs, e.g., inpackets, outpackets, thoughput, latency etc + + - VNF KPIs, e.g., packet_in, packet_drop, packet_fwd etc Architecture ============ @@ -72,18 +92,25 @@ makes an example how the real Network Operator use-case can map into ETSI Network service definition Network Service framework performs the necessary test steps. It may involve - o Interacting with traffic generator and providing the inputs on traffic + + - Interacting with traffic generator and providing the inputs on traffic type / packet structure to generate the required traffic as per the test case. Traffic profiles will be used for this. - o Executing the commands required for the test procedure and analyses the + + - Executing the commands required for the test procedure and analyses the command output for confirming whether the command got executed correctly or not. E.g. As per the test case, run the traffic for the given time period / wait for the necessary time delay - o Verify the test result. - o Validate the traffic flow from SUT - o Fetch the table / data from SUT and verify the value as per the test case - o Upload the logs from SUT onto the Test Harness server - o Read the KPI’s provided by particular VNF + + - Verify the test result. + + - Validate the traffic flow from SUT + + - Fetch the table / data from SUT and verify the value as per the test case + + - Upload the logs from SUT onto the Test Harness server + + - Read the KPI's provided by particular VNF Components of Network Service ------------------------------ @@ -124,14 +151,19 @@ The TREX tool can generate any kind of stateless traffic. +--------+ +-------+ +--------+ Supported testcases scenarios: -• Correlated UDP traffic using TREX traffic generator and replay VNF. - o using different IMIX configuration like pure voice, pure video traffic etc - o using different number IP flows like 1 flow, 1K, 16K, 64K, 256K, 1M flows - o Using different number of rules configured like 1 rule, 1K, 10K rules + + - 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 like 1 flow, 1K, 16K, 64K, 256K, 1M flows + + - Using different number of rules configured like 1 rule, 1K, 10K rules For UDP correlated traffic following Key Performance Indicators are collected for every combination of test case parameters: - • RFC2544 throughput for various loss rate defined (1% is a default) + + - RFC2544 throughput for various loss rate defined (1% is a default) Graphical Overview ================== @@ -140,6 +172,7 @@ NSB Testing with yardstick framework facilitate performance testing of various VNFs provided. .. code-block:: console + +-----------+ | | +-----------+ | vPE | ->|TGen Port 0| @@ -156,6 +189,7 @@ VNFs provided. | Traffic | ->|TGen Port 1| | patterns | +-----------+ +-----------+ + Figure 1: Network Service - 2 server configuration @@ -167,9 +201,11 @@ run the nsb_install.sh with root privileges Run === -source ~/.bash_profile -cd <yardstick_repo>/yardstick/cmd -sudo -E ./NSBperf.py --vnf vpe --test tc_baremetal_rfc2544_ipv4_1flow_64B.yaml +:: + + source ~/.bash_profile + cd <yardstick_repo>/yardstick/cmd + sudo -E ./NSBperf.py --vnf vpe --test tc_baremetal_rfc2544_ipv4_1flow_64B.yaml Development Environment ======================= diff --git a/docs/testing/user/userguide/08-nsb_installation.rst b/docs/testing/user/userguide/12-nsb_installation.rst index a390bb7d7..0b0840029 100644 --- a/docs/testing/user/userguide/08-nsb_installation.rst +++ b/docs/testing/user/userguide/12-nsb_installation.rst @@ -9,10 +9,6 @@ Yardstick - NSB Testing -Installation Abstract -------- -Yardstick supports installation on Ubuntu 14.04 or via a Docker image. The -installation procedure on Ubuntu 14.04 or via the docker image are detailed in -the section below. - The Network Service Benchmarking (NSB) extends the yardstick framework to do VNF characterization and benchmarking in three different execution environments viz., bare metal i.e. native Linux environment, standalone virtual @@ -32,20 +28,30 @@ The steps needed to run Yardstick with NSB testing are: Prerequisites ------------- -Refer chapter 08-instalaltion.rst for more information on yardstick +Refer chapter Yardstick Instalaltion for more information on yardstick prerequisites Several prerequisites are needed for Yardstick(VNF testing): -* Python Modules: pyzmq, pika. -* flex -* bison -* build-essential -* automake -* libtool -* librabbitmq-dev -* rabbitmq-server -* collectd -* intel-cmt-cat + +- Python Modules: pyzmq, pika. + +- flex + +- bison + +- build-essential + +- automake + +- libtool + +- librabbitmq-dev + +- rabbitmq-server + +- collectd + +- intel-cmt-cat Installing Yardstick on Ubuntu 14.04 ------------------------------------ @@ -65,7 +71,7 @@ If you choose to use the Ubuntu 14.04 Docker image, You can pull the Ubuntu Installing Yardstick framework ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Download source code and install python dependencies: +Download source code and install Yardstick framework: :: @@ -73,7 +79,7 @@ Download source code and install python dependencies: cd yardstick ./nsb_setup.sh -It will automatically download all the packages needed for NSB Testing setup. +It will also automatically download all the packages needed for NSB Testing setup. System Topology: ----------------- @@ -95,19 +101,24 @@ OpenStack parameters and credentials Environment variables ^^^^^^^^^^^^^^^^^^^^^ + Before running Yardstick (NSB Testing) it is necessary to export traffic generator libraries. :: - source ~/.bash_profile + + source ~/.bash_profile Config yardstick conf ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -cp ./etc/yardstick/yardstick.conf.sample /etc/yardstick/yardstick.conf -vi /etc/yardstick/yardstick.conf +:: + + cp ./etc/yardstick/yardstick.conf.sample /etc/yardstick/yardstick.conf + vi /etc/yardstick/yardstick.conf + +Add trex_path and bin_path in 'nsb' section. -Config yardstick.conf :: [DEFAULT] @@ -128,10 +139,13 @@ Config yardstick.conf Config pod.yaml describing Topology ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Before executing Yardstick test cases, make sure that pod.yaml reflects the topology and update all the required fields. -copy /etc/yardstick/nodes/pod.yaml.nsb.example to /etc/yardstick/nodes/pod.yaml +:: + + cp /etc/yardstick/nodes/pod.yaml.nsb.sample /etc/yardstick/nodes/pod.yaml Config pod.yaml :: @@ -202,6 +216,7 @@ Config pod.yaml Enable yardstick virtual environment ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Before executing yardstick test cases, make sure to activate yardstick python virtual environment @@ -219,7 +234,7 @@ image can be found in glance and openrc file is sourced. Below is an example invocation of yardstick help command and ping.py test sample: :: - yardstick –h + yardstick -h yardstick task start samples/ping.yaml Each testing tool supported by Yardstick has a sample configuration file. diff --git a/docs/testing/user/userguide/images/Yardstick_framework_architecture_in_D.png b/docs/testing/user/userguide/images/Yardstick_framework_architecture_in_D.png Binary files differnew file mode 100644 index 000000000..f4065cb5e --- /dev/null +++ b/docs/testing/user/userguide/images/Yardstick_framework_architecture_in_D.png diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst index 1b963af61..a732fcc47 100644 --- a/docs/testing/user/userguide/index.rst +++ b/docs/testing/user/userguide/index.rst @@ -13,15 +13,15 @@ Performance Testing User Guide (Yardstick) 01-introduction 02-methodology 03-architecture - 04-vtc-overview - 05-apexlake_installation - 06-apexlake_api - 07-nsb-overview - 08-nsb_installation - 09-installation - 10-yardstick_plugin - 11-result-store-InfluxDB - 12-grafana + 04-installation + 05-yardstick_plugin + 06-result-store-InfluxDB + 07-grafana + 08-vtc-overview + 09-apexlake_installation + 10-apexlake_api + 11-nsb-overview + 12-nsb_installation 13-list-of-tcs glossary references diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc076.rst b/docs/testing/user/userguide/opnfv_yardstick_tc076.rst index ac7bde794..1e7647fa6 100644 --- a/docs/testing/user/userguide/opnfv_yardstick_tc076.rst +++ b/docs/testing/user/userguide/opnfv_yardstick_tc076.rst @@ -19,14 +19,20 @@ Yardstick Test Case Description TC076 | | TCP segment error rate and UDP datagram error rate | | | | +--------------+--------------------------------------------------------------+ -|test purpose | Monitor network metrics provided by the kernel in a host and | -| | calculate IP datagram error rate, ICMP message error rate, | -| | TCP segment error rate and UDP datagram error rate. | +|test purpose | The purpose of TC076 is to evaluate the IaaS network | +| | reliability with regards to IP datagram error rate, ICMP | +| | message error rate, TCP segment error rate and UDP datagram | +| | error rate. | | | | -+--------------+--------------------------------------------------------------+ -|configuration | file: opnfv_yardstick_tc076.yaml | +| | TC076 monitors network metrics provided by the Linux kernel | +| | in a host and calculates IP datagram error rate, ICMP | +| | message error rate, TCP segment error rate and UDP datagram | +| | error rate. | | | | -| | There is no additional configuration to be set for this TC. | +| | The purpose is also to be able to spot the trends. | +| | Test results, graphs and similar shall be stored for | +| | comparison reasons and product evolution understanding | +| | between different OPNFV versions and/or configurations. | | | | +--------------+--------------------------------------------------------------+ |test tool | nstat | @@ -34,6 +40,25 @@ Yardstick Test Case Description TC076 | | nstat is a simple tool to monitor kernel snmp counters and | | | network interface statistics. | | | | +| | (nstat is not always part of a Linux distribution, hence it | +| | needs to be installed. nstat is provided by the iproute2 | +| | collection, which is usually also the name of the package in | +| | many Linux distributions.As an example see the | +| | /yardstick/tools/ directory for how to generate a Linux | +| | image with iproute2 included.) | +| | | ++--------------+--------------------------------------------------------------+ +|test | Ping packets (ICMP protocol's mandatory ECHO_REQUEST | +|description | datagram) are sent from host VM to target VM(s) to elicit | +| | ICMP ECHO_RESPONSE. | +| | | +| | nstat is invoked on the target vm to monitors network | +| | metrics provided by the Linux kernel. | ++--------------+--------------------------------------------------------------+ +|configuration | file: opnfv_yardstick_tc076.yaml | +| | | +| | There is no additional configuration to be set for this TC. | +| | | +--------------+--------------------------------------------------------------+ |references | nstat man page | | | | @@ -43,19 +68,37 @@ Yardstick Test Case Description TC076 |applicability | This test case is mainly for monitoring network metrics. | | | | +--------------+--------------------------------------------------------------+ -|pre_test | | -|conditions | | +|pre_test | The test case image needs to be installed into Glance | +|conditions | with fio included in it. | +| | | +| | No POD specific requirements have been identified. | | | | +--------------+--------------------------------------------------------------+ |test sequence | description and expected result | | | | +--------------+--------------------------------------------------------------+ -|step 1 | The pod is available. | -| | Nstat is invoked and logs are produced and stored. | +|step 1 | Two host VMs are booted, as server and client. | +| | | ++--------------+--------------------------------------------------------------+ +|step 2 | Yardstick is connected with the server VM by using ssh. | +| | 'ping_benchmark' bash script is copyied from Jump Host to | +| | the server VM via the ssh tunnel. | +| | | ++--------------+--------------------------------------------------------------+ +|step 3 | Ping is invoked. Ping packets are sent from server VM to | +| | client VM. RTT results are calculated and checked against | +| | the SLA. nstat is invoked on the client vm to monitors | +| | network metrics provided by the Linux kernel. IP datagram | +| | error rate, ICMP message error rate, TCP segment error rate | +| | and UDP datagram error rate are calculated. | +| | Logs are produced and stored. | | | | | | Result: Logs are stored. | | | | +--------------+--------------------------------------------------------------+ +|step 4 | Two host VMs are deleted. | +| | | ++--------------+--------------------------------------------------------------+ |test verdict | None. | | | | +--------------+--------------------------------------------------------------+ |
