Documentation updates
[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 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 release   |
35 |                    |                    |                    |                    |
36 +--------------------+--------------------+--------------------+--------------------+
37
38 2   Important notes
39 ===================
40
41 The software delivered in the OPNFV KVMFORNFV_ Project, comprises the
42 *ci*, the *kvmfornfv test cases*.
43
44 The *KVMFORNFV* framework depends on the *Fuel* installer.
45
46
47 3   Summary
48 ===========
49
50 This Colorado 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 * Documentation created
55
56   * User Guide
57
58   * Configuration Guide
59
60   * Installation Procedure
61
62   * Release notes (this document)
63
64 * KVMFORNFV source code
65
66 * Cyclictests for KVMFORNFV
67
68 For Colorado release, the KVMFORNFV uses for the following:
69
70 * Automation of building the Kernel and qemu RPM's or debians
71
72 * Executing the Cyclictests to check the latency
73
74 * os-sdn-kvm-ha Scenario testing for High Availability Configuration using
75   Fuel Installer
76
77 The *KVMFORNFV framework* is developed in the OPNFV community, by the
78 KVMFORNFV_ team.
79
80 4   Release Data
81 ================
82
83 +--------------------------------------+--------------------------------------+
84 | **Project**                          | NFV Hypervisors-KVM                  |
85 |                                      |                                      |
86 +--------------------------------------+--------------------------------------+
87 | **Repo/commit-ID**                   | kvmfornfv                            |
88 |                                      |                                      |
89 +--------------------------------------+--------------------------------------+
90 | **Release designation**              | Colorado                             |
91 |                                      |                                      |
92 +--------------------------------------+--------------------------------------+
93 | **Release date**                     | 2016-09-22                           |
94 |                                      |                                      |
95 +--------------------------------------+--------------------------------------+
96 | **Purpose of the delivery**          | OPNFV Colorado Releases              |
97 |                                      |                                      |
98 +--------------------------------------+--------------------------------------+
99
100 4.1 Version change
101 ------------------
102
103 4.1.1   Module version changes
104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105 This is the first tracked release of KVMFORNFV
106
107
108 4.1.2   Document version changes
109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110 This is the initial version of the KVMFORNFV framework in OPNFV.
111
112 4.2 Reason for version
113 ----------------------
114
115 4.2.1 Feature additions
116 ~~~~~~~~~~~~~~~~~~~~~~~
117
118 +--------------------------------------+--------------------------------------+
119 | **JIRA REFERENCE**                   | **SLOGAN**                           |
120 |                                      |                                      |
121 +--------------------------------------+--------------------------------------+
122 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-34      |
123 |                                      |                                      |
124 +--------------------------------------+--------------------------------------+
125 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-34      |
126 |                                      |                                      |
127 +--------------------------------------+--------------------------------------+
128
129 4.2.2 Bug corrections
130 ~~~~~~~~~~~~~~~~~~~~~
131
132 Initial Release
133
134 4.3 Deliverables
135 ----------------
136
137 4.3.1   Software deliverables
138 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139 KVMFORNFV framework source code <Colorado>
140
141 4.3.2   Documentation deliverables
142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143
144 The below documents are delivered for Colorado KVMFORNFV Release:
145
146   * User Guide
147
148   * Configuration Guide
149
150   * Installation Procedure
151
152   * Overview
153
154   * Release notes (this document)
155
156   * Glossary
157
158
159 5  References
160 =============
161
162 For more information on the KVMFORNFV Colorado release, please see:
163
164 https://wiki.opnfv.org/display/kvm/