summaryrefslogtreecommitdiffstats
path: root/docs/releasenotes/release-notes.rst
blob: c52b4b8393a7e65f56fd9d27232b40e5b9506afd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

.. _Kvmfornfv: https://wiki.opnfv.org/display/kvm/

=============
Release Notes
=============

Abstract
---------

This document provides the release notes for Danube 1.0 release of KVM4NFV.


**Contents**

 **1  Version History**

 **2  Important notes**

 **3  Summary**

 **4  Delivery Data**

 **5  References**

Version history
---------------

+--------------------+--------------------+--------------------+----------------------+
| **Date**           | **Ver.**           | **Author**         | **Comment**          |
|                    |                    |                    |                      |
+--------------------+--------------------+--------------------+----------------------+
|2016-08-22          | 0.1.0              |                    | Colorado 1.0 release |
|                    |                    |                    |                      |
+--------------------+--------------------+--------------------+----------------------+
|2017-03-27          | 0.1.0              |                    | Danube 1.0 release   |
|                    |                    |                    |                      |
+--------------------+--------------------+--------------------+----------------------+

Important notes
---------------

The KVM4NFV project is currently supported on the Fuel installer.

Summary
-------

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:

*   KVMFORNFV source code

*   Automation of building the Kernel and qemu for RPM and debian packages

*   Cyclictests execution to check the latency

*   “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 for,

  * User Guide

  * Configuration Guide

  * Installation Procedure

  * Release notes

  * Scenarios Guide

  * Design Guide

  * Requirements Guide

The *KVM4NFV framework* is developed in the OPNFV community, by the
KVM4NFV_ team.

Release Data
------------

+--------------------------------------+--------------------------------------+
| **Project**                          | NFV Hypervisors-KVM                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID**                   | kvmfornfv                            |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Danube                               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 2017-03-27                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV Danube 1.0 Releases            |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Version change
--------------

1   Module version changes
~~~~~~~~~~~~~~~~~~~~~~~~~~

This is the Danube 1.0 main release. It is based on following upstream
versions:

*   RT Kernel 4.4.50-rt62

*   QEMU 2.6

*   Fuel plugin based on Fuel 10.0

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-KVMFORNFV-57         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA:                                | NFV Hypervisors-KVMFORNFV-58         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| 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

* Cyclictest test case is successfully implemented, it has the below test types.,

  * idle-idle

  * CPUstress-idle

  * IOstress-idle

  * 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

  * Configuration Guide

  * Installation Procedure

  * Overview

  * Release notes

  * Glossary

  * Scenarios

  * Requirements Guide

  * Overview Guide

References
----------

For more information on the KVM4NFV Danube release, please see:

https://wiki.opnfv.org/display/kvm/