diff options
32 files changed, 365 insertions, 227 deletions
diff --git a/docs/configurationguide/configuration.options.render.rst b/docs/configurationguide/configuration.options.render.rst index 64e0556ea..71a78af2b 100644 --- a/docs/configurationguide/configuration.options.render.rst +++ b/docs/configurationguide/configuration.options.render.rst @@ -12,12 +12,15 @@ problems for the deployment of VNF's. KVM4NFV scenario includes components such as OpenStack,KVM etc. which includes different source components or configurations. -KVM4NFV Scenarios ------------------- +.. note:: -Each KVM4NFV scenario provides unique features and capabilities, it is -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. + * Each KVM4NFV `scenario`_ provides unique features and capabilities, it is + important to understand your target platform capabilities before installing + and configuring. This configuration guide outlines how to configure components + in order to enable the features required. -#.. include:: ./scenariomatrix.rst + * More deatils of kvm4nfv scenarios installation and description can be found in the `scenario guide`_ of kvm4nfv docs + +.. _scenario: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description + +.. _scenario guide: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/abstract diff --git a/docs/configurationguide/index.rst b/docs/configurationguide/index.rst index b4cb69839..fa205f55a 100644 --- a/docs/configurationguide/index.rst +++ b/docs/configurationguide/index.rst @@ -1,9 +1,12 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -************************* -OPNFV Configuration Guide -************************* +.. _kvmfornfv-configguide: + +*************************** +Kvm4nfv Configuration Guide +*************************** + Danube 1.0 ------------ diff --git a/docs/configurationguide/low-latency.feature.configuration.description.rst b/docs/configurationguide/low-latency.feature.configuration.description.rst index 6cad4c9ce..c53aa52f4 100644 --- a/docs/configurationguide/low-latency.feature.configuration.description.rst +++ b/docs/configurationguide/low-latency.feature.configuration.description.rst @@ -141,11 +141,9 @@ configurations. Hardware configuration ~~~~~~~~~~~~~~~~~~~~~~ -Currently Intel POD10 is used as test environment for kvmfornfv to execute +Currently Intel POD10 is used as test environment for kvm4nfv 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. * For more information regarding hardware configuration, please visit https://wiki.opnfv.org/display/pharos/Intel+Pod10 diff --git a/docs/design/index.rst b/docs/design/index.rst index 871f17388..63fd75ff6 100755 --- a/docs/design/index.rst +++ b/docs/design/index.rst @@ -1,8 +1,10 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-design: + ================ -KVMFORNFV Design +KVM4NFV Design ================ .. toctree:: diff --git a/docs/design/kvmfornfv_design.rst b/docs/design/kvmfornfv_design.rst index 2465d63e3..765f41219 100644 --- a/docs/design/kvmfornfv_design.rst +++ b/docs/design/kvmfornfv_design.rst @@ -1,24 +1,9 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -============ -Introduction -============ - -**Purpose**: - - This document provides an overview of the areas that can be addressed to - enhance the KVM Hypervisor for NFV. It is intended to capture and convey the - significant changes which have been made on the KVM Hypervisor. - - -=================== -Project description -=================== - -The NFV hypervisors provide crucial functionality in the NFV -Infrastructure(NFVI).The existing hypervisors, however, are not necessarily -designed or targeted to meet the requirements for the NFVI. +========================== +KVM4NFV design description +========================== This design focuses on the enhancement of following area for KVM Hypervisor @@ -27,10 +12,6 @@ This design focuses on the enhancement of following area for KVM Hypervisor * Minimal packet latency variation for data-plane VNFs * Fast live migration -While these items require software development and/or specific hardware features -there are also some adjustments that need to be made to system configuration -information, like hardware, BIOS, OS, etc. - **Minimal Interrupt latency variation for data plane VNFs** Processing performance and latency depend on a number of factors, including @@ -131,7 +112,7 @@ interrupt handled in the VNF. .. Figure:: DeviceInterruptTest.png -**Packet forwarding (DPDK OVS)**:A packet is sent from TC (Traffic Generator) +**Packet forwarding (DPDK OVS)**:A packet is sent from TG (Traffic Generator) to a VNF. The VNF, after processing the packet, forwards the packet to another NIC and in the end the packet is received by the traffic generator. The test check the latency from the packet is sent out by the TC to the time the packet diff --git a/docs/index.rst b/docs/index.rst index a549e6fdf..d39236bdc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-documentation: + ****************** Danube 1.0 Release ****************** @@ -16,9 +18,9 @@ Overview of Documentation ./overview/kvmfornfv_overview.rst -******************************** -KVMFORNFV Installation Procedure -******************************** +****************************** +KVM4NFV Installation Procedure +****************************** .. toctree:: :caption: Installation Procedure @@ -29,9 +31,9 @@ KVMFORNFV Installation Procedure ./installationprocedure/kvm4nfv-cicd.installation.instruction.rst ./installationprocedure/kvm4nfv-cicd.release.notes.rst -********************** -KVMFORNFV Design Guide -********************** +******************** +KVM4NFV Design Guide +******************** .. toctree:: :caption: Design Overview and Description @@ -40,9 +42,9 @@ KVMFORNFV Design Guide ./design/kvmfornfv_design.rst -**************************** -KVMFORNFV Requirements Guide -**************************** +************************** +KVM4NFV Requirements Guide +************************** .. toctree:: :caption: Requirements @@ -51,9 +53,9 @@ KVMFORNFV Requirements Guide ./requirements/kvmfornfv_requirements.rst -***************************** -KVMFORNFV Configuration Guide -***************************** +*************************** +KVM4NFV Configuration Guide +*************************** .. toctree:: :caption: Configuration Guide @@ -65,9 +67,9 @@ KVMFORNFV Configuration Guide ./configurationguide/scenariomatrix.rst ./configurationguide/low-latency.feature.configuration.description.rst -******************************************** -KVMFORNFV Scenarios Overview and Description -******************************************** +****************************************** +KVM4NFV Scenarios Overview and Description +****************************************** .. toctree:: :caption: Scenario Overview and Description @@ -121,9 +123,9 @@ os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Overview and Description ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst -******************** -KVMFORNFV User Guide -******************** +****************** +KVM4NFV User Guide +****************** .. toctree:: :caption: User Guide @@ -143,9 +145,9 @@ KVMFORNFV User Guide ./userguide/pcm_utility.userguide.rst ./userguide/tuning.userguide.rst -********************** -KVMFORNFV Releasenotes -********************** +******************** +KVM4NFV Releasenotes +******************** .. toctree:: :caption: Releasenotes @@ -154,9 +156,9 @@ KVMFORNFV Releasenotes ./releasenotes/release-notes.rst -****************** -KVMFORNFV Glossary -****************** +**************** +KVM4NFV Glossary +**************** .. toctree:: :caption: Glossary diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst index 853db170e..a53450eff 100644 --- a/docs/installationprocedure/abstract.rst +++ b/docs/installationprocedure/abstract.rst @@ -6,6 +6,6 @@ Abstract ******** -This document will give the user instructions on how to deploy available -KVM4NFV CICD build scenario verfied for the Danube release of the OPNFV +This document will give the instructions to user on how to deploy available +KVM4NFV build scenario verfied for the Danube release of the OPNFV platform. diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst index 4f9fa6949..9d75307f4 100644 --- a/docs/installationprocedure/index.rst +++ b/docs/installationprocedure/index.rst @@ -2,9 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 -********************************** -KVMforNFV Installation instruction -********************************** +.. _kvmfornfv-installation: + +******************************** +KVM4NFV Installation instruction +******************************** .. toctree:: :numbered: diff --git a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst index ef6d32fc9..dedcca34f 100644 --- a/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst +++ b/docs/installationprocedure/kvm4nfv-cicd.installation.instruction.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 -===================================== -KVM4NFV CICD Installation Instruction -===================================== +================================ +KVM4NFV Installation Instruction +================================ Preparing the installation -------------------------- @@ -17,7 +17,7 @@ HW requirements --------------- These build scripts are triggered on the Jenkins-Slave build server. Currently -Intel POD10 is used as test environment for kvmfornfv to execute cyclictest. As +Intel POD10 is used as test environment for kvm4nfv 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 @@ -67,6 +67,21 @@ the Rpms (on 'centos') and Debians (on 'ubuntu') builds in this case. For Kernel/Qemu RPMs and Debians, sh ./ci/build.sh -p both -o build_output +.. note:: Kvm4nfv can be installed in two ways + + 1. As part of a `scenario deployment`_ + 2. As a `stand alone`_ component + +.. _scenario deployment: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description +.. _stand alone: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#build-instructions + +For installation of kvmfornfv as part of scenario deployment use this `link`_ + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv/docs/index.html#document-scenarios/kvmfornfv.scenarios.description + + Installation instructions ------------------------- diff --git a/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst b/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst index 1913be8d7..415182bc7 100644 --- a/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst +++ b/docs/installationprocedure/kvm4nfv-cicd.release.notes.rst @@ -8,12 +8,12 @@ Release Note for KVM4NFV CICD Abstract -======== +-------- This document contains the release notes for the Danube release of OPNFV when using KVM4NFV CICD process. Introduction -============ +------------ Provide a brief introduction of how this configuration is used in OPNFV release using KVM4VFV CICD as scenario. @@ -21,7 +21,7 @@ using KVM4VFV CICD as scenario. Be sure to reference your scenario installation instruction. Release Data -============ +------------ +--------------------------------------+--------------------------------------+ | **Project** | NFV Hypervisors-KVM | @@ -33,39 +33,19 @@ Release Data | **Release designation** | | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | | +| **Release date** | 2017-03-27 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Automate the KVM4VFV CICD scenario | +| **Purpose of the delivery** | - Automate the KVM4VFV CICD scenario | +| | - Executing latency test cases | +| | - Collection of logs for debugging | | | | +--------------------------------------+--------------------------------------+ -Deliverables ------------- - -Software deliverables -~~~~~~~~~~~~~~~~~~~~~ -Kernel and Qemu- RPM and Debian build packages - -Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~ -- KVM4NFV CICD process documentation available under <project>/docs/ under - various categories. - -Version change --------------- -.. This section describes the changes made since the last version of this -.. document. - -Module version change -~~~~~~~~~~~~~~~~~~~~~ -- Build scripts made available for Kernel rpm, Kernel deb, Qemu rpm, Qemu - deb packages. -- Releng scripts made available to trigger these kvm4nfv build scripts for - automating complete CICD process. Document version change -~~~~~~~~~~~~~~~~~~~~~~~ +----------------------- + The following documents are added- - configurationguide - installationprocedure @@ -100,26 +80,6 @@ Feature additions | | | +--------------------------------------+--------------------------------------+ -Bug corrections -~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| JIRA: | | -| | | -+--------------------------------------+--------------------------------------+ - - -Known Limitations, Issues and Workarounds -========================================= - -System Limitations ------------------- - Known issues ------------ @@ -131,9 +91,6 @@ Known issues +--------------------------------------+--------------------------------------+ | JIRA: | NFV Hypervisors-KVMFORNFV-75 | +--------------------------------------+--------------------------------------+ -| JIRA: | | -+--------------------------------------+--------------------------------------+ - Workarounds ----------- diff --git a/docs/overview/kvmfornfv_overview.rst b/docs/overview/kvmfornfv_overview.rst index a298876e5..7c3005a04 100644 --- a/docs/overview/kvmfornfv_overview.rst +++ b/docs/overview/kvmfornfv_overview.rst @@ -2,26 +2,47 @@ .. http://creativecommons.org/licenses/by/4.0 -=============================== -KVMFORNFV CICD Project Overview -=============================== +======================== +KVM4NFV Project Overview +======================== + +Project Purpose +--------------- +**Purpose:** + + ``This document provides an overview of the areas that can be addressed to + enhance the KVM Hypervisor for NFV. It is intended to capture and convey the + significant changes which have been made on the KVM Hypervisor.`` + +Project Description +------------------- +The NFV hypervisors provide crucial functionality in the NFV +Infrastructure(NFVI).The existing hypervisors, however, are not necessarily +designed or targeted to meet the requirements for the NFVI. + +This design focuses on the enhancement of following area for KVM Hypervisor + +* Minimal Interrupt latency variation for data plane VNFs: + * Minimal Timing Variation for Timing correctness of real-time VNFs + * Minimal packet latency variation for data-plane VNFs +* Fast live migration 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. * **installation procedure** - This will give the user instructions on how to deploy - available KVM4NFV CICD build scenario. + available KVM4NFV build scenario. +* **design** - This includes the parameters or design considerations taken into + account for achieving minimal interrupt latency for the data VNFs. +* **requirements** - This includes the introduction of KVM4NFV project, + specifications of how the project should work, and constraints placed upon + its execution. * **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, - specifications of how the project should work, and constraints placed upon - its execution. -* **design** - This includes the parameters or design considerations taken into - 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. + kvm4nfv project,features of each scenario and a general guide to how to deploy them. +* **userguide** - This provides the required technical assistance to the user, in + using the KVM4NFV process. * **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/index.rst b/docs/releasenotes/index.rst index 4460b9a01..3cf19f32f 100644 --- a/docs/releasenotes/index.rst +++ b/docs/releasenotes/index.rst @@ -1,9 +1,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -=========================================== -KVMFORNFV Release Notes for Danube Release -=========================================== +.. _kvmfornfv-releasenotes: + +======================================== +KVM4NFV Release Notes for Danube Release +======================================== .. toctree:: :maxdepth: 2 diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst index 9f20855fc..c52b4b839 100644 --- a/docs/releasenotes/release-notes.rst +++ b/docs/releasenotes/release-notes.rst @@ -10,7 +10,7 @@ Release Notes Abstract --------- -This document provides the release notes for Danube 1.0 release of KVMFORNFV. +This document provides the release notes for Danube 1.0 release of KVM4NFV. **Contents** @@ -42,12 +42,12 @@ Version history Important notes --------------- -The KVMFORNFV project is currently supported on the Fuel installer. +The KVM4NFV project is currently supported on the Fuel installer. Summary ------- -This Danube 1.0 release provides *KVMFORNFV* as a framework to enhance the +This Danube 1.0 release provides *KVM4NFV* as a framework to enhance the KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV CI pipeline, including: @@ -69,12 +69,16 @@ CI pipeline, including: * Installation Procedure - * Release notes (this document) + * Release notes - * Scenarios + * Scenarios Guide + + * Design Guide -The *KVMFORNFV framework* is developed in the OPNFV community, by the -KVMFORNFV_ team. + * Requirements Guide + +The *KVM4NFV framework* is developed in the OPNFV community, by the +KVM4NFV_ team. Release Data ------------ @@ -111,12 +115,12 @@ versions: * Fuel plugin based on Fuel 10.0 -This is the second tracked release of KVMFORNFV +This is the second tracked release of KVM4NFV 2 Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the initial version of the KVMFORNFV framework in OPNFV. +This is the second version of the KVM4NFV framework in OPNFV. Reason for version ------------------ @@ -153,22 +157,102 @@ Reason for version | | | +--------------------------------------+--------------------------------------+ -2 Bug corrections -~~~~~~~~~~~~~~~~~ - -Initial Release +A brief ``Description of the the JIRA tickets``: + ++---------------------------------------+-------------------------------------------------------------+ +| **JIRA REFERENCE** | **DESCRIPTION** | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-57 | CI/CD Integration into Yardstick | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-58 | Complete the integration of test plan into Yardstick | +| | and Jenkins infrastructure to include latency testing | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-59 | Enable capability to publish results on Yardstick Dashboard | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-61 | Define and integrate additional scenario - KVM+OVS+DPDK | +| | with HA and NOHA for baremetal and virtual environments | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-62 | Define and integrate additional scenario - KVM+OVS+DPDK+BAR | +| | with HA and NOHA for bare metal and virtual environments | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-63 | Setup Local fuel environment | +| | | ++---------------------------------------+-------------------------------------------------------------+ +| KVMFORNFV-64 | Fuel environment setup for local machine to debug Fuel | +| | related integration issues | ++---------------------------------------+-------------------------------------------------------------+ Deliverables ------------ 1 Software deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~ -Danube 1.0 release of the KVMFORNFV RPM and debian for Fuel. +* Danube 1.0 release of the KVM4NFV RPM and debian for kvm4nfv + +* Added the following scenarios as part of D-Release: + + * os-nosdn-kvm_nfv_ovs_dpdk-noha + + * os-nosdn-kvm_nfv_ovs_dpdk_bar-noha + + * os-nosdn-kvm_nfv_ovs_dpdk-ha + + * os-nosdn-kvm_nfv_ovs_dpdk_bar-ha + +* Configured influxdb and `Graphana dashboard`_ for publishing kvm4nfv test results + +.. _Graphana_dashboard: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest + +* Cyclictest test case is successfully implemented, it has the below test types., + + * idle-idle + + * CPUstress-idle -2 Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * IOstress-idle -The below documents are delivered for Danube KVMFORNFV Release: + * Memorystress-idle + +* Implemented Noisy Neighbour feature ., cyclictest under stress testing is implemented + +* Packet forwarding test case is implemented and it supports the following test types currently, + + * Packet forwarding to Host + + * Packet forwarding to Guest + + * Packet forwarding to Guest using SRIOV + +* Ftrace debugging tool is supported in D-Release. The logs collected by ftrace are stored in artifacts for future needs + +* PCM Utility is part of D-Release. The future scope may include collection of read/write data and publishing in grafana + +* Either Apex or Fuel can be used for deployment of os-nosdn-kvm-ha scenario + ++------------------------------------------+------------------+-----------------+ +| **Scenario Name** | **Apex** | **Fuel** | +| | | | ++==========================================+==================+=================+ +| - 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`` | ++------------------------------------------+------------------+-----------------+ + +* Future scope may include adding Apex support for all the remaining scenarios + +* The below documents are delivered for Danube KVM4NFV Release: * User Guide @@ -178,15 +262,19 @@ The below documents are delivered for Danube KVMFORNFV Release: * Overview - * Release notes (this document) + * Release notes * Glossary * Scenarios + * Requirements Guide + + * Overview Guide + References ---------- -For more information on the KVMFORNFV Danube release, please see: +For more information on the KVM4NFV Danube release, please see: https://wiki.opnfv.org/display/kvm/ diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst index 42dba0422..7e6fbacf3 100755 --- a/docs/requirements/index.rst +++ b/docs/requirements/index.rst @@ -1,9 +1,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -================ -KVMFORNFV Design -================ +.. _kvmfornfv-requirements: + +==================== +KVM4NFV Requirements +==================== .. toctree:: :numbered: diff --git a/docs/requirements/kvmfornfv_requirements.rst b/docs/requirements/kvmfornfv_requirements.rst index 1eaf592a5..6a879d2a1 100644 --- a/docs/requirements/kvmfornfv_requirements.rst +++ b/docs/requirements/kvmfornfv_requirements.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Intel Corporation, AT&T and others. -====================== -Kvmfornfv Requirements -====================== +==================== +Kvm4nfv Requirements +==================== Introduction ------------ diff --git a/docs/scenarios/.kvmfornfv.scenarios.description.rst.swp b/docs/scenarios/.kvmfornfv.scenarios.description.rst.swp Binary files differnew file mode 100644 index 000000000..b6ef17624 --- /dev/null +++ b/docs/scenarios/.kvmfornfv.scenarios.description.rst.swp diff --git a/docs/scenarios/abstract.rst b/docs/scenarios/abstract.rst index 1480f778d..dcdd62fa9 100644 --- a/docs/scenarios/abstract.rst +++ b/docs/scenarios/abstract.rst @@ -5,7 +5,7 @@ Scenario Abstract ***************** This chapter includes detailed explanation of various sceanrios files deployed as part -of kvmfornfv D-Release. +of kvm4nfv D-Release. Release Features ---------------- diff --git a/docs/scenarios/index.rst b/docs/scenarios/index.rst index 6c3ed1dea..f1f93c31a 100644 --- a/docs/scenarios/index.rst +++ b/docs/scenarios/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-scenarios: + ********************************* Scenario Overview and Description ********************************* diff --git a/docs/scenarios/kvmfornfv.scenarios.description.rst b/docs/scenarios/kvmfornfv.scenarios.description.rst index c7715b252..5a5328666 100644 --- a/docs/scenarios/kvmfornfv.scenarios.description.rst +++ b/docs/scenarios/kvmfornfv.scenarios.description.rst @@ -2,9 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 -============================== -KVMFORNFV Scenario-Description -============================== +.. _scenario-guide: + +============================ +KVM4NFV Scenario-Description +============================ Abstract -------- @@ -22,11 +24,11 @@ Version Features | | | +=============================+=============================================+ | | - Scenario Testing feature was not part of | -| Colorado | the Colorado release of KVMFORNFV | +| Colorado | the Colorado release of KVM4NFV | | | | +-----------------------------+---------------------------------------------+ | | - High Availability/No-High Availability | -| | deployment configuration of KVMFORNFV | +| | deployment configuration of KVM4NFV | | | software suite | | Danube | - Multi-node setup with 3 controller and | | | 2 compute nodes are deployed for HA | @@ -47,7 +49,7 @@ os-nosdn-kvm_ovs_dpdk-noha,os-nosdn-kvm_ovs_dpdk_bar-noha scenarios testing is t test the High Availability/No-High Availability deployment and configuration of OPNFV software suite with OpenStack and without SDN software. -This OPNFV software suite includes OPNFV KVMFORNFV latest software packages +This OPNFV software suite includes OPNFV KVM4NFV latest software packages for Linux Kernel and QEMU patches for achieving low latency and also OPNFV Barometer for traffic, performance and platform monitoring. @@ -57,7 +59,7 @@ multi-node setup with 1 Fuel-Master,3 controllers and 2 computes nodes. No-High Availability feature is achieved by deploying OpenStack 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. +KVM4NFV packages will be installed on compute nodes as part of deployment. The scenario testcase deploys a multi-node setup by using OPNFV Fuel deployer. System pre-requisites diff --git a/docs/scenarios/os-nosdn-kvm-ha/index.rst b/docs/scenarios/os-nosdn-kvm-ha/index.rst index a4d28a24c..ab82d96b8 100755 --- a/docs/scenarios/os-nosdn-kvm-ha/index.rst +++ b/docs/scenarios/os-nosdn-kvm-ha/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-os-nosdn-kvm-ha: + **************************************** os-nosdn-kvm-ha Overview and Description **************************************** diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst index 28f588e54..ddb6071c8 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-ha: + ***************************************************** os-nosdn-kvm_nfv_ovs_dpdk-ha Overview and Description ***************************************************** diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst index 3a52fe426..742ddb1ee 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-noha: + ******************************************************* os-nosdn-kvm_nfv_ovs_dpdk-noha Overview and Description ******************************************************* diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst index 0e374a5ca..a8192edcc 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk_bar-ha: + ********************************************************* os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Overview and Description ********************************************************* diff --git a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst index 756b2ba6a..3a07e98c9 100755 --- a/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst +++ b/docs/scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/index.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk_bar-noha: + *********************************************************** os-nosdn-kvm_nfv_ovs_dpdk_bar-noha Overview and Description *********************************************************** diff --git a/docs/userguide/Ftrace.debugging.tool.userguide.rst b/docs/userguide/Ftrace.debugging.tool.userguide.rst index fc0858a6d..95b7f8fe5 100644 --- a/docs/userguide/Ftrace.debugging.tool.userguide.rst +++ b/docs/userguide/Ftrace.debugging.tool.userguide.rst @@ -16,7 +16,7 @@ work of several assorted tracing utilities. One of the most common uses of ftrace is the event tracing. **Note:** -- For KVMFORNFV, Ftrace is preferred as it is in-built kernel tool +- For KVM4NFV, Ftrace is preferred as it is in-built kernel tool - More stable compared to other debugging tools Version Features @@ -28,10 +28,10 @@ Version Features | | | +=============================+===============================================+ | | - Ftrace Debugging tool is not implemented in | -| Colorado | Colorado release of KVMFORNFV | +| Colorado | Colorado release of KVM4NFV | | | | +-----------------------------+-----------------------------------------------+ -| | - Ftrace aids in debugging the KVMFORNFV | +| | - Ftrace aids in debugging the KVM4NFV | | Danube | 4.4-linux-kernel level issues | | | - Option to disable if not required | +-----------------------------+-----------------------------------------------+ @@ -155,31 +155,36 @@ Examples: [tracing]# echo 1 > tracing_on; -Ftrace in KVMFORNFV -------------------- -Ftrace is part of KVMFORNFV D-Release. KVMFORNFV built 4.4-linux-Kernel will be tested by +Ftrace in KVM4NFV +----------------- +Ftrace is part of KVM4NFV D-Release. KVM4NFV built 4.4-linux-Kernel will be tested by executing cyclictest and analyzing the results/latency values (max, min, avg) generated. -Ftrace (or) function tracer is a stable kernel inbuilt debugging tool which tests kernel in real -time and outputs a log as part of the code. These output logs are useful in following ways. +Ftrace (or) function tracer is a stable kernel inbuilt debugging tool which tests real time +kernel and outputs a log as part of the code. These output logs are useful in following ways. - Kernel Debugging. - Helps in Kernel code optimization and - Can be used to better understand the kernel level code flow -Ftrace logs for KVMFORNFV can be found `here`_: +Ftrace logs for KVM4NFV can be found `here`_: .. _here: http://artifacts.opnfv.org/kvmfornfv.html -Ftrace Usage in KVMFORNFV Kernel Debugging: -------------------------------------------- -Kvmfornfv has two scripts in /ci/envs to provide ftrace tool: +Ftrace Usage in KVM4NFV Kernel Debugging: +----------------------------------------- +Kvm4nfv has two scripts in /ci/envs to provide ftrace tool: - enable_trace.sh - disable_trace.sh -Enabling Ftrace in KVMFORNFV ----------------------------- +.. code:: bash + + Found at., + $ cd kvmfornfv/ci/envs + +Enabling Ftrace in KVM4NFV +-------------------------- The enable_trace.sh script is triggered by changing ftrace_enable value in test_kvmfornfv.sh script to 1 (which is zero by default). Change as below to enable Ftrace. @@ -241,7 +246,7 @@ In disable trace script the following are done: Publishing Ftrace logs: ----------------------- The generated trace log is pushed to `artifacts`_ by kvmfornfv-upload-artifact.sh -script available in releng which will be triggered as a part of kvmfornfv daily job. +script available in releng which will be triggered as a part of kvm4nfv daily job. The `trigger`_ in the script is., .. code:: bash diff --git a/docs/userguide/feature.userguide.render.rst b/docs/userguide/feature.userguide.render.rst index 0e2738ae3..3bed21fc9 100644 --- a/docs/userguide/feature.userguide.render.rst +++ b/docs/userguide/feature.userguide.render.rst @@ -7,7 +7,7 @@ Using Danube Features ========================== The following sections of the user guide provide feature specific usage -guidelines and references for KVM4NFV CICD project. +guidelines and references for KVM4NFV project. * <project>/docs/userguide/low_latency.userguide.rst * <project>/docs/userguide/live_migration.userguide.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 0d5089e01..ff6898746 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -2,9 +2,11 @@ .. http://creativecommons.org/licenses/by/4.0 -******************** -KVMforNFV User Guide -******************** +.. _kvmfornfv-userguide: + +****************** +KVM4NFV User Guide +****************** .. toctree:: :maxdepth: 3 diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst index 9a22bdebd..d4ee81143 100644 --- a/docs/userguide/introduction.rst +++ b/docs/userguide/introduction.rst @@ -11,7 +11,7 @@ Overview The project "NFV Hypervisors-KVM" makes collaborative efforts to enable NFV features for existing hypervisors, which are not necessarily designed or -targeted to meet the requirements for the NFVI.The KVM4NFV CICD scenario +targeted to meet the requirements for the NFVI.The KVM4NFV scenario consists of Continuous Integration builds, deployments and testing combinations of virtual infrastructure components. @@ -51,6 +51,38 @@ install and configure them. General usage guidelines ------------------------ -The user guide for KVM4NFV CICD features and capabilities provide step by step +The user guide for KVM4NFV features and capabilities provide step by step instructions for using features that have been configured according to the installation and configuration instructions. + +Scenarios User Guide +-------------------- + +The procedure to deploy/test `KVM4NFV scenarios`_ in a nested virtualization +or on bare-metal environment is mentioned in the below link. The kvm4nfv user guide can +be found at docs/scenarios + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description + +.. _KVM4NFV scenarios: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description + +The deployment has been verified for `os-nosdn-kvm-ha`_, os-nosdn-kvm-noha, `os-nosdn-kvm_ovs_dpdk-ha`_, +`os-nosdn-kvm_ovs_dpdk-noha`_ and `os-nosdn-kvm_ovs_dpdk_bar-ha`_, `os-nosdn-kvm_ovs_dpdk_bar-noha`_ test scenarios. + +For brief view of the above scenarios use: + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv/docs/index.html#scenario-abstract + +.. _os-nosdn-kvm-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#kvmfornfv-scenarios-overview-and-description + +.. _os-nosdn-kvm_ovs_dpdk-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk-ha-overview-and-description + +.. _os-nosdn-kvm_ovs_dpdk-noha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk-noha-overview-and-description + +.. _os-nosdn-kvm_ovs_dpdk_bar-ha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk_bar-ha-overview-and-description + +.. _os-nosdn-kvm_ovs_dpdk_bar-noha: http://artifacts.opnfv.org/kvmfornfv/docs/index.html#os-nosdn-kvm-nfv-ovs-dpdk_bar-noha-overview-and-description diff --git a/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst b/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst index e7a516bff..468f471e7 100644 --- a/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst +++ b/docs/userguide/kvmfornfv.cyclictest-dashboard.userguide.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 -========================= -KVMFORNFV Dashboard Guide -========================= +======================= +KVM4NFV Dashboard Guide +======================= Dashboard for KVM4NFV Daily Test Results ---------------------------------------- @@ -48,11 +48,11 @@ Version Features Installation Steps: ------------------- -To configure Yardstick, InfluxDB and Grafana for KVMFORNFV project following sequence of steps are followed: +To configure Yardstick, InfluxDB and Grafana for KVM4NFV project following sequence of steps are followed: **Note:** -All the below steps are done as per the script, which is a part of CICD integration. +All the below steps are done as per the script, which is a part of CICD integration of kvmfornfv. .. code:: bash @@ -229,10 +229,10 @@ on Grafana need to be created by following the `Grafana-procedure`_ and then pus .. _GrafanaDoc: http://docs.grafana.org/ -Understanding Kvmfornfv Grafana Dashboard ------------------------------------------- +Understanding Kvm4nfv Grafana Dashboard +--------------------------------------- -The Kvmfornfv dashboard found at http://testresults.opnfv.org/ currently supports graphical view of cyclictest. For viewing Kvmfornfv dashboarduse, +The Kvm4nfv dashboard found at http://testresults.opnfv.org/ currently supports graphical view of cyclictest. For viewing Kvm4nfv dashboarduse, .. code:: bash diff --git a/docs/userguide/low_latency.userguide.rst b/docs/userguide/low_latency.userguide.rst index e65c8aa4f..f027b4939 100644 --- a/docs/userguide/low_latency.userguide.rst +++ b/docs/userguide/low_latency.userguide.rst @@ -73,7 +73,7 @@ more explanation. Test cases to measure Latency ----------------------------- -The performance of the kvmfornfv is assesed by the latency values. Cyclictest and Packet forwarding +The performance of the kvm4nfv is assesed by the latency values. Cyclictest and Packet forwarding Test cases result in real time latency values of average, minimum and maximum. * Cyclictest @@ -83,7 +83,7 @@ Test cases result in real time latency values of average, minimum and maximum. 1. Cyclictest case ------------------- Cyclictest results are the most frequently cited real-time Linux metric. The core concept of Cyclictest is very simple. -In KVMFORNFV cyclictest is implemented on the Guest-VM with 4.4-Kernel RPM installed. It generated Max,Min and Avg +In KVM4NFV cyclictest is implemented on the Guest-VM with 4.4-Kernel RPM installed. It generated Max,Min and Avg values which help in assesing the kernel used. Cyclictest in currently divided into the following test types, * Idle-Idle @@ -132,20 +132,19 @@ Version Features | | | | +-----------------------+------------------+-----------------+ | - Idle - Idle | ``Y`` | ``Y`` | -| | | | ++-----------------------+------------------+-----------------+ | - Cpustress - Idle | | ``Y`` | -| | | | ++-----------------------+------------------+-----------------+ | - Memorystress - Idle | | ``Y`` | -| | | | ++-----------------------+------------------+-----------------+ | - IOstress - Idle | | ``Y`` | -| | | | +-----------------------+------------------+-----------------+ Idle-Idle test-type ~~~~~~~~~~~~~~~~~~~ Cyclictest in run on the Guest VM when Host,Guest are not under any kind of stress. This is the basic -cyclictest of the KVMFORNFV project. Outputs Avg, Min and Max latency values. +cyclictest of the KVM4NFV project. Outputs Avg, Min and Max latency values. .. figure:: images/idle-idle-test-type.png :name: idle-idle test type @@ -199,10 +198,10 @@ Not implemented for Danube release. 2. Packet Forwarding Test cases ------------------------------- -Packet forwarding is an other test case of Kvmfornfv. It measures the time taken by a packet to return +Packet forwarding is an other test case of Kvm4nfv. It measures the time taken by a packet to return to source after reaching its destination. This test case uses automated test-framework provided by -OPNFV VSWITCHPERF project and a traffic generator (IXIA is used for kvmfornfv). Only latency results -generating test cases are triggered as a part of kvmfornfv daily job. +OPNFV VSWITCHPERF project and a traffic generator (IXIA is used for kvm4nfv). Only latency results +generating test cases are triggered as a part of kvm4nfv daily job. Latency test measures the time required for a frame to travel from the originating device through the network to the destination device. Please note that RFC2544 Latency measurement will be superseded with diff --git a/docs/userguide/packet_forwarding.userguide.rst b/docs/userguide/packet_forwarding.userguide.rst index 22f9b9447..31341a908 100644 --- a/docs/userguide/packet_forwarding.userguide.rst +++ b/docs/userguide/packet_forwarding.userguide.rst @@ -9,7 +9,7 @@ Packet Forwarding About Packet Forwarding ----------------------- -Packet Forwarding is a test suite of KVMFORNFV. These latency tests measures the time taken by a +Packet Forwarding is a test suite of KVM4NFV. These latency tests measures the time taken by a **Packet** generated by the traffic generator to travel from the originating device through the network to the destination device. Packet Forwarding is implemented using test framework implemented by OPNFV VSWITCHPERF project and an ``IXIA Traffic Generator``. @@ -23,12 +23,12 @@ Version Features | | | +=============================+===================================================+ | | - Packet Forwarding is not part of Colorado | -| Colorado | release of KVMFORNFV | +| Colorado | release of KVM4NFV | | | | +-----------------------------+---------------------------------------------------+ -| | - Packet Forwarding is a testcase in KVMFORNFV | +| | - Packet Forwarding is a testcase in KVM4NFV | | | - Implements three scenarios (Host/Guest/SRIOV) | -| | as part of testing in KVMFORNFV | +| | as part of testing in KVM4NFV | | Danube | - Uses automated test framework of OPNFV | | | VSWITCHPERF software (PVP/PVVP) | | | - Works with IXIA Traffic Generator | @@ -480,7 +480,7 @@ Example of execution of VSPERF in "trafficgen" mode: Packet Forwarding Test Scenarios -------------------------------- -KVMFORNFV currently implements three scenarios as part of testing: +KVM4NFV currently implements three scenarios as part of testing: * Host Scenario * Guest Scenario. @@ -621,3 +621,13 @@ PCI passthrough support. Note: Qemu with PCI passthrough support can be used only with PVP test deployment. + +Results +~~~~~~~ + +The results for the packet forwarding test cases are uploaded to artifacts. +The link for the same can be found below + +.. code:: bash + + http://artifacts.opnfv.org/kvmfornfv.html diff --git a/docs/userguide/pcm_utility.userguide.rst b/docs/userguide/pcm_utility.userguide.rst index 1ae68516c..6695d50c0 100644 --- a/docs/userguide/pcm_utility.userguide.rst +++ b/docs/userguide/pcm_utility.userguide.rst @@ -2,13 +2,13 @@ .. http://creativecommons.org/licenses/by/4.0 -=========================== -PCM Utility in KVMFORNFV -=========================== +====================== +PCM Utility in KVM4NFV +====================== Collecting Memory Bandwidth Information using PCM utility --------------------------------------------------------- -This chapter includes how the PCM utility is used in kvmfornfv +This chapter includes how the PCM utility is used in kvm4nfv to collect memory bandwidth information About PCM utility @@ -34,17 +34,17 @@ Version Features | | - pcm-memory.x will be executed before the | | Danube | execution of every testcase | | | - pcm-memory.x provides the memory bandwidth | -| | data throught out the testcases | +| | data throughout out the testcases | | | - used for all test-types (stress/idle) | -| | - Generated memory bandwidth logs which are | -| | to published to the KVMFORFNV artifacts | +| | - Generated memory bandwidth logs are | +| | published to the KVMFORFNV artifacts | +-----------------------------+-----------------------------------------------+ Implementation of pcm-memory.x: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The tool measures the memory bandwidth observed for every channel reporting seperately throughputs -for reads from memory and writes to the memory.pcm-memory.x tool tends to report values slightly +The tool measures the memory bandwidth observed for every channel reporting seperate throughput +for reads from memory and writes to the memory. pcm-memory.x tool tends to report values slightly higher than the application's own measurement. Command: @@ -90,10 +90,10 @@ Parameters | - System Memory Throughput(MB/s): 72140.62 | +-------------------------------------------------------------------------------+ -pcm-memory.x in KVMFORNFV: +pcm-memory.x in KVM4NFV: ~~~~~~~~~~~~~~~~~~~~~~~~~~ -pcm-memory is a part of KVMFORNFV in D release.pcm-memory.x will be executed with delay of 60 seconds +pcm-memory is a part of KVM4NFV in D release.pcm-memory.x will be executed with delay of 60 seconds before starting every testcase to monitor the memory traffic intensity which was handled in collect_MBWInfo function .The memory bandwidth information will be collected into the logs through the testcase updating every 60 seconds. @@ -107,7 +107,7 @@ the testcase updating every 60 seconds. 3.Installing MSR registers -Memory Bandwidth logs for KVMFORNFV can be found `here`_: +Memory Bandwidth logs for KVM4NFV can be found `here`_: .. code:: bash @@ -138,4 +138,4 @@ signal will be passed to terminate the pcm-memory process which was executing th Future Scope ------------ -PCM information will be added to cyclictest of kvmfornfv in yardstick. +PCM information will be added to cyclictest of kvm4nfv in yardstick. |