docs/release/release-notes/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 Euphrates 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 |2017-10-06          | 0.1.0              |                    | Euphrates 1.0 release  |
  42 |                    |                    |                    |                        |
  43 +--------------------+--------------------+--------------------+------------------------+
  44
  45 Important notes
  46 ---------------
  47
  48 The KVM4NFV project is currently supported on Fuel and Apex installer.
  49
  50 Summary
  51 -------
  52
  53 This Euphrates 1.0 release provides *KVM4NFV* as a framework to enhance the
  54 KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV
  55 CI pipeline, including:
  56
  57 *   KVMFORNFV source code
  58
  59 *   Automation of building the Kernel and qemu for RPM and debian packages
  60
  61 *   Cyclictests execution to check the latency
  62
  63 *   “os-nosdn-kvm_ovs_dpdk-ha”,“os-nosdn-kvm_ovs_dpdk-noha”, Scenarios testing for
  64     ``high availability/no-high avaliability`` configuration using Apex installer
  65
  66 * Documentation created for,
  67
  68   * User Guide
  69
  70   * Configuration Guide
  71
  72   * Installation Procedure
  73
  74   * Release notes
  75
  76   * Scenarios Guide
  77
  78   * Design Guide
  79
  80   * Requirements Guide
  81
  82
  83 Release Data
  84 ------------
  85
  86 +--------------------------------------+--------------------------------------+
  87 | **Project**                          | NFV Hypervisors-KVM                  |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90 | **Repo/commit-ID**                   | kvmfornfv                            |
  91 |                                      |                                      |
  92 +--------------------------------------+--------------------------------------+
  93 | **Release designation**              | Euphrates                            |
  94 |                                      |                                      |
  95 +--------------------------------------+--------------------------------------+
  96 | **Release date**                     | 2017-10-06                           |
  97 |                                      |                                      |
  98 +--------------------------------------+--------------------------------------+
  99 | **Purpose of the delivery**          | OPNFV Euphrates 1.0 Releases         |
 100 |                                      |                                      |
 101 +--------------------------------------+--------------------------------------+
 102
 103 Version change
 104 --------------
 105
 106 1   Module version changes
 107 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 108
 109 This is the Euphrates 1.0 main release. It is based on following upstream
 110 versions:
 111
 112 *   RT Kernel 4.4.50-rt62
 113
 114 *   QEMU 2.9.0
 115
 116 *   Apex based on Openstack Ocata
 117
 118
 119 This is the third tracked release of KVM4NFV
 120
 121
 122 2   Document version changes
 123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 124
 125 This is the second version of the KVM4NFV framework in OPNFV.
 126
 127 Reason for version
 128 ------------------
 129
 130 1 Feature additions
 131 ~~~~~~~~~~~~~~~~~~~
 132
 133 +--------------------------------------+--------------------------------------+
 134 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 135 |                                      |                                      |
 136 +--------------------------------------+--------------------------------------+
 137 | JIRA:                                | NFV Hypervisors-KVMFORNFV-72         |
 138 |                                      |                                      |
 139 +--------------------------------------+--------------------------------------+
 140 | JIRA:                                | NFV Hypervisors-KVMFORNFV-73         |
 141 |                                      |                                      |
 142 +--------------------------------------+--------------------------------------+
 143 | JIRA:                                | NFV Hypervisors-KVMFORNFV-78         |
 144 |                                      |                                      |
 145 +--------------------------------------+--------------------------------------+
 146 | JIRA:                                | NFV Hypervisors-KVMFORNFV-86         |
 147 |                                      |                                      |
 148 +--------------------------------------+--------------------------------------+
 149 | JIRA:                                | NFV Hypervisors-KVMFORNFV-87         |
 150 |                                      |                                      |
 151 +--------------------------------------+--------------------------------------+
 152 | JIRA:                                | NFV Hypervisors-KVMFORNFV-88         |
 153 |                                      |                                      |
 154 +--------------------------------------+--------------------------------------+
 155 | JIRA:                                | NFV Hypervisors-KVMFORNFV-89         |
 156 |                                      |                                      |
 157 +--------------------------------------+--------------------------------------+
 158 | JIRA:                                | VSPERF-510                           |
 159 |                                      |                                      |
 160 +--------------------------------------+--------------------------------------+
 161 | JIRA:                                | YARDSTICK-783                        |
 162 |                                      |                                      |
 163 +--------------------------------------+--------------------------------------+
 164 | JIRA:                                | YARDSTICK-815                        |
 165 |                                      |                                      |
 166 +--------------------------------------+--------------------------------------+
 167
 168 A brief ``Description of the the JIRA tickets``:
 169
 170 +---------------------------------------+-------------------------------------------------------------+
 171 | **JIRA REFERENCE**                    | **DESCRIPTION**                                             |
 172 |                                       |                                                             |
 173 +---------------------------------------+-------------------------------------------------------------+
 174 | KVMFORNFV-72                          | Define and integrate additional scenario - KVM+OVS+DPDK     |
 175 |                                       | with HA for bare metal and virtual environments             |
 176 +---------------------------------------+-------------------------------------------------------------+
 177 | KVMFORNFV-73                          | Define and integrate additional scenario - KVM+OVS+DPDK     |
 178 |                                       | with NOHA for bare metal and virtual environments           |
 179 |                                       |                                                             |
 180 +---------------------------------------+-------------------------------------------------------------+
 181 | KVMFORNFV-78                          | Scenarios in Euphrates release for KVM for NFV              |
 182 |                                       |                                                             |
 183 +---------------------------------------+-------------------------------------------------------------+
 184 | KVMFORNFV-86                          | Live Migration tests in kvmfornfv repository                |
 185 |                                       |                                                             |
 186 +---------------------------------------+-------------------------------------------------------------+
 187 | KVMFORNFV-87                          | Packet forwarding test type pxp - multiple guests           |
 188 |                                       |                                                             |
 189 +---------------------------------------+-------------------------------------------------------------+
 190 | KVMFORNFV-88                          | Apex environment setup for local machine to debug Apex      |
 191 |                                       | related integration issues                                  |
 192 |                                       |                                                             |
 193 +---------------------------------------+-------------------------------------------------------------+
 194 | KVMFORNFV-89                          | Generate kernel debug-info rpm                              |
 195 |                                       |                                                             |
 196 +---------------------------------------+-------------------------------------------------------------+
 197 | VSPERF-510                            | KVM optimizations                                           |
 198 |                                       |                                                             |
 199 +---------------------------------------+-------------------------------------------------------------+
 200 | YARDSTICK-783                         | To update Grafana dashboard for kvmfornfv packet forwarding |
 201 |                                       | test cases                                                  |
 202 +---------------------------------------+-------------------------------------------------------------+
 203 | YARDSTICK-815                         | Implementation of breaktrace option for cyclictest          |
 204 |                                       |                                                             |
 205 +---------------------------------------+-------------------------------------------------------------+
 206
 207 Deliverables
 208 ------------
 209
 210 1   Software deliverables
 211 ~~~~~~~~~~~~~~~~~~~~~~~~~
 212 * Euphrates 1.0 release of the KVM4NFV RPM and debian for kvm4nfv
 213
 214 * Kernel debug-info rpm and debian is generated as part of E-release
 215
 216 * Integrated the following scenarios in APEX as part of E-Release:
 217
 218   * os-nosdn-kvm_ovs_dpdk-noha
 219
 220   * os-nosdn-kvm_ovs_dpdk-ha
 221
 222 * Configured influxdb and `Graphana_dashboard`_ for publishing kvm4nfv test results
 223
 224 .. _Graphana_dashboard: http://testresults.opnfv.org/grafana/dashboard/db/kvmfornfv-cyclictest
 225
 226 * Packet forwarding test case is implemented and it supports the following test types currently,
 227
 228   * Packet forwarding to Host
 229
 230   * Packet forwarding to Guest
 231
 232   * Packet forwarding to Guest using SRIOV
 233
 234   * Packet forwarding to multiple guests
 235
 236 * Breaktrace option is implemented to monitor the latency values obatined by the cyclictest
 237
 238 * Live Migration test case is implemented and the following values are collected:
 239
 240   * Total time
 241
 242   * Down time
 243
 244   * Setup time
 245
 246 * Either Apex or Fuel can be used for deployment of os-nosdn-kvm-ha, os-nosdn-kvm_ovs_dpdk-ha and
 247 os-nosdn-kvm_ovs_dpdk-noha scenarios
 248
 249 +------------------------------------------+------------------+-----------------+
 250 | **Scenario Name**                        | **Apex**         | **Fuel**        |
 251 |                                          |                  |                 |
 252 +==========================================+==================+=================+
 253 | - os-nosdn-kvm-ha                        |     ``Y``        |     ``Y``       |
 254 +------------------------------------------+------------------+-----------------+
 255 | - os-nosdn-kvm_ovs_dpdk-noha             |     ``Y``        |     ``Y``       |
 256 +------------------------------------------+------------------+-----------------+
 257 | - os-nosdn-kvm_ovs_dpdk-ha               |     ``Y``        |     ``Y``       |
 258 +------------------------------------------+------------------+-----------------+
 259 | - os-nosdn-kvm_ovs_dpdk_bar-noha         |                  |     ``Y``       |
 260 +------------------------------------------+------------------+-----------------+
 261 | - os-nosdn-kvm_ovs_dpdk_bar-ha           |                  |     ``Y``       |
 262 +------------------------------------------+------------------+-----------------+
 263
 264 * The below documents are delivered for Euphrates KVM4NFV Release:
 265
 266   * User Guide
 267
 268   * Configuration Guide
 269
 270   * Installation Procedure
 271
 272   * Overview
 273
 274   * Release notes
 275
 276   * Glossary
 277
 278   * Scenarios
 279
 280   * Requirements Guide
 281
 282   * Overview Guide
 283
 284 References
 285 ----------
 286
 287 For more information on the KVM4NFV Euphrates release, please see:
 288
 289 https://wiki.opnfv.org/display/kvm/