Updates docs for Danube 3.0
[apex.git] / docs / release / release-notes / release-notes.rst
1 ========================================================================
2 OPNFV Release Notes for the Danube release of OPNFV Apex deployment tool
3 ========================================================================
4
5
6 .. contents:: Table of Contents
7    :backlinks: none
8
9
10 Abstract
11 ========
12
13 This document provides the release notes for Danube release with the Apex
14 deployment toolchain.
15
16 License
17 =======
18
19 All Apex and "common" entities are protected by the Apache License
20 ( http://www.apache.org/licenses/ )
21
22
23 Version History
24 ===============
25
26
27 +-------------+-----------+-----------------+----------------------+
28 | **Date**    | **Ver.**  | **Authors**     | **Comment**          |
29 |             |           |                 |                      |
30 +-------------+-----------+-----------------+----------------------+
31 | 2017-06-08  | 4.2       | Tim Rozet       | Danube 3.0 Update    |
32 +-------------+-----------+-----------------+----------------------+
33 | 2017-05-04  | 4.1       | Tim Rozet       | Danube 2.0 Update    |
34 +-------------+-----------+-----------------+----------------------+
35 | 2017-03-30  | 4.0       | Tim Rozet       | Updates for Danube   |
36 +-------------+-----------+-----------------+----------------------+
37 | 2016-09-20  | 2.1.0     | Tim Rozet       | More updates for     |
38 |             |           |                 | Colorado             |
39 +-------------+-----------+-----------------+----------------------+
40 | 2016-08-11  | 2.0.0     | Dan Radez       | Updates for Colorado |
41 +-------------+-----------+-----------------+----------------------+
42 | 2015-09-17  | 1.0.0     | Dan Radez       | Rewritten for        |
43 |             |           |                 | RDO Manager update   |
44 +-------------+-----------+-----------------+----------------------+
45
46 Important Notes
47 ===============
48
49 This is the OPNFV Danube release that implements the deploy stage of the
50 OPNFV CI pipeline via Apex.
51
52 Apex is based on RDO's Triple-O installation tool chain.
53 More information at http://rdoproject.org
54
55 Carefully follow the installation-instructions which guide a user on how to
56 deploy OPNFV using Apex installer.
57
58 Summary
59 =======
60
61 Danube release with the Apex deployment toolchain will establish an OPNFV
62 target system on a Pharos compliant lab infrastructure.  The current definition
63 of an OPNFV target system is OpenStack Newton combined with an SDN
64 controller, such as OpenDaylight.  The system is deployed with OpenStack High
65 Availability (HA) for most OpenStack services.  SDN controllers are deployed
66 on every controller unless deploying with one the HA FD.IO scenarios.  Ceph
67 storage is used as Cinder backend, and is the only supported storage for
68 Danube.  Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
69 node in an HA setup.  Apex also supports non-HA deployments, which deploys a
70 single controller and n number of compute nodes.  Furthermore, Apex is
71 capable of deploying scenarios in a bare metal or virtual fashion.  Virtual
72 deployments use multiple VMs on the jump host and internal networking to
73 simulate the a bare metal deployment.
74
75 - Documentation is built by Jenkins
76 - .iso image is built by Jenkins
77 - .rpm packages are built by Jenkins
78 - Jenkins deploys a Danube release with the Apex deployment toolchain
79   bare metal, which includes 3 control+network nodes, and 2 compute nodes.
80
81 Release Data
82 ============
83
84 +--------------------------------------+--------------------------------------+
85 | **Project**                          | apex                                 |
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88 | **Repo/tag**                         | apex/danube.3.0                      |
89 |                                      |                                      |
90 +--------------------------------------+--------------------------------------+
91 | **Release designation**              | danube.3.0                           |
92 |                                      |                                      |
93 +--------------------------------------+--------------------------------------+
94 | **Release date**                     | 2017-05-05                           |
95 |                                      |                                      |
96 +--------------------------------------+--------------------------------------+
97 | **Purpose of the delivery**          | OPNFV Danube 3.0 release             |
98 |                                      |                                      |
99 +--------------------------------------+--------------------------------------+
100
101 Version change
102 --------------
103
104 Module version changes
105 ~~~~~~~~~~~~~~~~~~~~~~
106 This is the first tracked version of the Danube release with the Apex
107 deployment toolchain.  It is based on following upstream versions:
108
109 - OpenStack (Newton release)
110
111 - OpenDaylight (Boron/Carbon releases)
112
113 - CentOS 7
114
115 Document Version Changes
116 ~~~~~~~~~~~~~~~~~~~~~~~~
117
118 This is the first tracked version of Danube release with the Apex
119 deployment toolchain.
120 The following documentation is provided with this release:
121
122 - OPNFV Installation instructions for the Danube release with the Apex
123   deployment toolchain
124 - OPNFV Release Notes for the Danube release with the Apex deployment
125   toolchain (this document)
126
127 Feature Additions
128 ~~~~~~~~~~~~~~~~~
129
130 +--------------------------------------+--------------------------------------+
131 | **JIRA REFERENCE**                   | **SLOGAN**                           |
132 |                                      |                                      |
133 +--------------------------------------+--------------------------------------+
134 | JIRA: APEX-129                       | Adds OVN SDN Controller support      |
135 +--------------------------------------+--------------------------------------+
136 | JIRA: APEX-299                       | Migrate to OpenStack Newton          |
137 +--------------------------------------+--------------------------------------+
138 | JIRA: APEX-150                       | Allow for multiple external networks |
139 +--------------------------------------+--------------------------------------+
140 | JIRA: APEX-301                       | Support Networking ODL v2 Driver     |
141 +--------------------------------------+--------------------------------------+
142 | JIRA: APEX-300                       | Support OpenDaylight new netvirt     |
143 +--------------------------------------+--------------------------------------+
144 | JIRA: APEX-302                       | Upstream Tacker and Congress         |
145 |                                      | support                              |
146 +--------------------------------------+--------------------------------------+
147 | JIRA: APEX-106                       | Enable CPU pinning for Overcloud     |
148 +--------------------------------------+--------------------------------------+
149 | JIRA: APEX-390                       | OpenDaylight HA as default for HA    |
150 |                                      | scenarios                            |
151 +--------------------------------------+--------------------------------------+
152 | JIRA: APEX-357                       | Include Quagga in SDNVPN scenario    |
153 +--------------------------------------+--------------------------------------+
154 | JIRA: APEX-262                       | Migrate to new network settings      |
155 |                                      | format                               |
156 +--------------------------------------+--------------------------------------+
157 | JIRA: APEX-128                       | Adds Real Time KVM support           |
158 +--------------------------------------+--------------------------------------+
159
160 Bug Corrections
161 ~~~~~~~~~~~~~~~
162
163 **Danube 1.0:**
164
165 +--------------------------------------+--------------------------------------+
166 | **JIRA REFERENCE**                   | **SLOGAN**                           |
167 |                                      |                                      |
168 +--------------------------------------+--------------------------------------+
169 | JIRA: APEX-208                       | Need ability to specify which nic    |
170 |                                      | to place vlan on                     |
171 +--------------------------------------+--------------------------------------+
172 | JIRA: APEX-215                       | Keystone services not configured and |
173 |                                      | error is silently ignored on VLAN    |
174 |                                      | Deployments                          |
175 +--------------------------------------+--------------------------------------+
176 | JIRA: APEX-221                       | NoHA virtual deployments should use 1|
177 |                                      | compute                              |
178 +--------------------------------------+--------------------------------------+
179 | JIRA: APEX-276                       | ODL HA is unstable and crashes       |
180 |                                      | frequently                           |
181 +--------------------------------------+--------------------------------------+
182 | JIRA: APEX-287                       | Name mismatch for package openstack- |
183 |                                      | congress during overcloud build      |
184 +--------------------------------------+--------------------------------------+
185 | JIRA: APEX-339                       | Enable pinning for OVS DPDK          |
186 +--------------------------------------+--------------------------------------+
187 | JIRA: APEX-345                       | Horizon and cloud failures due to    |
188 |                                      | running out of file descriptors for  |
189 |                                      | MariaDB in noha deployments          |
190 +--------------------------------------+--------------------------------------+
191 | JIRA: APEX-370                       | ISO builds fail in Danube            |
192 +--------------------------------------+--------------------------------------+
193 | JIRA: APEX-372                       | Specifying same NIC for storage and  |
194 |                                      | private network but different VLANs  |
195 |                                      | results in duplicate NIC error       |
196 +--------------------------------------+--------------------------------------+
197 | JIRA: APEX-373                       | Running smoke tests should install   |
198 |                                      | Ansible onto jump host               |
199 +--------------------------------------+--------------------------------------+
200 | JIRA: APEX-374                       | Ceph accidentally disabled by default|
201 +--------------------------------------+--------------------------------------+
202 | JIRA: APEX-378                       | OVS 2.5.90 NSH build fails           |
203 +--------------------------------------+--------------------------------------+
204 | JIRA: APEX-382                       | yum update on undercloud breaks      |
205 |                                      | deployments                          |
206 +--------------------------------------+--------------------------------------+
207 | JIRA: APEX-386                       | Fix os-net-config to match upstream  |
208 |                                      | stable/newton                        |
209 +--------------------------------------+--------------------------------------+
210 | JIRA: APEX-398                       | Tacker uses "RegionOne" instead of   |
211 |                                      | "regionOne"                          |
212 +--------------------------------------+--------------------------------------+
213 | JIRA: APEX-399                       | hugepages are not enabled when       |
214 |                                      | configured in deploy settings        |
215 +--------------------------------------+--------------------------------------+
216 | JIRA: APEX-403                       | Remove Quagga from build process and |
217 |                                      | cache to artifacts                   |
218 +--------------------------------------+--------------------------------------+
219 | JIRA: APEX-406                       | ODL FDIO neutron patches to all      |
220 |                                      | scenarios                            |
221 +--------------------------------------+--------------------------------------+
222 | JIRA: APEX-407                       | VPP service does not start upon      |
223 |                                      | reboot                               |
224 +--------------------------------------+--------------------------------------+
225 | JIRA: APEX-408                       | Quagga's bgpd cannot start due to    |
226 |                                      | permissions                          |
227 +--------------------------------------+--------------------------------------+
228 | JIRA: APEX-421                       | Update odl/hc/vpp versions for odl_l3|
229 |                                      | noha                                 |
230 +--------------------------------------+--------------------------------------+
231 | JIRA: APEX-426                       | Missing virtual-computes arg in help |
232 |                                      | output for deploy                    |
233 +--------------------------------------+--------------------------------------+
234 | JIRA: APEX-427                       | Neutron openvswitch agent starts when|
235 |                                      | openvswitch is restarted             |
236 +--------------------------------------+--------------------------------------+
237
238 **Danube 2.0:**
239
240 +--------------------------------------+--------------------------------------+
241 | **JIRA REFERENCE**                   | **SLOGAN**                           |
242 |                                      |                                      |
243 +--------------------------------------+--------------------------------------+
244 | JIRA: APEX-454                       | RPM install fails due to no file     |
245 |                                      | space on overcloud.qcow2 image       |
246 +--------------------------------------+--------------------------------------+
247 | JIRA: APEX-453                       | Using non-1st NIC admin network fails|
248 |                                      | with OVS DPDK                        |
249 +--------------------------------------+--------------------------------------+
250 | JIRA: APEX-452                       | OVS DPDK fails when no cores         |
251 |                                      | specified to pin to                  |
252 +--------------------------------------+--------------------------------------+
253 | JIRA: APEX-451                       | Update VPP/HC/ODL versions for all   |
254 |                                      | FD.IO scenarios                      |
255 +--------------------------------------+--------------------------------------+
256 | JIRA: APEX-450                       | Enable ODL clustering for FD.IO HA   |
257 |                                      | scenarios                            |
258 +--------------------------------------+--------------------------------------+
259 | JIRA: APEX-448                       | Bgpd.pid file is not created during  |
260 |                                      | Apex deployment                      |
261 +--------------------------------------+--------------------------------------+
262 | JIRA: APEX-440                       | Remove schema-cache-directory from   |
263 |                                      | honeycomb mounting in ODL FD.IO      |
264 |                                      | scenarios                            |
265 +--------------------------------------+--------------------------------------+
266 | JIRA: APEX-437                       | Quagga not starting correctly        |
267 +--------------------------------------+--------------------------------------+
268 | JIRA: APEX-416                       | Honeycomb does not mount correctly   |
269 |                                      | in ODL HA on baremetal               |
270 +--------------------------------------+--------------------------------------+
271 | JIRA: APEX-410                       | Need to limit number of workers per  |
272 |                                      | OpenStack service for baremetal      |
273 |                                      | deployments                          |
274 +--------------------------------------+--------------------------------------+
275 | JIRA: APEX-409                       | Undercloud failed to properly install|
276 +--------------------------------------+--------------------------------------+
277 | JIRA: APEX-270                       | Glance V2 API does not support URL   |
278 |                                      | for images                           |
279 +--------------------------------------+--------------------------------------+
280
281 **Danube 3.0:**
282
283 +--------------------------------------+--------------------------------------+
284 | **JIRA REFERENCE**                   | **SLOGAN**                           |
285 |                                      |                                      |
286 +--------------------------------------+--------------------------------------+
287 | JIRA: APEX-461                       | Missing openstack-mistral rpms       |
288 +--------------------------------------+--------------------------------------+
289 | JIRA: APEX-458                       | openstack-heat-engine installation   |
290 |                                      | fails during undercloud deployment   |
291 +--------------------------------------+--------------------------------------+
292 | JIRA: APEX-457                       | VPP fails to start due to messed up  |
293 |                                      | startup.conf file                    |
294 +--------------------------------------+--------------------------------------+
295 | JIRA: APEX-455                       | Update puppet-opendaylight repo      |
296 |                                      | location                             |
297 +--------------------------------------+--------------------------------------+
298 | JIRA: APEX-448                       | Bgpd.pid file is not created during  |
299 |                                      | Apex deployment                      |
300 +--------------------------------------+--------------------------------------+
301 | JIRA: APEX-446                       | Tacker does not start correctly      |
302 +--------------------------------------+--------------------------------------+
303
304 Deliverables
305 ------------
306
307 Software Deliverables
308 ~~~~~~~~~~~~~~~~~~~~~
309 - Apex .iso file
310 - Apex release .rpm (opnfv-apex-release)
311 - Apex overcloud .rpm (opnfv-apex) - For nosdn and OpenDaylight Scenarios
312 - Apex undercloud .rpm (opnfv-apex-undercloud)
313 - Apex common .rpm (opnfv-apex-common)
314 - build.sh - Builds the above artifacts
315 - opnfv-deploy - Automatically deploys Target OPNFV System
316 - opnfv-clean - Automatically resets a Target OPNFV Deployment
317 - opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight
318
319 Documentation Deliverables
320 ~~~~~~~~~~~~~~~~~~~~~~~~~~
321 - OPNFV Installation instructions for the Danube release with the Apex
322   deployment toolchain - ver. 4.0
323 - OPNFV Release Notes for the Danube release with the Apex deployment
324   toolchain - ver. 4.2 (this document)
325
326 Known Limitations, Issues and Workarounds
327 =========================================
328
329 System Limitations
330 ------------------
331
332 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
333
334 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
335
336 **Storage:**    Ceph is the only supported storage configuration.
337
338 **Min master requirements:** At least 16GB of RAM for baremetal jumphost,
339 24GB for virtual deployments (noHA).
340
341
342 Known Issues
343 ------------
344
345 **JIRA TICKETS:**
346
347 +--------------------------------------+--------------------------------------+
348 | **JIRA REFERENCE**                   | **SLOGAN**                           |
349 |                                      |                                      |
350 +--------------------------------------+--------------------------------------+
351 | JIRA: APEX-138                       | Unclear error message when interface |
352 |                                      | set to dhcp                          |
353 +--------------------------------------+--------------------------------------+
354 | JIRA: APEX-268                       | VMs with floating IPs can only access|
355 |                                      | via the first NIC                    |
356 +--------------------------------------+--------------------------------------+
357 | JIRA: APEX-280                       | Deleted network not cleaned up       |
358 |                                      | on controller                        |
359 +--------------------------------------+--------------------------------------+
360 | JIRA: APEX-290                       | Instances cannot connect to metadata |
361 |                                      | after cluster reboot                 |
362 +--------------------------------------+--------------------------------------+
363 | JIRA: APEX-295                       | Missing support for VLAN tenant      |
364 |                                      | networks                             |
365 +--------------------------------------+--------------------------------------+
366 | JIRA: APEX-352                       | Package "openstack-utils" is         |
367 |                                      | missing from overcloud               |
368 +--------------------------------------+--------------------------------------+
369 | JIRA: APEX-368                       | Ceilometer stores samples and events |
370 |                                      | forever                              |
371 +--------------------------------------+--------------------------------------+
372 | JIRA: APEX-371                       | Ceph partitions need to be prepared  |
373 |                                      | on deployment when using 2nd disk    |
374 +--------------------------------------+--------------------------------------+
375 | JIRA: APEX-375                       | Default glance storage points to     |
376 |                                      | http,swift when ceph disabled        |
377 +--------------------------------------+--------------------------------------+
378 | JIRA: APEX-384                       | Not defining odl_version in deploy   |
379 |                                      | settings leads to error              |
380 +--------------------------------------+--------------------------------------+
381 | JIRA: APEX-389                       | Compute kernel parameters are used   |
382 |                                      | for all nodes                        |
383 +--------------------------------------+--------------------------------------+
384 | JIRA: APEX-412                       | Install failures with UEFI           |
385 +--------------------------------------+--------------------------------------+
386 | JIRA: APEX-415                       | br-phy DPDK interfaces are not       |
387 |                                      | brought up by os-net-config          |
388 +--------------------------------------+--------------------------------------+
389 | JIRA: APEX-417                       | Missing OVS 2.6 + NSH support        |
390 +--------------------------------------+--------------------------------------+
391 | JIRA: APEX-419                       | opnfv-clean sometimes leaves admin   |
392 |                                      | and public network down              |
393 +--------------------------------------+--------------------------------------+
394 | JIRA: APEX-422                       | First nova instance DHCP request     |
395 |                                      | fails                                |
396 +--------------------------------------+--------------------------------------+
397 | JIRA: APEX-425                       | Need to tweak performance settings   |
398 |                                      | virtual DPDK scenarios               |
399 +--------------------------------------+--------------------------------------+
400 | JIRA: APEX-442                       | ONOS cluster mode deployment in Apex |
401 |                                      | D release                            |
402 +--------------------------------------+--------------------------------------+
403 | JIRA: APEX-446                       | Tacker does not start correctly      |
404 +--------------------------------------+--------------------------------------+
405 | JIRA: APEX-449                       | Domino fails in CI                   |
406 +--------------------------------------+--------------------------------------+
407
408 Workarounds
409 -----------
410 **-**
411
412
413 Test Result
414 ===========
415
416 Please reference Functest project documentation for test results with the
417 Apex installer.
418
419
420 References
421 ==========
422
423 For more information on the OPNFV Danube release, please see:
424
425 http://wiki.opnfv.org/releases/Danube
426
427 :Authors: Tim Rozet (trozet@redhat.com)
428 :Authors: Dan Radez (dradez@redhat.com)
429 :Version: 4.2