This patch is used to update the documents of D-release.
[kvmfornfv.git] / 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 KVMFORNFV.
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 1.  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 2.  Important notes
43 --------------------
44
45 The KVMFORNFV project is currently supported on the Fuel installer.
46
47 3.  Summary
48 ------------
49
50 This Danube 1.0 release provides *KVMFORNFV* 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-sdn-kvm-ha”,“os-sdn-kvm-_nfv_ovs_dpdk-ha”,“os-sdn-kvm_nfv_ovs_dpdk-noha”,“os-sdn-kvm_nfv_ovs_dpdk_bar-ha”,“os-sdn-kvm_nfv_ovs_dpdk_bar-noha” Scenarios testing for high availability configuration using Fuel installer
61
62 * Documentation created
63
64   * User Guide
65
66   * Configuration Guide
67
68   * Installation Procedure
69
70   * Release notes (this document)
71
72 The *KVMFORNFV framework* is developed in the OPNFV community, by the
73 KVMFORNFV_ team.
74
75 4.  Release Data
76 -----------------
77
78 +--------------------------------------+--------------------------------------+
79 | **Project**                          | NFV Hypervisors-KVM                  |
80 |                                      |                                      |
81 +--------------------------------------+--------------------------------------+
82 | **Repo/commit-ID**                   | kvmfornfv                            |
83 |                                      |                                      |
84 +--------------------------------------+--------------------------------------+
85 | **Release designation**              | Danube                               |
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88 | **Release date**                     | 2017-03-27                           |
89 |                                      |                                      |
90 +--------------------------------------+--------------------------------------+
91 | **Purpose of the delivery**          | OPNFV Danube 1.0 Releases            |
92 |                                      |                                      |
93 +--------------------------------------+--------------------------------------+
94
95 4.1 Version change
96 ------------------
97
98 4.1.1   Module version changes
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100
101 This is the Danube 1.0 main release. It is based on following upstream
102 versions:
103
104 *   RT Kernel 4.4.6-rt14
105
106 *   QEMU 2.6
107
108 *   Fuel plugin based on Fuel 10.0
109
110 This is the second tracked release of KVMFORNFV
111
112
113 4.1.2   Document version changes
114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115 This is the initial version of the KVMFORNFV framework in OPNFV.
116
117 4.2 Reason for version
118 ----------------------
119
120 4.2.1 Feature additions
121 ~~~~~~~~~~~~~~~~~~~~~~~
122
123 +--------------------------------------+--------------------------------------+
124 | **JIRA REFERENCE**                   | **SLOGAN**                           |
125 |                                      |                                      |
126 +--------------------------------------+--------------------------------------+
127 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-57      |
128 |                                      |                                      |
129 +--------------------------------------+--------------------------------------+
130 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-58      |
131 |                                      |                                      |
132 +--------------------------------------+--------------------------------------+
133 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-59      |
134 |                                      |                                      |
135 +--------------------------------------+--------------------------------------+
136 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-61      |
137 |                                      |                                      |
138 +--------------------------------------+--------------------------------------+
139 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-62      |
140 |                                      |                                      |
141 +--------------------------------------+--------------------------------------+
142 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-63      |
143 |                                      |                                      |
144 +--------------------------------------+--------------------------------------+
145 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-64      |
146 |                                      |                                      |
147 +--------------------------------------+--------------------------------------+
148 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-65      |
149 |                                      |                                      |
150 +--------------------------------------+--------------------------------------+
151
152 4.2.2 Bug corrections
153 ~~~~~~~~~~~~~~~~~~~~~
154
155 Initial Release
156
157 4.3 Deliverables
158 ----------------
159
160 4.3.1   Software deliverables
161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162 Danube 1.0 release of the KVMFORNFV RPM and debian for Fuel.
163
164 4.3.2   Documentation deliverables
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166
167 The below documents are delivered for Danube KVMFORNFV Release:
168
169   * User Guide
170
171   * Configuration Guide
172
173   * Installation Procedure
174
175   * Overview
176
177   * Release notes (this document)
178
179   * Glossary
180
181   * Scenarios
182
183 5. References
184 --------------
185
186 For more information on the KVMFORNFV Danube release, please see:
187
188 https://wiki.opnfv.org/display/kvm/