Merge "Create Compass build script."
[genesis.git] / fuel / docs / src / release-notes.rst
1 :Authors: Jonas Bjurel (Ericsson)
2 :Version: 0.2
3
4 ================================================================
5 OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV
6 ================================================================
7
8 Abstract
9 ========
10
11 This document provides the release notes for ARNO-RC2 release candidate of Fuel@OPNFV.
12
13 License
14 =======
15 Fuel@OPNFV DOCs (c) by Jonas Bjurel (Ericsson AB)
16
17 Fuel@OPNFV DOCs are licensed under a Creative Commons Attribution 4.0 International 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-16         | 0.1                | Jonas Bjurel       | First draft        |
44 |                    |                    |                    |                    |
45 +--------------------+--------------------+--------------------+--------------------+
46 | 2015-04-23         | 0.2                | Jonas Bjurel       | Minor change       |
47 |                    |                    |                    |                    |
48 +--------------------+--------------------+--------------------+--------------------+
49
50 2   Important notes
51 ===================
52
53 This is the first OPNFV Arno pre-release that implements the deploy stage of the OPNFV CI pipeline.
54
55 Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be ran befor deployment is started.
56
57 3   Summary
58 ===========
59
60 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.
61
62 This Arno pre-release of Fuel@OPNFV adds the deploy stage of the OPNFV CI pipeline
63
64 - Documentation is built by Jenkins
65 - .iso image is built by Jenkins
66 - Jenkins deploy an Fuel@OPNFV stack instance on a nested hypervisor environment (KVM)
67
68 Automatic test of the deployed system is not part of this pre-release.
69
70 4   Release Data
71 ================
72
73 +--------------------------------------+--------------------------------------+
74 | **Project**                          | Arno/genesis/fuel                    |
75 |                                      |                                      |
76 +--------------------------------------+--------------------------------------+
77 | **Repo/tag**                         | genesis/arno-rc2                     |
78 |                                      |                                      |
79 +--------------------------------------+--------------------------------------+
80 | **Release designation**              | Arno RC2                             |
81 |                                      |                                      |
82 +--------------------------------------+--------------------------------------+
83 | **Release date**                     | 2015-04-16                           |
84 |                                      |                                      |
85 +--------------------------------------+--------------------------------------+
86 | **Purpose of the delivery**          | OPNFV Internal quality assurance     |
87 |                                      | and CI Pipline dry-run               |
88 |                                      |                                      |
89 +--------------------------------------+--------------------------------------+
90
91 4.1 Version change
92 ------------------
93
94 4.1.1   Module version changes
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96 This is the first tracked version of genesis/fuel. It is based on following upstream versions:
97
98 - Fuel 6.0.1 (Juno release)
99
100 - OpenDaylight Helium-SR2
101
102 - Ubuntu 12.04.5
103
104 4.1.2   Document version changes
105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106 This is the first tracked version of genesis/fuel. It comes with the following documentation:
107
108 - OPNFV Installation instructions for - Fuel@OPNFV - ver. 0.0.1
109 - OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV - ver. 0.1 (this document)
110
111 4.2 Reason for version
112 ----------------------
113 4.2.1 Feature additions
114 ~~~~~~~~~~~~~~~~~~~~~~~
115
116 +--------------------------------------+--------------------------------------+
117 | **JIRA REFERENCE**                   | **SLOGAN**                           |
118 |                                      |                                      |
119 +--------------------------------------+--------------------------------------+
120 | JIRA:                                | Baselining Fuel 6.0.1 for OPNFV      |
121 |                                      |                                      |
122 +--------------------------------------+--------------------------------------+
123 | JIRA:                                | Integration of OpenDaylight          |
124 |                                      |                                      |
125 +--------------------------------------+--------------------------------------+
126
127 4.2.2 Bug corrections
128 ~~~~~~~~~~~~~~~~~~~~~
129
130 **JIRA TICKETS:**
131
132 +--------------------------------------+--------------------------------------+
133 | **JIRA REFERENCE**                   | **SLOGAN**                           |
134 |                                      |                                      |
135 +--------------------------------------+--------------------------------------+
136 |                                      |                                      |
137 |                                      |                                      |
138 +--------------------------------------+--------------------------------------+
139
140 4.3 Deliverables
141 ----------------
142
143 4.3.1   Software deliverables
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145 Fuel@OPNFV .iso file
146
147 4.3.2   Documentation deliverables
148 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149 - OPNFV Installation instructions for - Fuel@OPNFV - ver. 0.0.1
150 - OPNFV Release Note for "Arno-RC2 release candidate" - Fuel@OPNFV - ver. 0.1 (this document)
151
152 5  Known Limitations, Issues and Workarounds
153 ============================================
154
155 5.1    System Limitations
156 -------------------------
157
158 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
159
160 **Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
161
162 **Storage:**    Ceph is the only supported storage configuration.
163
164 **Max number of networks:**   3800 (Needs special switch config.)
165
166 **L3Agent:**   L3 agent and floating IPs is not supported.
167
168 5.2    Known issues
169 -------------------
170
171 **JIRA TICKETS:**
172
173 +--------------------------------------+--------------------------------------+
174 | **JIRA REFERENCE**                   | **SLOGAN**                           |
175 |                                      |                                      |
176 +--------------------------------------+--------------------------------------+
177 | JIRA:                                | CentOS is not supported              |
178 |                                      |                                      |
179 +--------------------------------------+--------------------------------------+
180
181 5.3    Workarounds
182 ------------------
183 **-**
184
185
186 6  Test Result
187 ==============
188
189 Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
190
191 +--------------------------------------+--------------------------------------+
192 | **TEST-SUITE**                       | **Results:**                         |
193 |                                      |                                      |
194 +--------------------------------------+--------------------------------------+
195 | **-**                                | **-**                                |
196 +--------------------------------------+--------------------------------------+
197
198
199 7  References
200 =============
201
202 For more information on the OPNFV Arno release, please see:
203
204 http://wiki.opnfv.org/release/arno