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