Fuel@OPNFV rebase due to upstrem changes
[genesis.git] / fuel / docs / src / release-notes.rst
1 :Authors: Jonas Bjurel (Ericsson)
2 :Version: 0.1
3
4 ======================================================================
5 OPNFV Release Note for "Arno-SRx release" - < Component denomination >
6 ======================================================================
7
8 Abstract
9 ========
10
11 This document provides the release notes for <RELEASE> of <COMPONENT>.
12
13 License
14 =======
15 <WORK'S NAME> (c) by <AUTHOR'S NAME>
16
17 <WORK'S NAME> is licensed under a Creative Commons Attribution 4.0 Unported License. You should have received a copy of the license along with this. If not, see <http://creativecommons.org/licenses/by/4.0/>.
18
19
20 **Contents**
21
22 1  Version History
23
24 2  Important notes
25
26 3  Summary
27
28 4  Delivery Data
29
30 5 Known Limitations, Issues and Workarounds
31
32 6 Test Result
33
34 7 References
35
36 1   Version history
37 ===================
38
39 +--------------------+--------------------+--------------------+--------------------+
40 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
41 |                    |                    |                    |                    |
42 +--------------------+--------------------+--------------------+--------------------+
43 | 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |
44 |                    |                    |                    |                    |
45 +--------------------+--------------------+--------------------+--------------------+
46 |                    | 0.1.1              |                    |                    |
47 |                    |                    |                    |                    |
48 +--------------------+--------------------+--------------------+--------------------+
49 |                    | 1.0                |                    |                    |
50 |                    |                    |                    |                    |
51 +--------------------+--------------------+--------------------+--------------------+
52
53 2   Important notes
54 ===================
55
56 <STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
57
58 <EXAMPLE>:
59
60 **Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master – see the OPNFV@Fuel SW installation instructions
61
62 3   Summary
63 ===========
64
65 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
66
67 <EXAMPLE>:
68
69 Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1, but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......
70
71 4   Release Data
72 ================
73 <STATE RELEVANT RELEASE DATA/RECORDS>
74
75 <EXAMPLE>:
76
77 +--------------------------------------+--------------------------------------+
78 | **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
79 |                                      |                                      |
80 +--------------------------------------+--------------------------------------+
81 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
82 |                                      |                                      |
83 +--------------------------------------+--------------------------------------+
84 | **Release designation**              | E.g. Arno RC2                        |
85 |                                      |                                      |
86 +--------------------------------------+--------------------------------------+
87 | **Release date**                     | E.g. 2015-04-16                      |
88 |                                      |                                      |
89 +--------------------------------------+--------------------------------------+
90 | **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
91 |                                      |                                      |
92 +--------------------------------------+--------------------------------------+
93
94 4.1 Version change
95 ------------------
96
97 4.1.1   Module version changes
98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99 <STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>
100
101 <EXAMPLE>:
102
103 - Fuel have changed from 5.1 to 6.0.1
104
105 - OpenDaylight has changed from Helium-SR1 to Helium-SR2
106
107 4.1.2   Document version changes
108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109 <STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
110
111 <EXAMPLE>:
112
113 - The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
114
115 4.2 Reason for version
116 ----------------------
117 4.2.1 Feature additions
118 ~~~~~~~~~~~~~~~~~~~~~~~
119 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
120
121 <EXAMPLE>:
122
123 **JIRA BACK-LOG:**
124
125 +--------------------------------------+--------------------------------------+
126 | **JIRA REFERENCE**                   | **SLOGAN**                           |
127 |                                      |                                      |
128 +--------------------------------------+--------------------------------------+
129 | BGS-123                              | ADD OpenDaylight ml2 integration     |
130 |                                      |                                      |
131 +--------------------------------------+--------------------------------------+
132 | BGS-456                              | Add auto-deployment of Fuel@OPNFV    |
133 |                                      |                                      |
134 +--------------------------------------+--------------------------------------+
135
136 4.2.2 Bug corrections
137 ~~~~~~~~~~~~~~~~~~~~~
138
139 **JIRA TICKETS:**
140
141 +--------------------------------------+--------------------------------------+
142 | **JIRA REFERENCE**                   | **SLOGAN**                           |
143 |                                      |                                      |
144 +--------------------------------------+--------------------------------------+
145 | BGS-888                              | Fuel doesn't deploy                  |
146 |                                      |                                      |
147 +--------------------------------------+--------------------------------------+
148 | BGS-999                              | Floating IP doesn't work             |
149 |                                      |                                      |
150 +--------------------------------------+--------------------------------------+
151
152 4.3 Deliverables
153 ----------------
154
155 4.3.1   Software deliverables
156 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
157
158 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
159
160 <EXAMPLE>:
161
162 4.3.2   Documentation deliverables
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164
165 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
166
167 <EXAMPLE>:
168
169 5  Known Limitations, Issues and Workarounds
170 ============================================
171
172 5.1    System Limitations
173 -------------------------
174 <STATE ALL RELEVANT SYSTEM LIMITATIONS>
175
176 <EXAMPLE>:
177
178 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
179
180 **Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
181
182 **Storage:**    Ceph is the only supported storage configuration.
183
184 **Max number of networks:**   3800 (Needs special switch config.)
185
186 **L3Agent:**   L3 agent and floating IPs is not supported.
187
188 5.2    Known issues
189 -------------------
190 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
191
192 <EXAMPLE>:
193
194 **JIRA TICKETS:**
195
196 +--------------------------------------+--------------------------------------+
197 | **JIRA REFERENCE**                   | **SLOGAN**                           |
198 |                                      |                                      |
199 +--------------------------------------+--------------------------------------+
200 | BGS-987                              | Nova-compute process does            |
201 |                                      | not re-spawn when killed             |
202 |                                      |                                      |
203 +--------------------------------------+--------------------------------------+
204 | BGS-654                              | MOS 5.1 : neutron net-list returns   |
205 |                                      | "400 Bad request"                    |
206 |                                      |                                      |
207 +--------------------------------------+--------------------------------------+
208
209 5.3    Workarounds
210 ------------------
211
212 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>
213
214 <EXAMPLE>:
215
216 - In case the contact with a compute is lost - restart the compute host
217 - In case the disk is full on a controller - delete all files in /tmp
218
219 6  Test Result
220 ==============
221 <STATE THE QA COVERAGE AND RESULTS>
222
223 <EXAMPLE>:
224
225 Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
226
227 +--------------------------------------+--------------------------------------+
228 | **TEST-SUITE**                       | **Results:**                         |
229 |                                      |                                      |
230 +--------------------------------------+--------------------------------------+
231 | Tempest test suite 123               | Following tests failed:              |
232 |                                      |                                      |
233 |                                      | 1. Image resizing....                |
234 |                                      |                                      |
235 |                                      | 2. Heat deploy....                   |
236 +--------------------------------------+--------------------------------------+
237 | Robot test suite 456                 | Following tests failed:              |
238 |                                      |                                      |
239 |                                      | 1.......                             |
240 |                                      |                                      |
241 |                                      | 2.......                             |
242 +--------------------------------------+--------------------------------------+
243
244 7  References
245 =============
246 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
247
248 <EXAMPLE>:
249
250 For more information on the OPNFV Arno release, please see:
251
252 http://wiki.opnfv.org/release/arno