From 7d8bfd26b45b511898825a24ecf0977a336fac13 Mon Sep 17 00:00:00 2001 From: kalyanreddy Date: Wed, 22 Mar 2017 14:42:25 +0530 Subject: [PATCH] This patch is used to update the documents of D-release. Change-Id: Iccebac991c1ea0973733963743d4d1438ac153b2 Co-Authored by:Srinivas Co-Authored by:RajithaY Co-Authored by:shravani paladugula Co-Authored by:Navya Bathula Signed-off-by: Gundarapu Kalyan Reddy --- .../configuration.options.render.rst | 2 +- docs/glossary/kvmfornfv_glossary.rst | 4 + docs/index.rst | 2 +- .../kvm4nfv-cicd.installation.instruction.rst | 10 ++- .../kvm4nfv-cicd.release.notes.rst | 14 +-- docs/overview/kvmfornfv_overview.rst | 12 +-- docs/releasenotes/release-notes.rst | 92 ++++++++++--------- docs/requirements/kvmfornfv_requirements.rst | 2 +- docs/scenarios/abstract.rst | 36 ++++---- docs/scenarios/kvmfornfv.scenarios.description.rst | 100 +++++++++++---------- .../kvmfornfv.cyclictest-dashboard.userguide.rst | 26 ++++-- docs/userguide/low_latency.userguide.rst | 2 +- docs/userguide/packet_forwarding.userguide.rst | 26 ++---- docs/userguide/pcm_utility.userguide.rst | 14 +-- 14 files changed, 178 insertions(+), 164 deletions(-) diff --git a/docs/configurationguide/configuration.options.render.rst b/docs/configurationguide/configuration.options.render.rst index 1c1c62228..64e0556ea 100644 --- a/docs/configurationguide/configuration.options.render.rst +++ b/docs/configurationguide/configuration.options.render.rst @@ -20,4 +20,4 @@ important to understand your target platform capabilities before installing and configuring. This configuration guide outlines how to install and configure components in order to enable the features required. -.. include:: ./scenariomatrix.rst +#.. include:: ./scenariomatrix.rst diff --git a/docs/glossary/kvmfornfv_glossary.rst b/docs/glossary/kvmfornfv_glossary.rst index f5b547b85..aed5a971e 100644 --- a/docs/glossary/kvmfornfv_glossary.rst +++ b/docs/glossary/kvmfornfv_glossary.rst @@ -98,6 +98,10 @@ CPU D ~ +Danube + + Danube is the fourth release of OPNFV and also a river in Europe + Data plane The data plane is the part of a network that carries user traffic. diff --git a/docs/index.rst b/docs/index.rst index 8198d8597..a549e6fdf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -62,8 +62,8 @@ KVMFORNFV Configuration Guide ./configurationguide/abstract.rst ./configurationguide/configuration.options.render.rst - ./configurationguide/low-latency.feature.configuration.description.rst ./configurationguide/scenariomatrix.rst + ./configurationguide/low-latency.feature.configuration.description.rst ******************************************** KVMFORNFV Scenarios Overview and Description diff --git a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst index 4ddcb6f2e..ef6d32fc9 100644 --- a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst +++ b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst @@ -17,9 +17,9 @@ HW requirements --------------- These build scripts are triggered on the Jenkins-Slave build server. Currently -Intel POD1 is used as test environment for kvmfornfv to execute cyclictest. As -part of this test environment Intel pod1-jump is configured as jenkins slave -and all the latest build artifacts are downloaded on to it. Intel pod1-node1 +Intel POD10 is used as test environment for kvmfornfv to execute cyclictest. As +part of this test environment Intel pod10-jump is configured as jenkins slave +and all the latest build artifacts are downloaded on to it. Intel pod10-node1 is the host on which a guest vm will be launched as a part of running cylictest through yardstick. @@ -28,7 +28,9 @@ Build instructions Builds are possible for the following packages- -**kvmfornfv source code**- The ./ci/build.sh is the main script used to trigger +**kvmfornfv source code** + +The ./ci/build.sh is the main script used to trigger the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case. * How to build Kernel/Qemu Rpms- To build rpm packages, build.sh script is run diff --git a/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst b/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst index 5908ff150..1913be8d7 100644 --- a/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst +++ b/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst @@ -84,19 +84,19 @@ Feature additions | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-34 | +| JIRA: | NFV Hypervisors-KVMFORNFV-34 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-57 | +| JIRA: | NFV Hypervisors-KVMFORNFV-57 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-58 | +| JIRA: | NFV Hypervisors-KVMFORNFV-58 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-59 | +| JIRA: | NFV Hypervisors-KVMFORNFV-59 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-60 | +| JIRA: | NFV Hypervisors-KVMFORNFV-60 | | | | +--------------------------------------+--------------------------------------+ @@ -129,7 +129,7 @@ Known issues | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | | +| JIRA: | NFV Hypervisors-KVMFORNFV-75 | +--------------------------------------+--------------------------------------+ | JIRA: | | +--------------------------------------+--------------------------------------+ @@ -137,7 +137,7 @@ Known issues Workarounds ----------- -See JIRA: +See JIRA: https://jira.opnfv.org/projects References diff --git a/docs/overview/kvmfornfv_overview.rst b/docs/overview/kvmfornfv_overview.rst index b07d38dd0..a298876e5 100644 --- a/docs/overview/kvmfornfv_overview.rst +++ b/docs/overview/kvmfornfv_overview.rst @@ -2,17 +2,17 @@ .. http://creativecommons.org/licenses/by/4.0 -============================= -KMV4MFV CICD Project Overview -============================= +=============================== +KVMFORNFV CICD Project Overview +=============================== The detailed understanding of this project is organized into different sections- * **userguide** - This provides the required technical assistance to the user, in using the KVM4NFV CICD process. -* **installationprocedure** - This will give the user instructions on how to deploy +* **installation procedure** - This will give the user instructions on how to deploy available KVM4NFV CICD build scenario. -* **configurationguide** - This provides guidance for configuring KVM4NFV +* **configuration guide** - This provides guidance for configuring KVM4NFV environment, even with the use of specific installer tools for deploying some components, available in the Danube release of OPNFV. * **requirements** - This includes the introduction of KVM4NFV CICD project, @@ -22,6 +22,6 @@ The detailed understanding of this project is organized into different sections- account for achieving minimal interrupt latency for the data VNFs. * **scenarios** - This includes the sceanrios that are currently implemented in the kvmfornfv project,features of each scenario and a general guide to how to deploy them. -* **releasenotes** - This describes a brief summary of recent changes, enhancements +* **release notes** - This describes a brief summary of recent changes, enhancements and bug fixes in the KVM4NFV project. * **glossary** - It includes the definition of terms, used in the KVM4NFV project. diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst index f49cd0804..9f20855fc 100644 --- a/docs/releasenotes/release-notes.rst +++ b/docs/releasenotes/release-notes.rst @@ -15,18 +15,18 @@ This document provides the release notes for Danube 1.0 release of KVMFORNFV. **Contents** - 1 Version History + **1 Version History** - 2 Important notes + **2 Important notes** - 3 Summary + **3 Summary** - 4 Delivery Data + **4 Delivery Data** - 5 References + **5 References** -1. Version history --------------------- +Version history +--------------- +--------------------+--------------------+--------------------+----------------------+ | **Date** | **Ver.** | **Author** | **Comment** | @@ -39,13 +39,13 @@ This document provides the release notes for Danube 1.0 release of KVMFORNFV. | | | | | +--------------------+--------------------+--------------------+----------------------+ -2. Important notes --------------------- +Important notes +--------------- The KVMFORNFV project is currently supported on the Fuel installer. -3. Summary ------------- +Summary +------- This Danube 1.0 release provides *KVMFORNFV* as a framework to enhance the KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV @@ -57,9 +57,11 @@ CI pipeline, including: * Cyclictests execution to check the latency -* “os-sdn-kvm-ha”,“os-sdn-kvm-_nfv_ovs_dpdk-ha”,“os-sdn-kvm_nfv_ovs_dpdk-noha”,“os-sdn-kvm_nfv_ovs_dpdk_bar-ha”,“os-sdn-kvm_nfv_ovs_dpdk_bar-noha” Scenarios testing for high availability configuration using Fuel installer +* “os-nosdn-kvm-ha”,“os-nosdn-kvm_nfv_ovs_dpdk-ha”,“os-nosdn-kvm_nfv_ovs_dpdk-noha”,“os-nosdn-kvm_nfv_ovs_dpdk_bar-ha”, + “os-nosdn-kvm_nfv_ovs_dpdk_bar-noha” Scenarios testing for ``high availability/no-high avaliability`` + configuration using Fuel installer -* Documentation created +* Documentation created for, * User Guide @@ -69,11 +71,13 @@ CI pipeline, including: * Release notes (this document) + * Scenarios + The *KVMFORNFV framework* is developed in the OPNFV community, by the KVMFORNFV_ team. -4. Release Data ------------------ +Release Data +------------ +--------------------------------------+--------------------------------------+ | **Project** | NFV Hypervisors-KVM | @@ -92,16 +96,16 @@ KVMFORNFV_ team. | | | +--------------------------------------+--------------------------------------+ -4.1 Version change ------------------- +Version change +-------------- -4.1.1 Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +1 Module version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~ This is the Danube 1.0 main release. It is based on following upstream versions: -* RT Kernel 4.4.6-rt14 +* RT Kernel 4.4.50-rt62 * QEMU 2.6 @@ -110,59 +114,59 @@ versions: This is the second tracked release of KVMFORNFV -4.1.2 Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +2 Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is the initial version of the KVMFORNFV framework in OPNFV. -4.2 Reason for version ----------------------- +Reason for version +------------------ -4.2.1 Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ +1 Feature additions +~~~~~~~~~~~~~~~~~~~ +--------------------------------------+--------------------------------------+ | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-57 | +| JIRA: | NFV Hypervisors-KVMFORNFV-57 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-58 | +| JIRA: | NFV Hypervisors-KVMFORNFV-58 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-59 | +| JIRA: | NFV Hypervisors-KVMFORNFV-59 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-61 | +| JIRA: | NFV Hypervisors-KVMFORNFV-61 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-62 | +| JIRA: | NFV Hypervisors-KVMFORNFV-62 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-63 | +| JIRA: | NFV Hypervisors-KVMFORNFV-63 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-64 | +| JIRA: | NFV Hypervisors-KVMFORNFV-64 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-65 | +| JIRA: | NFV Hypervisors-KVMFORNFV-65 | | | | +--------------------------------------+--------------------------------------+ -4.2.2 Bug corrections -~~~~~~~~~~~~~~~~~~~~~ +2 Bug corrections +~~~~~~~~~~~~~~~~~ Initial Release -4.3 Deliverables ----------------- +Deliverables +------------ -4.3.1 Software deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +1 Software deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~ Danube 1.0 release of the KVMFORNFV RPM and debian for Fuel. -4.3.2 Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +2 Documentation deliverables +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The below documents are delivered for Danube KVMFORNFV Release: @@ -180,8 +184,8 @@ The below documents are delivered for Danube KVMFORNFV Release: * Scenarios -5. References --------------- +References +---------- For more information on the KVMFORNFV Danube release, please see: diff --git a/docs/requirements/kvmfornfv_requirements.rst b/docs/requirements/kvmfornfv_requirements.rst index 6aa00ba6c..1eaf592a5 100644 --- a/docs/requirements/kvmfornfv_requirements.rst +++ b/docs/requirements/kvmfornfv_requirements.rst @@ -3,7 +3,7 @@ .. (c) OPNFV, Intel Corporation, AT&T and others. ====================== -kvmfornfv Requirements +Kvmfornfv Requirements ====================== Introduction diff --git a/docs/scenarios/abstract.rst b/docs/scenarios/abstract.rst index 362fb6c2b..1480f778d 100644 --- a/docs/scenarios/abstract.rst +++ b/docs/scenarios/abstract.rst @@ -13,32 +13,30 @@ Release Features +------------------------------------------+------------------+-----------------+ | **Scenario Name** | **Colorado** | **Danube** | | | | | -+------------------------------------------+------------------+-----------------+ ++==========================================+==================+=================+ | - os-nosdn-kvm-ha | ``Y`` | ``Y`` | -| | | | ++------------------------------------------+------------------+-----------------+ | - os-nosdn-kvm_nfv_ovs_dpdk-noha | | ``Y`` | -| | | | ++------------------------------------------+------------------+-----------------+ | - os-nosdn-kvm_nfv_ovs_dpdk-ha | | ``Y`` | -| | | | ++------------------------------------------+------------------+-----------------+ | - os-nosdn-kvm_nfv_ovs_dpdk_bar-noha | | ``Y`` | -| | | | ++------------------------------------------+------------------+-----------------+ | - os-nosdn-kvm_nfv_ovs_dpdk_bar-ha | | ``Y`` | -| | | | +------------------------------------------+------------------+-----------------+ D- Release Scenario's overview ------------------------------- -+--------------------------------------+-----------------------+---------------------+--------------------+-------------+------------+ -| **Scenario Name** | **No of Controllers** | **No of Computes** | ** Plugins Name** | ** DPDK** | ** OVS ** | -| | | | | | | -+--------------------------------------+-----------------------+---------------------+--------------------+-------------+------------+ -| - os-nosdn-kvm_nfv_ovs_dpdk-noha | ``1`` | ``3`` | ``KVM`` | ``Y`` | ``Y`` | -| | | | | | | -| - os-nosdn-kvm_nfv_ovs_dpdk-ha | ``3`` | ``2`` | ``KVM`` | ``Y`` | ``Y`` | -| | | | | | | -| - os-nosdn-kvm_nfv_ovs_dpdk_bar-noha | ``1`` | ``2`` | ``KVM & BAR`` | ``Y`` | ``Y`` | -| | | | | | | -| - os-nosdn-kvm_nfv_ovs_dpdk_bar-ha | ``3`` | ``3`` | ``KVM & BAR`` | ``Y`` | ``Y`` | -| | | | | | | -+--------------------------------------+-----------------------+---------------------+--------------------+-------------+------------+ ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| **Scenario Name** | **No of Controllers** | **No of Computes** | **Plugin Names** | **DPDK** | **OVS** | +| | | | | | | ++==========================================+=======================+=====================+==================+==========+==========+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk-noha`` | 1 | 3 | KVM | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk-ha`` | 3 | 2 | KVM | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk_bar-noha`` | 1 | 3 | KVM & BAR | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ +| - ``os-nosdn-kvm_nfv_ovs_dpdk_bar-ha`` | 3 | 2 | KVM & BAR | Y | Y | ++------------------------------------------+-----------------------+---------------------+------------------+----------+----------+ diff --git a/docs/scenarios/kvmfornfv.scenarios.description.rst b/docs/scenarios/kvmfornfv.scenarios.description.rst index 29488bbfd..c7715b252 100644 --- a/docs/scenarios/kvmfornfv.scenarios.description.rst +++ b/docs/scenarios/kvmfornfv.scenarios.description.rst @@ -2,11 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 -======================== -KVM4NFV SCENARIO-TESTING -======================== +============================== +KVMFORNFV Scenario-Description +============================== -ABSTRACT +Abstract -------- This document describes the procedure to deploy/test KVM4NFV scenarios in a nested virtualization @@ -40,7 +40,7 @@ Version Features +-----------------------------+---------------------------------------------+ -INTRODUCTION +Introduction ------------ The purpose of os-nosdn-kvm_ovs_dpdk-ha,os-nosdn-kvm_ovs_dpdk_bar-ha and os-nosdn-kvm_ovs_dpdk-noha,os-nosdn-kvm_ovs_dpdk_bar-noha scenarios testing is to @@ -60,8 +60,8 @@ multi-node setup with 1 Fuel-Master,1 controllers and 3 computes nodes. KVMFORNFV packages will be installed on compute nodes as part of deployment. The scenario testcase deploys a multi-node setup by using OPNFV Fuel deployer. -1. System pre-requisites ------------------------- +System pre-requisites +--------------------- - RAM - Minimum 16GB - HARD DISK - Minimum 500GB @@ -98,11 +98,11 @@ If Nested virtualization is disabled, enable it by, EOF $ sudo reboot -2. Environment Setup --------------------- +Environment Setup +----------------- -**2.1 Configuring Proxy** -~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Configuring Proxy** +~~~~~~~~~~~~~~~~~~~~~ For **Ubuntu**., Create an apt.conf file in /etc/apt if it doesn't exist. Used to set proxy for apt-get if working behind a proxy server. @@ -121,8 +121,8 @@ Edit /etc/yum.conf to work behind a proxy server by adding the below line. $ echo "proxy=http://:@:/" >> /etc/yum.conf -**2.2 Network Time Protocol (NTP) setup and configuration** -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +**Network Time Protocol (NTP) setup and configuration** +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Install ntp by: @@ -146,24 +146,24 @@ Restart the ntp server to apply the changes $ sudo service ntp restart -3. Scenario Testing -------------------- +Scenario Testing +---------------- There are three ways of performing scenario testing, - - 3.1 Fuel - - 3.2 OPNFV-Playground - - 3.3 Jenkins Project + - 1 Fuel + - 2 OPNFV-Playground + - 3 Jenkins Project -3.1 Fuel -~~~~~~~~ +Fuel +~~~~ -**3.1.1 Clone the fuel repo :** +**1 Clone the fuel repo :** .. code:: bash $ git clone https://gerrit.opnfv.org/gerrit/fuel.git -**3.1.2 Checkout to the specific version of the branch to deploy by:** +**2 Checkout to the specific version of the branch to deploy by:** The default branch is master, to use a stable release-version use the below., @@ -174,7 +174,7 @@ The default branch is master, to use a stable release-version use the below., To check out a specific branch $ git checkout stable/Colorado -**3.1.3 Building the Fuel iso :** +**3 Building the Fuel iso :** .. code:: bash @@ -197,9 +197,9 @@ Create a ``customized iso`` as per the deployment needs. http://artifacts.opnfv.org/fuel.html -**3.1.4 Creating a new deployment scenario** +**4 Creating a new deployment scenario** -``(i). Naming the scenario file:`` +``(i). Naming the scenario file`` Include the new deployment scenario yaml file in ~/fuel/deploy/scenario/. The file name should adhere to the following format: @@ -208,6 +208,7 @@ Include the new deployment scenario yaml file in ~/fuel/deploy/scenario/. The fi ___..._.yaml ``(ii). Meta data`` + The deployment configuration file should contain configuration metadata as stated below: .. code:: bash @@ -218,7 +219,8 @@ The deployment configuration file should contain configuration metadata as state created: ``(iii). “stack-extentions” Module`` - To include fuel plugins in the deployment configuration file, use the “stack-extentions” key: + +To include fuel plugins in the deployment configuration file, use the “stack-extentions” key: .. code:: bash @@ -233,9 +235,11 @@ The deployment configuration file should contain configuration metadata as state **Note:** The “module-config-name” and “module-config-version” should be same as the name of plugin configuration file. -The “module-config-override” is used to configure the plugin by overrriding the corresponding keys in the plugin config yaml file present in ~/fuel/deploy/config/plugins/. +The “module-config-override” is used to configure the plugin by overrriding the corresponding keys in +the plugin config yaml file present in ~/fuel/deploy/config/plugins/. ``(iv). “dea-override-config” Module`` + To configure the HA/No-HA mode, network segmentation types and role to node assignments, use the “dea-override-config” key. .. code:: bash @@ -284,10 +288,12 @@ and {nodes:1,2,...} and can also enable additional stack features such ceph,heat corresponding keys in the dea_base.yaml and dea_pod_override.yaml. ``(v). “dha-override-config” Module`` + In order to configure the pod dha definition, use the “dha-override-config” key. This is an optional key present at the ending of the scenario file. ``(vi). Mapping to short scenario name`` + The scenario.yaml file is used to map the short names of scenario's to the one or more deployment scenario configuration yaml files. The short scenario names should follow the scheme below: @@ -334,8 +340,7 @@ Note: - ( _ ) used to separate the values belong to the same field. [os-nosdn-kvm_ovs_bar-ha]. -**3.1.5 Deploying the scenario** - +**5 Deploying the scenario** Command to deploy the os-nosdn-kvm_ovs_dpdk-ha scenario: @@ -364,8 +369,8 @@ where, Check $ sudo ./deploy.sh -h for further information. -3.2 OPNFV-Playground -~~~~~~~~~~~~~~~~~~~~ +OPNFV-Playground +~~~~~~~~~~~~~~~~ Install OPNFV-playground (the tool chain to deploy/test CI scenarios in fuel@opnfv, ): @@ -384,17 +389,20 @@ Install OPNFV-playground (the tool chain to deploy/test CI scenarios in fuel@opn -``3.2.1 Downgrade paramiko package from 2.x.x to 1.10.0`` +``1 Downgrade paramiko package from 2.x.x to 1.10.0`` The paramiko package 2.x.x doesn’t work with OPNFV-playground tool chain now, Jira ticket FUEL - 188 has been raised for the same. Check paramiko package version by following below steps in your system: -$ python -Python 2.7.6 (default, Jun 22 2015, 17:58:13) [GCC 4.8.2] on linux2 Type "help", "copyright", "credits" or "license" for more information. ->>> import paramiko ->>> print paramiko.__version__ ->>> exit() +.. code:: bash + + $ python + Python 2.7.6 (default, Jun 22 2015, 17:58:13) [GCC 4.8.2] on linux2 Type "help", "copyright", "credits" or "license" for more information. + + >>> import paramiko + >>> print paramiko.__version__ + >>> exit() You will get the current paramiko package version, if it is 2.x.x, uninstall this version by @@ -419,7 +427,7 @@ Verify it by following: >>> exit() -``3.2.2 Clone the fuel@opnfv`` +``2 Clone the fuel@opnfv`` Check out the specific version of specific branch of fuel@opnfv @@ -432,11 +440,11 @@ Check out the specific version of specific branch of fuel@opnfv $ git checkout stable/Danube -``3.2.3 Creating the scenario`` +``3 Creating the scenario`` Implement the scenario file as described in 3.1.4 -``3.2.4 Deploying the scenario`` +``4 Deploying the scenario`` You can use the following command to deploy/test os-nosdn kvm_ovs_dpdk-(no)ha and os-nosdn-kvm_ovs_dpdk_bar-(no)ha scenario @@ -469,15 +477,15 @@ Note: Check $ ./ci_pipeline.sh -h for further information. -3.3 Jenkins Project -~~~~~~~~~~~~~~~~~~~ +Jenkins Project +~~~~~~~~~~~~~~~ os-nosdn-kvm_ovs_dpdk-(no)ha and os-nosdn-kvm_ovs_dpdk_bar-(no)ha scenario can be executed from the jenkins project : - HA scenarios: + ``HA scenarios:`` 1. "fuel-os-nosdn-kvm_ovs_dpdk-ha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk-ha) 2. "fuel-os-nosdn-kvm_ovs_dpdk_bar-ha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk_bar-ha) - NOHA scenarios: - 1. "fuel-os-nosdn-kvm_ovs_dpdk-noha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk-noha) - 2. "fuel-os-nosdn-kvm_ovs_dpdk_bar-noha-baremetal-daily-master" (os-nosdn-kvm_ovs_dpdk_bar-noha) + ``NOHA scenarios:`` + 1. "fuel-os-nosdn-kvm_ovs_dpdk-noha-virtual-daily-master" (os-nosdn-kvm_ovs_dpdk-noha) + 2. "fuel-os-nosdn-kvm_ovs_dpdk_bar-noha-virtual-daily-master" (os-nosdn-kvm_ovs_dpdk_bar-noha) diff --git a/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst b/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst index 4ec8f5013..e7a516bff 100644 --- a/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst +++ b/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst @@ -15,7 +15,7 @@ Abstract This chapter explains the procedure to configure the InfluxDB and Grafana on Node1 or Node2 depending on the testtype to publish KVM4NFV test results. The cyclictest cases are executed and results are published on Yardstick Dashboard(Grafana). InfluxDB is the database which will -store the cyclictest results and Grafana is a visualisation suite to view the maximum,minumum and +store the cyclictest results and Grafana is a visualisation suite to view the maximum,minimum and average values of the time series data of cyclictest results.The framework is shown in below image. .. figure:: images/dashboard-architecture.png @@ -98,7 +98,8 @@ Three type of dispatcher methods are available to store the cyclictest results. **1. File**: Default Dispatcher module is file. If the dispatcher module is configured as a file,then the test results are stored in a temporary file yardstick.out ( default path: /tmp/yardstick.out). -Dispatcher module of "Verify Job" is "Default". So,the results are stored in Yardstick.out file for verify job. Storing all the verify jobs in InfluxDB database causes redundancy of latency values. Hence, a File output format is prefered. +Dispatcher module of "Verify Job" is "Default". So,the results are stored in Yardstick.out file for verify job. +Storing all the verify jobs in InfluxDB database causes redundancy of latency values. Hence, a File output format is prefered. .. code:: bash @@ -111,7 +112,8 @@ Dispatcher module of "Verify Job" is "Default". So,the results are stored in Yar max_bytes = 0 backup_count = 0 -**2. Influxdb**: If the dispatcher module is configured as influxdb, then the test results are stored in Influxdb. Users can check test resultsstored in the Influxdb(Database) on Grafana which is used to visualize the time series data. +**2. Influxdb**: If the dispatcher module is configured as influxdb, then the test results are stored in Influxdb. +Users can check test resultsstored in the Influxdb(Database) on Grafana which is used to visualize the time series data. To configure the influxdb, the following content in /etc/yardstick/yardstick.conf need to updated @@ -148,7 +150,8 @@ Dispatcher module of "Daily Job" is Influxdb. So, the results are stored in infl Detailing the dispatcher module in verify and daily Jobs: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -KVM4NFV updates the dispatcher module in the yardstick configuration file(/etc/yardstick/yardstick.conf) depending on the Job type(Verify/Daily). Once the test is completed, results are published to the respective dispatcher modules. +KVM4NFV updates the dispatcher module in the yardstick configuration file(/etc/yardstick/yardstick.conf) depending on the Job type(Verify/Daily). +Once the test is completed, results are published to the respective dispatcher modules. Dispatcher module is configured for each Job type as mentioned below. @@ -198,7 +201,8 @@ Influxdb api which is already implemented in `Influxdb`_ will post the data in l ``Displaying Results on Grafana dashboard:`` -- Once the test results are stored in Influxdb, dashboard configuration file(Json) which used to display the cyclictest results on Grafana need to be created by following the `Grafana-procedure`_ and then pushed into `yardstick-repo`_ +- Once the test results are stored in Influxdb, dashboard configuration file(Json) which used to display the cyclictest results +on Grafana need to be created by following the `Grafana-procedure`_ and then pushed into `yardstick-repo`_ - Grafana can be accessed at `Login`_ using credentials opnfv/opnfv and used for visualizing the collected test data as shown in `Visual`_\ @@ -263,7 +267,8 @@ Note: 1. Idle-Idle Graph ~~~~~~~~~~~~~~~~~~~~ -`Idle-Idle`_ graph displays the Average,Maximum and Minimum latency values obtained by running Idle_Idle test-type of the cyclictest. Idle_Idleimplies that no stress is applied on the Host or the Guest. +`Idle-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running Idle_Idle test-type of the cyclictest. +Idle_Idle implies that no stress is applied on the Host or the Guest. .. _Idle-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=10&fullscreen @@ -274,7 +279,8 @@ Note: 2. CPU_Stress-Idle Graph ~~~~~~~~~~~~~~~~~~~~~~~~~ -`Cpu_Stress-Idle`_ graph displays the Average,Maximum and Minimum latency values obtained by running Idle_Idle test-type of the cyclictest. Idle_Idle implies that CPU stress is applied on the Host and no stress on the Guest. +`Cpu_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running Cpu-stress_Idle test-type of the cyclictest. +Cpu-stress_Idle implies that CPU stress is applied on the Host and no stress on the Guest. .. _Cpu_stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=11&fullscreen @@ -285,7 +291,8 @@ Note: 3. Memory_Stress-Idle Graph ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`Memory_Stress-Idle`_ graph displays the Average,Maximum and Minimum latency values obtained by running Idle_Idle test-type of the Cyclictest. Idle_Idle implies that Memory stress is applied on the Host and no stress on the Guest. +`Memory_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running Memory-stress_Idle test-type of the Cyclictest. +Memory-stress_Idle implies that Memory stress is applied on the Host and no stress on the Guest. .. _Memory_Stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=12&fullscreen @@ -296,7 +303,8 @@ Note: 4. IO_Stress-Idle Graph ~~~~~~~~~~~~~~~~~~~~~~~~~ -`IO_Stress-Idle`_ graph displays the Average,Maximum and Minimum latency values obtained by running Idle_Idle test-type of the Cyclictest. Idle_Idle implies that IO stress is applied on the Host and no stress on the Guest. +`IO_Stress-Idle`_ graph displays the Average, Maximum and Minimum latency values obtained by running IO-stress_Idle test-type of the Cyclictest. +IO-stress_Idle implies that IO stress is applied on the Host and no stress on the Guest. .. _IO_Stress-Idle: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest?panelId=13&fullscreen diff --git a/docs/userguide/low_latency.userguide.rst b/docs/userguide/low_latency.userguide.rst index 88cc0347e..e65c8aa4f 100644 --- a/docs/userguide/low_latency.userguide.rst +++ b/docs/userguide/low_latency.userguide.rst @@ -180,7 +180,7 @@ The host is under constant Input/Output stress .i.e., multiple read-write operat increase stress. Cyclictest will run on the guest VM that is launched on the same host, where the guest is under no stress. It outputs Avg, Min and Max latency values. -.. figure:: images/io-stress-test-type.png +.. figure:: images/io-stress-idle-test-type.png :name: io-stress-idle test type :width: 100% :align: center diff --git a/docs/userguide/packet_forwarding.userguide.rst b/docs/userguide/packet_forwarding.userguide.rst index 594952bdf..22f9b9447 100644 --- a/docs/userguide/packet_forwarding.userguide.rst +++ b/docs/userguide/packet_forwarding.userguide.rst @@ -3,7 +3,7 @@ .. http://creativecommons.org/licenses/by/4.0 ================= -PACKET FORWARDING +Packet Forwarding ================= About Packet Forwarding @@ -30,8 +30,7 @@ Version Features | | - Implements three scenarios (Host/Guest/SRIOV) | | | as part of testing in KVMFORNFV | | Danube | - Uses automated test framework of OPNFV | -| | VSWITCHPERF software (PVP/PVVP) | -| | | +| | VSWITCHPERF software (PVP/PVVP) | | | - Works with IXIA Traffic Generator | +-----------------------------+---------------------------------------------------+ @@ -47,7 +46,7 @@ VNF level testing and validation. For complete VSPERF documentation go to `link.`_ -.. _link.: http://artifacts.opnfv.org/vswitchperf/colorado/index.html +.. _link.: http://artifacts.opnfv.org/vswitchperf/danube/index.html Installation @@ -78,7 +77,7 @@ The vSwitch must support Open Flow 1.3 or greater. Supported Hypervisors ~~~~~~~~~~~~~~~~~~~~~ -* Qemu version 2.3. +* Qemu version 2.6. Other Requirements ~~~~~~~~~~~~~~~~~~ @@ -91,8 +90,7 @@ environment and compilation of OVS, DPDK and QEMU is performed by script **systems/build_base_machine.sh**. It should be executed under user account, which will be used for vsperf execution. - **Please Note:** Password-less sudo access must be configured for given user - before script is executed. + **Please Note:** Password-less sudo access must be configured for given user before script is executed. Execution of installation script: @@ -209,7 +207,7 @@ runs the IXIA client software and a CentOS Linux release 7.1.1503 (Core) host. Installation ~~~~~~~~~~~~ -Follow the [installation instructions] to install. +Follow the installation instructions to install. On the CentOS 7 system ~~~~~~~~~~~~~~~~~~~~~~ @@ -380,12 +378,6 @@ A Kernel Module that provides OSI Layer 2 Ipv4 termination or forwarding with support for Destination Network Address Translation (DNAT) for both the MAC and IP addresses. l2fwd can be found in /src/l2fwd -.. figure:: images/Guest_Scenario.png - :name: Guest_Scenario - :width: 100% - :align: center - - Executing tests ~~~~~~~~~~~~~~~~ @@ -614,7 +606,7 @@ Using QEMU with PCI passthrough support Raw virtual machine throughput performance can be measured by execution of PVP test with direct access to NICs by PCI passthrough. To execute VM with direct -access to PCI devices, enable vfio-pci_. In order to use virtual functions, +access to PCI devices, enable vfio-pci. In order to use virtual functions, SRIOV-support_ must be enabled. Execution of test with PCI passthrough with vswitch disabled: @@ -624,10 +616,8 @@ Execution of test with PCI passthrough with vswitch disabled: $ ./vsperf --conf-file=/10_custom.conf \ --vswitch none --vnf QemuPciPassthrough pvp_tput -Any of supported guest-loopback-application_ can be used inside VM with +Any of supported guest-loopback-application can be used inside VM with PCI passthrough support. Note: Qemu with PCI passthrough support can be used only with PVP test deployment. - -.. _guest-loopback-application: diff --git a/docs/userguide/pcm_utility.userguide.rst b/docs/userguide/pcm_utility.userguide.rst index c8eb21d61..1ae68516c 100644 --- a/docs/userguide/pcm_utility.userguide.rst +++ b/docs/userguide/pcm_utility.userguide.rst @@ -80,10 +80,10 @@ Parameters | Mem Ch 3: Reads (MB/s): 6867.47 | Mem Ch 3: Reads (MB/s): 7403.66 | | Writes(MB/s): 1805.53 | Writes(MB/s): 1950.95 | | | | -| NODE0 Mem Read (MB/s): 27478.96 | NODE1 Mem Read (MB/s): 29624.51 | +| NODE0 Mem Read (MB/s) : 27478.96 | NODE1 Mem Read (MB/s) : 29624.51 | | NODE0 Mem Write (MB/s): 7225.79 | NODE1 Mem Write (MB/s): 7811.36 | -| NODE0 P. Write (T/s) : 214810 | NODE1 P. Write (T/s): 238294 | -| NODE0 Memory (MB/s): 34704.75 | NODE1 Memory (MB/s): 37435.87 | +| NODE0 P. Write (T/s) : 214810 | NODE1 P. Write (T/s) : 238294 | +| NODE0 Memory (MB/s) : 34704.75 | NODE1 Memory (MB/s) : 37435.87 | +---------------------------------------+---------------------------------------+ | - System Read Throughput(MB/s): 57103.47 | | - System Write Throughput(MB/s): 15037.15 | @@ -121,9 +121,9 @@ In install_Pcm function, it handles the installation of pcm utility and the requ .. code:: bash - git clone https://github.com/opcm/pcm - cd pcm - make + $ git clone https://github.com/opcm/pcm + $ cd pcm + $ make In collect_MBWInfo Function,the below command is executed on the node which was collected to the logs with the timestamp and testType.The function will be called at the begining of each testcase and @@ -131,7 +131,7 @@ signal will be passed to terminate the pcm-memory process which was executing th .. code:: bash - pcm-memory.x 60 &>/root/MBWInfo/MBWInfo_${testType}_${timeStamp} + $ pcm-memory.x 60 &>/root/MBWInfo/MBWInfo_${testType}_${timeStamp} where, ${testType} = verify (or) daily -- 2.16.6