X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=docs%2Freleasenotes%2Frelease-notes.rst;h=c52b4b8393a7e65f56fd9d27232b40e5b9506afd;hb=9f343782f79512bb6423c973f591dcc90b63ab6b;hp=a0185936e2a7224a84109f3209191d6b2fc088be;hpb=42b05a5201bd85502f818744af562c5c3e1a94c8;p=kvmfornfv.git diff --git a/docs/releasenotes/release-notes.rst b/docs/releasenotes/release-notes.rst index a0185936e..c52b4b839 100644 --- a/docs/releasenotes/release-notes.rst +++ b/docs/releasenotes/release-notes.rst @@ -1,84 +1,87 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. (c) - .. _Kvmfornfv: https://wiki.opnfv.org/display/kvm/ +============= +Release Notes +============= Abstract -======== +--------- -This document provides the release notes for Colorado release of KVMFORNFV. +This document provides the release notes for Danube 1.0 release of KVM4NFV. **Contents** -1 Version History - -2 Important notes + **1 Version History** -3 Summary + **2 Important notes** -4 Delivery Data + **3 Summary** -5 References + **4 Delivery Data** -1 Version history -=================== + **5 References** -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -|2016-08-22 | 0.1.0 | | Colorado release | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +Version history +--------------- -2 Important notes -=================== ++--------------------+--------------------+--------------------+----------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+----------------------+ +|2016-08-22 | 0.1.0 | | Colorado 1.0 release | +| | | | | ++--------------------+--------------------+--------------------+----------------------+ +|2017-03-27 | 0.1.0 | | Danube 1.0 release | +| | | | | ++--------------------+--------------------+--------------------+----------------------+ -The software delivered in the OPNFV KVMFORNFV_ Project, comprises the -*ci*, the *kvmfornfv test cases*. +Important notes +--------------- -The *KVMFORNFV* framework depends on the *Fuel* installer. +The KVM4NFV project is currently supported on the Fuel installer. +Summary +------- -3 Summary -=========== - -This Colorado 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: -* Documentation created +* KVMFORNFV source code - * User Guide +* Automation of building the Kernel and qemu for RPM and debian packages - * Configuration Guide +* Cyclictests execution to check the latency - * Installation Procedure +* “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 - * Release notes (this document) +* Documentation created for, -* KVMFORNFV source code + * User Guide -* Cyclictests for KVMFORNFV + * Configuration Guide -For Colorado release, the KVMFORNFV uses for the following: + * Installation Procedure -* Automation of building the Kernel and qemu RPM's or debians + * Release notes -* Executing the Cyclictests to check the latency + * Scenarios Guide -* os-sdn-kvm-ha Scenario testing for High Availability Configuration using - Fuel Installer + * Design Guide -The *KVMFORNFV framework* is developed in the OPNFV community, by the -KVMFORNFV_ team. + * Requirements Guide -4 Release Data -================ +The *KVM4NFV framework* is developed in the OPNFV community, by the +KVM4NFV_ team. + +Release Data +------------ +--------------------------------------+--------------------------------------+ | **Project** | NFV Hypervisors-KVM | @@ -87,61 +90,169 @@ KVMFORNFV_ team. | **Repo/commit-ID** | kvmfornfv | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado | +| **Release designation** | Danube | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 2016-09-22 | +| **Release date** | 2017-03-27 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Colorado Releases | +| **Purpose of the delivery** | OPNFV Danube 1.0 Releases | | | | +--------------------------------------+--------------------------------------+ -4.1 Version change ------------------- +Version change +-------------- + +1 Module version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~ -4.1.1 Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked release of KVMFORNFV +This is the Danube 1.0 main release. It is based on following upstream +versions: +* RT Kernel 4.4.50-rt62 -4.1.2 Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is the initial version of the KVMFORNFV framework in OPNFV. +* QEMU 2.6 -4.2 Reason for version ----------------------- +* Fuel plugin based on Fuel 10.0 -4.2.1 Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ +This is the second tracked release of KVM4NFV + + +2 Document version changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is the second version of the KVM4NFV framework in OPNFV. + +Reason for version +------------------ + +1 Feature additions +~~~~~~~~~~~~~~~~~~~ +--------------------------------------+--------------------------------------+ | **JIRA REFERENCE** | **SLOGAN** | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-34 | +| JIRA: | NFV Hypervisors-KVMFORNFV-57 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-58 | | | | +--------------------------------------+--------------------------------------+ -| JIRA: | NFV Hypervisors-KVMKVMFORNFV-34 | +| JIRA: | NFV Hypervisors-KVMFORNFV-59 | | | | +--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-61 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-62 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-63 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-64 | +| | | ++--------------------------------------+--------------------------------------+ +| JIRA: | NFV Hypervisors-KVMFORNFV-65 | +| | | ++--------------------------------------+--------------------------------------+ + +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 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 -4.2.2 Bug corrections -~~~~~~~~~~~~~~~~~~~~~ +* Cyclictest test case is successfully implemented, it has the below test types., -Initial Release + * idle-idle -4.3 Deliverables ----------------- + * CPUstress-idle -4.3.1 Software deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -KVMFORNFV framework source code + * IOstress-idle -4.3.2 Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + * Memorystress-idle -The below documents are delivered for Colorado KVMFORNFV Release: +* 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 @@ -151,14 +262,19 @@ The below documents are delivered for Colorado KVMFORNFV Release: * Overview - * Release notes (this document) + * Release notes * Glossary + * Scenarios -5 References -============= + * Requirements Guide + + * Overview Guide + +References +---------- -For more information on the KVMFORNFV Colorado release, please see: +For more information on the KVM4NFV Danube release, please see: https://wiki.opnfv.org/display/kvm/