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