summaryrefslogtreecommitdiffstats
path: root/docs/releasenotes/release-notes.rst
blob: 52b676ecf626c73cfd6c91b4de12cdcbc8f1f6ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
==========================================================================
OPNFV Release Notes for the Colorado release of OPNFV Apex deployment tool
==========================================================================


.. contents:: Table of Contents
   :backlinks: none


Abstract
========

This document provides the release notes for Colorado release with the Apex
deployment toolchain.

License
=======

All Apex and "common" entities are protected by the Apache License
( http://www.apache.org/licenses/ )


Version History
===============


+-------------+-----------+-----------------+----------------------+
| **Date**    | **Ver.**  | **Authors**     | **Comment**          |
|             |           |                 |                      |
+-------------+-----------+-----------------+----------------------+
| 2016-09-20  | 2.1.0     | Tim Rozet       | More updates for     |
|             |           |                 | Colorado             |
+-------------+-----------+-----------------+----------------------+
| 2016-08-11  | 2.0.0     | Dan Radez       | Updates for Colorado |
+-------------+-----------+-----------------+----------------------+
| 2015-09-17  | 1.0.0     | Dan Radez       | Rewritten for        |
|             |           |                 | RDO Manager update   |
+-------------+-----------+-----------------+----------------------+

Important Notes
===============

This is the OPNFV Colorado release that implements the deploy stage of the
OPNFV CI pipeline via Apex.

Apex is based on RDO's Triple-O installation tool chain.
More information at http://rdoproject.org

Carefully follow the installation-instructions which guide a user on how to
deploy OPNFV using Apex installer.

Summary
=======

Colorado release with the Apex deployment toolchain will establish an OPNFV
target system on a Pharos compliant lab infrastructure.  The current definition
of an OPNFV target system is OpenStack Mitaka combined with an SDN
controller, such as OpenDaylight.  The system is deployed with OpenStack High
Availability (HA) for most OpenStack services.  SDN controllers are deployed
only on the first controller (see HAIssues_ for known HA SDN issues).  Ceph
storage is used as Cinder backend, and is the only supported storage for
Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
node in an HA setup.  Apex also supports non-HA deployments, which deploys a
single controller and n number of compute nodes.  Furthermore, Apex is
capable of deploying scenarios in a bare metal or virtual fashion.  Virtual
deployments use multiple VMs on the jump host and internal networking to
simulate the a bare metal deployment.

- Documentation is built by Jenkins
- .iso image is built by Jenkins
- .rpm packages are built by Jenkins
- Jenkins deploys a Colorado release with the Apex deployment toolchain
  bare metal, which includes 3 control+network nodes, and 2 compute nodes.

Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | apex                                 |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | apex/colorado.1.0                    |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | colorado.1.0                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 2016-09-22                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV Colorado release               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Version change
--------------

Module version changes
~~~~~~~~~~~~~~~~~~~~~~
This is the first tracked version of the Colorado release with the Apex
deployment toolchain.  It is based on following upstream versions:

- OpenStack (Mitaka release)

- OpenDaylight (Beryllium/Boron releases)

- CentOS 7

Document Version Changes
~~~~~~~~~~~~~~~~~~~~~~~~

This is the first tracked version of Colorado release with the Apex
deployment toolchain.
The following documentation is provided with this release:

- OPNFV Installation instructions for the Colorado release with the Apex
  deployment toolchain - ver. 1.0.0
- OPNFV Release Notes for the Colorado release with the Apex deployment
  toolchain - ver. 1.0.0 (this document)

Feature Additions
~~~~~~~~~~~~~~~~~

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-107                       | OpenDaylight HA - OVSDB Clustering   |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-108                       | Migrate to OpenStack Mitaka          |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-30                        | Support VLAN tagged deployments      |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-105                       | Enable Huge Page Configuration       |
|                                      | Options                              |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-111                       | Allow RAM to be specified for        |
|                                      | Control/Compute in Virtual           |
|                                      | Deployments                          |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-119                       | Enable OVS DPDK as a deployment      |
|                                      | Scenario in Apex                     |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-126                       | Tacker Service deployed by Apex      |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-135                       | Congress Service deployed by Apex    |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-127                       | Nova Instance CPU Pinning            |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-130                       | IPv6 Underlay Deployment             |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-133                       | FDIO with Honeycomb Agent            |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-141                       | Integrate VSPERF into Apex           |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-172                       | Enable ONOS SFC                      |
+--------------------------------------+--------------------------------------+

Bug Corrections
~~~~~~~~~~~~~~~

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-86                        | Need ability to specify number of    |
|                                      | compute nodes                        |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-180                       | Baremetal deployment error: Failed to|
|                                      | mount root partition /dev/sda on     |
|                                      | /mnt/rootfs                          |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-161                       | Heat autoscaling stack creation fails|
|                                      | for non-admin users                  |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-198                       | Missing NAT iptables rule for public |
|                                      | network in instack VM                |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-147                       | Installer doesn't generate/distribute|
|                                      | SSH keys between compute nodes       |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-109                       | ONOS routes local subnet traffic to  |
|                                      | GW                                   |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-146                       | Swift service present in available   |
|                                      | endpoints                            |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-160                       | Enable force_metadata to support     |
|                                      | subnets with VM as the router        |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-114                       | OpenDaylight GUI is not available    |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-100                       | DNS1 and DNS2 should be handled in   |
|                                      | nic bridging                         |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-100                       | DNS1 and DNS2 should be handled in   |
|                                      | nic bridging                         |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-155                       | NIC Metric value not used when       |
|                                      | bridging NICs                        |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-136                       | 2 network deployment fails           |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-89                        | Deploy Ceph OSDs on compute nodes    |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-137                       | added arping ass dependency for      |
|                                      | ONOS deployments                     |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-121                       | VM Storage deletion intermittently   |
|                                      | fails                                |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-182                       | Nova services not correctly deployed |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-153                       | brbm bridge not created in jumphost  |
+--------------------------------------+--------------------------------------+

Deliverables
------------

Software Deliverables
~~~~~~~~~~~~~~~~~~~~~
- Apex .iso file
- Apex overcloud .rpm (opnfv-apex) - For nosdn and OpenDaylight Scenarios
- Apex overcloud onos .rpm (opnfv-apex-onos) - ONOS Scenarios
- Apex overcloud ODL SFC .rpm (opnfv-apex-opendaylight-sfc) - ODL SFC Scenario
- Apex undercloud .rpm (opnfv-apex-undercloud)
- Apex common .rpm (opnfv-apex-common)
- build.sh - Builds the above artifacts
- opnfv-deploy - Automatically deploys Target OPNFV System
- opnfv-clean - Automatically resets a Target OPNFV Deployment
- opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight

Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
- OPNFV Installation instructions for the Colorado release with the Apex
  deployment toolchain - ver. 1.0.0
- OPNFV Release Notes for the Colorado release with the Apex deployment
  toolchain - ver. 1.0.0 (this document)

Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------

**Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades

**Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade

**Storage:**    Ceph is the only supported storage configuration.

**Min master requirements:** At least 16GB of RAM for baremetal jumphost,
24GB for virtual deployments (noHA).


Known Issues
------------

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-203                       | Swift proxy enabled and fails in noha|
|                                      | deployments                          |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-215                       | Keystone services not configured and |
|                                      | the error is silently ignored (VLAN  |
|                                      | Deployments)                         |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-208                       | Need ability to specify which NIC to |
|                                      | place VLAN on                        |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-254                       | Add dynamic hugepages configuration  |
+--------------------------------------+--------------------------------------+
| JIRA: APEX-138                       | Unclear error message when interface |
|                                      | set to dhcp                          |
+--------------------------------------+--------------------------------------+


Workarounds
-----------
**-**

Scenario specific release notes
===============================

Scenario os-odl_l3-nofeature known issues
-----------------------------------------

* `APEX-112 <https://jira.opnfv.org/browse/APEX-112>`_:
   ODL routes local subnet traffic to GW

Scenario os-odl_l2-nofeature known issues
-----------------------------------------

* `APEX-149 <https://jira.opnfv.org/browse/APEX-149>`_:
   Openflow rules are populated very slowly

Scenario os-odl_l2-bgpvpn known issues
--------------------------------------

* `APEX-278 <https://jira.opnfv.org/browse/APEX-278>`_:
   Duplicate neutron config class declaration for SDNVPN

Scenario os-onos-nofeatures/os-onos-sfc known issues
----------------------------------------------------

* `APEX-281 <https://jira.opnfv.org/browse/APEX-281>`_:
   ONOS sometimes fails to provide addresses to instances

Scenario os-odl_l2-sfc-noha known issues
----------------------------------------

* `APEX-275 <https://jira.opnfv.org/browse/APEX-275>`_:
   Metadata fails in Boron

Scenario os-nosdn-ovs known issues
----------------------------------

* `APEX-274 <https://jira.opnfv.org/browse/APEX-274>`_:
   OVS DPDK scenario does not create vhost user ports

Scenario os-odl_l2-fdio-noha known issues
-----------------------------------------

* `FDS-16 <https://jira.opnfv.org/browse/FDS-16>`_:
   Security group configuration through nova leads
   to vhostuser port connection issues
* `FDS-62 <https://jira.opnfv.org/browse/FDS-62>`_:
   APEX - Increase number of files MariaDB can open
* `FDS-79 <https://jira.opnfv.org/browse/FDS-79>`_:
   Sometimes (especially in bulk crete/delete operations
   when multiple networks/ports are created within short time)
   OpenDaylight doesn't accept creation requests
* `FDS-80 <https://jira.opnfv.org/browse/FDS-80>`_:
   After launching a VM it stayed forever in BUILD status.
   Also further operation related to this VM (volume attachment etc.)
   caused problems
* `FDS-81 <https://jira.opnfv.org/browse/FDS-81>`_:
   After functest finishes there are two bds on computes and
   none on controller
* `FDS-82 <https://jira.opnfv.org/browse/FDS-82>`_:
   Nova list shows no vms but there are some on computes in paused state
* `APEX-217 <https://jira.opnfv.org/browse/APEX-217>`_:
   qemu not configured with correct group:user

.. _HAIssues:

General HA scenario known issues
--------------------------------

* `COPPER-22 <https://jira.opnfv.org/browse/COPPER-22>`_:
   Congress service HA deployment is not yet supported/verified.
* `APEX-276 <https://jira.opnfv.org/browse/APEX-276>`_:
   ODL HA unstable and crashes frequently

Test Result
===========

The Colorado release with the Apex deployment toolchain has undergone QA
test runs with the following results:

+--------------------------------------+--------------------------------------+
| **TEST-SUITE**                       | **Results:**                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **-**                                | **-**                                |
+--------------------------------------+--------------------------------------+


References
==========

For more information on the OPNFV Colorado release, please see:

http://wiki.opnfv.org/releases/Colorado

:Authors: Tim Rozet (trozet@redhat.com)
:Authors: Dan Radez (dradez@redhat.com)
:Version: 2.1.0