Small enhancement to the release notes document
[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 .. (c) <optionally add copywriters name>
4
5
6 .. _Kvmfornfv: https://wiki.opnfv.org/display/kvm/
7
8
9 Abstract
10 ========
11
12 This document provides the release notes for Colorado 1.0 release of KVMFORNFV.
13
14
15 **Contents**
16
17 1  Version History
18
19 2  Important notes
20
21 3  Summary
22
23 4  Delivery Data
24
25 5  References
26
27 1   Version history
28 ===================
29
30 +--------------------+--------------------+--------------------+----------------------+
31 | **Date**           | **Ver.**           | **Author**         | **Comment**          |
32 |                    |                    |                    |                      |
33 +--------------------+--------------------+--------------------+----------------------+
34 |2016-08-22          | 0.1.0              |                    | Colorado 1.0 release |
35 |                    |                    |                    |                      |
36 +--------------------+--------------------+--------------------+----------------------+
37
38 2   Important notes
39 ===================
40
41 The KVMFORNFV project is currently supported on the Fuel installer.
42
43 3   Summary
44 ===========
45
46 This Colorado 1.0 release provides *KVMFORNFV* as a framework to enhance the
47 KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV
48 CI pipeline, including:
49
50 *   KVMFORNFV source code
51
52 *   Automation of building the Kernel and qemu for RPM and debian packages
53
54 *   Cyclictests execution to check the latency
55
56 *   “os-sdn-kvm-ha” Scenario testing for high availability configuration using
57 Fuel installer
58
59 * Documentation created
60
61   * User Guide
62
63   * Configuration Guide
64
65   * Installation Procedure
66
67   * Release notes (this document)
68
69 The *KVMFORNFV framework* is developed in the OPNFV community, by the
70 KVMFORNFV_ team.
71
72 4   Release Data
73 ================
74
75 +--------------------------------------+--------------------------------------+
76 | **Project**                          | NFV Hypervisors-KVM                  |
77 |                                      |                                      |
78 +--------------------------------------+--------------------------------------+
79 | **Repo/commit-ID**                   | kvmfornfv                            |
80 |                                      |                                      |
81 +--------------------------------------+--------------------------------------+
82 | **Release designation**              | Colorado                             |
83 |                                      |                                      |
84 +--------------------------------------+--------------------------------------+
85 | **Release date**                     | 2016-09-22                           |
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88 | **Purpose of the delivery**          | OPNFV Colorado 1.0 Releases          |
89 |                                      |                                      |
90 +--------------------------------------+--------------------------------------+
91
92 4.1 Version change
93 ------------------
94
95 4.1.1   Module version changes
96 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97
98 This is the Colorado 1.0 main release. It is based on following upstream
99 versions:
100
101 *   RT Kernel 4.4.6-rt14
102
103 *   QEMU 2.6
104
105 *   Fuel plugin based on Fuel 9.0
106
107 This is the first tracked release of KVMFORNFV
108
109
110 4.1.2   Document version changes
111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112 This is the initial version of the KVMFORNFV framework in OPNFV.
113
114 4.2 Reason for version
115 ----------------------
116
117 4.2.1 Feature additions
118 ~~~~~~~~~~~~~~~~~~~~~~~
119
120 4.2.2 Bug corrections
121 ~~~~~~~~~~~~~~~~~~~~~
122
123 Initial Release
124
125 4.3 Deliverables
126 ----------------
127
128 4.3.1   Software deliverables
129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130 Colorado 1.0 release of the KVMFORNFV RPM and debian for Fuel.
131
132 4.3.2   Documentation deliverables
133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134
135 The below documents are delivered for Colorado KVMFORNFV Release:
136
137   * User Guide
138
139   * Configuration Guide
140
141   * Installation Procedure
142
143   * Overview
144
145   * Release notes (this document)
146
147   * Glossary
148
149
150 5  References
151 =============
152
153 For more information on the KVMFORNFV Colorado release, please see:
154
155 https://wiki.opnfv.org/display/kvm/