OPNFV KVM4NFV: Documentation
[kvmfornfv.git] / docs / releasenotes / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. http://creativecommons.org/licenses/by/4.0
4
5 =====================================================
6 OPNFV Release Note for "Colorado release" - KVMFORNFV
7 =====================================================
8
9 .. _Kvmfornfv: https://wiki.opnfv.org/display/kvm/
10
11
12 Abstract
13 ========
14
15 This document provides the release notes for Colorado release of KVMFORNFV.
16
17 License
18 =======
19
20 KVMFORNFV is licensed under a Creative Commons Attribution 4.0 International
21 License.You should have received a copy of the license along with this. If not,
22 see <http://creativecommons.org/licenses/by/4.0/>.
23
24
25 **Contents**
26
27 1  Version History
28
29 2  Important notes
30
31 3  Summary
32
33 4  Delivery Data
34
35 5 References
36
37 1   Version history
38 ===================
39
40 +--------------------+--------------------+--------------------+--------------------+
41 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
42 |                    |                    |                    |                    |
43 +--------------------+--------------------+--------------------+--------------------+
44 |2016-08-22          | 0.1.0              |                    | Colorado release   |
45 |                    |                    |                    |                    |
46 +--------------------+--------------------+--------------------+--------------------+
47
48 2   Important notes
49 ===================
50
51 The software delivered in the OPNFV KVMFORNFV_ Project, comprises the
52 *ci*, the *kvmfornfv test cases*.
53
54 The *KVMFORNFV* framework depends on the *Fuel* installer.
55
56
57 3   Summary
58 ===========
59
60 This Colorado release provides *KVMFORNFV* as a framework to enhance the
61 KVM Hypervisor for NFV and OPNFV scenario testing, automated in the OPNFV
62 CI pipeline, including:
63
64 * Documentation created
65
66   * User Guide
67
68   * Configuration Guide
69
70   * Installation Procedure
71
72   * Release notes (this document)
73
74 * KVMFORNFV source code
75
76 * Cyclictests for KVMFORNFV
77
78 For Colorado release, the KVMFORNFV uses for the following:
79
80 * Automation of building the Kernel and qemu RPM's or debians
81
82 * Executing the Cyclictests to check the latency
83
84 * os-sdn-kvm-ha Scenario testing for High Availability Configuration using
85   Fuel Installer
86
87 The *KVMFORNFV framework* is developed in the OPNFV community, by the
88 KVMFORNFV_ team.
89
90 4   Release Data
91 ================
92
93 +--------------------------------------+--------------------------------------+
94 | **Project**                          | NFV Hypervisors-KVM                  |
95 |                                      |                                      |
96 +--------------------------------------+--------------------------------------+
97 | **Repo/commit-ID**                   | kvmfornfv                            |
98 |                                      |                                      |
99 +--------------------------------------+--------------------------------------+
100 | **Release designation**              | Colorado                             |
101 |                                      |                                      |
102 +--------------------------------------+--------------------------------------+
103 | **Release date**                     | 2016-08-22                           |
104 |                                      |                                      |
105 +--------------------------------------+--------------------------------------+
106 | **Purpose of the delivery**          | OPNFV Colorado Releases              |
107 |                                      |                                      |
108 +--------------------------------------+--------------------------------------+
109
110 4.1 Version change
111 ------------------
112
113 4.1.1   Module version changes
114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115 This is the first tracked release of KVMFORNFV
116
117
118 4.1.2   Document version changes
119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120 This is the initial version of the KVMFORNFV framework in OPNFV.
121
122 4.2 Reason for version
123 ----------------------
124
125 4.2.1 Feature additions
126 ~~~~~~~~~~~~~~~~~~~~~~~
127
128 +--------------------------------------+--------------------------------------+
129 | **JIRA REFERENCE**                   | **SLOGAN**                           |
130 |                                      |                                      |
131 +--------------------------------------+--------------------------------------+
132 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-34      |
133 |                                      |                                      |
134 +--------------------------------------+--------------------------------------+
135 | JIRA:                                | NFV Hypervisors-KVMKVMFORNFV-34      |
136 |                                      |                                      |
137 +--------------------------------------+--------------------------------------+
138
139 4.2.2 Bug corrections
140 ~~~~~~~~~~~~~~~~~~~~~
141
142 Initial Release
143
144 4.3 Deliverables
145 ----------------
146
147 4.3.1   Software deliverables
148 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149 KVMFORNFV framework source code <Colorado>
150
151 4.3.2   Documentation deliverables
152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
154 The below documents are delivered for Colorado KVMFORNFV Release:
155
156   * User Guide
157
158   * Configuration Guide
159
160   * Installation Procedure
161
162   * Overview
163
164   * Release notes (this document)
165
166   * Glossary
167
168
169 5  References
170 =============
171
172 For more information on the KVMFORNFV Colorado release, please see:
173
174 https://wiki.opnfv.org/display/kvm/