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