docs/releasenotes/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 .. _Kvmfornfv: https://wiki.opnfv.org/display/kvm/
   5
   6 =============
   7 Release Notes
   8 =============
   9
  10 Abstract
  11 ---------
  12
  13 This document provides the release notes for Danube 1.0 release of KVM4NFV.
  14
  15
  16 **Contents**
  17
  18  **1  Version History**
  19
  20  **2  Important notes**
  21
  22  **3  Summary**
  23
  24  **4  Delivery Data**
  25
  26  **5  References**
  27
  28 Version history
  29 ---------------
  30
  31 +--------------------+--------------------+--------------------+----------------------+
  32 | **Date**           | **Ver.**           | **Author**         | **Comment**          |
  33 |                    |                    |                    |                      |
  34 +--------------------+--------------------+--------------------+----------------------+
  35 |2016-08-22          | 0.1.0              |                    | Colorado 1.0 release |
  36 |                    |                    |                    |                      |
  37 +--------------------+--------------------+--------------------+----------------------+
  38 |2017-03-27          | 0.1.0              |                    | Danube 1.0 release   |
  39 |                    |                    |                    |                      |
  40 +--------------------+--------------------+--------------------+----------------------+
  41
  42 Important notes
  43 ---------------
  44
  45 The KVM4NFV project is currently supported on the Fuel installer.
  46
  47 Summary
  48 -------
  49
  50 This Danube 1.0 release provides *KVM4NFV* as a framework to enhance the
  51 KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV
  52 CI pipeline, including:
  53
  54 *   KVMFORNFV source code
  55
  56 *   Automation of building the Kernel and qemu for RPM and debian packages
  57
  58 *   Cyclictests execution to check the latency
  59
  60 *   “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”,
  61     “os-nosdn-kvm_nfv_ovs_dpdk_bar-noha” Scenarios testing for ``high availability/no-high avaliability``
  62     configuration using Fuel installer
  63
  64 * Documentation created for,
  65
  66   * User Guide
  67
  68   * Configuration Guide
  69
  70   * Installation Procedure
  71
  72   * Release notes
  73
  74   * Scenarios Guide
  75
  76   * Design Guide
  77
  78   * Requirements Guide
  79
  80 The *KVM4NFV framework* is developed in the OPNFV community, by the
  81 KVM4NFV_ team.
  82
  83 Release Data
  84 ------------
  85
  86 +--------------------------------------+--------------------------------------+
  87 | **Project**                          | NFV Hypervisors-KVM                  |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90 | **Repo/commit-ID**                   | kvmfornfv                            |
  91 |                                      |                                      |
  92 +--------------------------------------+--------------------------------------+
  93 | **Release designation**              | Danube                               |
  94 |                                      |                                      |
  95 +--------------------------------------+--------------------------------------+
  96 | **Release date**                     | 2017-03-27                           |
  97 |                                      |                                      |
  98 +--------------------------------------+--------------------------------------+
  99 | **Purpose of the delivery**          | OPNFV Danube 1.0 Releases            |
 100 |                                      |                                      |
 101 +--------------------------------------+--------------------------------------+
 102
 103 Version change
 104 --------------
 105
 106 1   Module version changes
 107 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 108
 109 This is the Danube 1.0 main release. It is based on following upstream
 110 versions:
 111
 112 *   RT Kernel 4.4.50-rt62
 113
 114 *   QEMU 2.6
 115
 116 *   Fuel plugin based on Fuel 10.0
 117
 118 This is the second tracked release of KVM4NFV
 119
 120
 121 2   Document version changes
 122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 123 This is the second version of the KVM4NFV framework in OPNFV.
 124
 125 Reason for version
 126 ------------------
 127
 128 1 Feature additions
 129 ~~~~~~~~~~~~~~~~~~~
 130
 131 +--------------------------------------+--------------------------------------+
 132 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 133 |                                      |                                      |
 134 +--------------------------------------+--------------------------------------+
 135 | JIRA:                                | NFV Hypervisors-KVMFORNFV-57         |
 136 |                                      |                                      |
 137 +--------------------------------------+--------------------------------------+
 138 | JIRA:                                | NFV Hypervisors-KVMFORNFV-58         |
 139 |                                      |                                      |
 140 +--------------------------------------+--------------------------------------+
 141 | JIRA:                                | NFV Hypervisors-KVMFORNFV-59         |
 142 |                                      |                                      |
 143 +--------------------------------------+--------------------------------------+
 144 | JIRA:                                | NFV Hypervisors-KVMFORNFV-61         |
 145 |                                      |                                      |
 146 +--------------------------------------+--------------------------------------+
 147 | JIRA:                                | NFV Hypervisors-KVMFORNFV-62         |
 148 |                                      |                                      |
 149 +--------------------------------------+--------------------------------------+
 150 | JIRA:                                | NFV Hypervisors-KVMFORNFV-63         |
 151 |                                      |                                      |
 152 +--------------------------------------+--------------------------------------+
 153 | JIRA:                                | NFV Hypervisors-KVMFORNFV-64         |
 154 |                                      |                                      |
 155 +--------------------------------------+--------------------------------------+
 156 | JIRA:                                | NFV Hypervisors-KVMFORNFV-65         |
 157 |                                      |                                      |
 158 +--------------------------------------+--------------------------------------+
 159
 160 A brief ``Description of the the JIRA tickets``:
 161
 162 +---------------------------------------+-------------------------------------------------------------+
 163 | **JIRA REFERENCE**                    | **DESCRIPTION**                                             |
 164 |                                       |                                                             |
 165 +---------------------------------------+-------------------------------------------------------------+
 166 | KVMFORNFV-57                          | CI/CD Integration into Yardstick                            |
 167 |                                       |                                                             |
 168 +---------------------------------------+-------------------------------------------------------------+
 169 | KVMFORNFV-58                          | Complete the integration of test plan into Yardstick        |
 170 |                                       | and Jenkins infrastructure to include latency testing       |
 171 |                                       |                                                             |
 172 +---------------------------------------+-------------------------------------------------------------+
 173 | KVMFORNFV-59                          | Enable capability to publish results on Yardstick Dashboard |
 174 |                                       |                                                             |
 175 +---------------------------------------+-------------------------------------------------------------+
 176 | KVMFORNFV-61                          | Define and integrate additional scenario - KVM+OVS+DPDK     |
 177 |                                       | with HA and NOHA for baremetal and virtual environments     |
 178 |                                       |                                                             |
 179 +---------------------------------------+-------------------------------------------------------------+
 180 | KVMFORNFV-62                          | Define and integrate additional scenario - KVM+OVS+DPDK+BAR |
 181 |                                       | with HA and NOHA for bare metal and virtual environments    |
 182 |                                       |                                                             |
 183 +---------------------------------------+-------------------------------------------------------------+
 184 | KVMFORNFV-63                          | Setup Local fuel environment                                |
 185 |                                       |                                                             |
 186 +---------------------------------------+-------------------------------------------------------------+
 187 | KVMFORNFV-64                          | Fuel environment setup for local machine to debug Fuel      |
 188 |                                       | related integration issues                                  |
 189 +---------------------------------------+-------------------------------------------------------------+
 190
 191 Deliverables
 192 ------------
 193
 194 1   Software deliverables
 195 ~~~~~~~~~~~~~~~~~~~~~~~~~
 196 * Danube 1.0 release of the KVM4NFV RPM and debian for kvm4nfv
 197
 198 * Added the following scenarios as part of D-Release:
 199
 200   * os-nosdn-kvm_nfv_ovs_dpdk-noha
 201
 202   * os-nosdn-kvm_nfv_ovs_dpdk_bar-noha
 203
 204   * os-nosdn-kvm_nfv_ovs_dpdk-ha
 205
 206   * os-nosdn-kvm_nfv_ovs_dpdk_bar-ha
 207
 208 * Configured influxdb and `Graphana dashboard`_ for publishing kvm4nfv test results
 209
 210 .. _Graphana_dashboard: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest
 211
 212 * Cyclictest test case is successfully implemented, it has the below test types.,
 213
 214   * idle-idle
 215
 216   * CPUstress-idle
 217
 218   * IOstress-idle
 219
 220   * Memorystress-idle
 221
 222 * Implemented Noisy Neighbour feature ., cyclictest under stress testing is implemented
 223
 224 * Packet forwarding test case is implemented and it supports the following test types currently,
 225
 226   * Packet forwarding to Host
 227
 228   * Packet forwarding to Guest
 229
 230   * Packet forwarding to Guest using SRIOV
 231
 232 * Ftrace debugging tool is supported in D-Release. The logs collected by ftrace are stored in artifacts for future needs
 233
 234 * PCM Utility is part of D-Release. The future scope may include collection of read/write data and publishing in grafana
 235
 236 * Either Apex or Fuel can be used for deployment of os-nosdn-kvm-ha scenario
 237
 238 +------------------------------------------+------------------+-----------------+
 239 | **Scenario Name**                        | **Apex**         | **Fuel**        |
 240 |                                          |                  |                 |
 241 +==========================================+==================+=================+
 242 | - os-nosdn-kvm-ha                        |     ``Y``        |     ``Y``       |
 243 +------------------------------------------+------------------+-----------------+
 244 | - os-nosdn-kvm_nfv_ovs_dpdk-noha         |                  |     ``Y``       |
 245 +------------------------------------------+------------------+-----------------+
 246 | - os-nosdn-kvm_nfv_ovs_dpdk-ha           |                  |     ``Y``       |
 247 +------------------------------------------+------------------+-----------------+
 248 | - os-nosdn-kvm_nfv_ovs_dpdk_bar-noha     |                  |     ``Y``       |
 249 +------------------------------------------+------------------+-----------------+
 250 | - os-nosdn-kvm_nfv_ovs_dpdk_bar-ha       |                  |     ``Y``       |
 251 +------------------------------------------+------------------+-----------------+
 252
 253 * Future scope may include adding Apex support for all the remaining scenarios
 254
 255 * The below documents are delivered for Danube KVM4NFV Release:
 256
 257   * User Guide
 258
 259   * Configuration Guide
 260
 261   * Installation Procedure
 262
 263   * Overview
 264
 265   * Release notes
 266
 267   * Glossary
 268
 269   * Scenarios
 270
 271   * Requirements Guide
 272
 273   * Overview Guide
 274
 275 References
 276 ----------
 277
 278 For more information on the KVM4NFV Danube release, please see:
 279
 280 https://wiki.opnfv.org/display/kvm/