Merge "Handling file loads and tmp dirs differently"
[apex.git] / docs / releasenotes / release-notes.rst
1 ==========================================================================
2 OPNFV Release Notes for the Colorado 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 Colorado 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 | 2016-09-20  | 2.1.0     | Tim Rozet       | More updates for     |
32 |             |           |                 | Colorado             |
33 +-------------+-----------+-----------------+----------------------+
34 | 2016-08-11  | 2.0.0     | Dan Radez       | Updates for Colorado |
35 +-------------+-----------+-----------------+----------------------+
36 | 2015-09-17  | 1.0.0     | Dan Radez       | Rewritten for        |
37 |             |           |                 | RDO Manager update   |
38 +-------------+-----------+-----------------+----------------------+
39
40 Important Notes
41 ===============
42
43 This is the OPNFV Colorado release that implements the deploy stage of the
44 OPNFV CI pipeline via Apex.
45
46 Apex is based on RDO's Triple-O installation tool chain.
47 More information at http://rdoproject.org
48
49 Carefully follow the installation-instructions which guide a user on how to
50 deploy OPNFV using Apex installer.
51
52 Summary
53 =======
54
55 Colorado release with the Apex deployment toolchain will establish an OPNFV
56 target system on a Pharos compliant lab infrastructure.  The current definition
57 of an OPNFV target system is OpenStack Mitaka combined with an SDN
58 controller, such as OpenDaylight.  The system is deployed with OpenStack High
59 Availability (HA) for most OpenStack services.  SDN controllers are deployed
60 only on the first controller (see HAIssues_ for known HA SDN issues).  Ceph
61 storage is used as Cinder backend, and is the only supported storage for
62 Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
63 node in an HA setup.  Apex also supports non-HA deployments, which deploys a
64 single controller and n number of compute nodes.  Furthermore, Apex is
65 capable of deploying scenarios in a bare metal or virtual fashion.  Virtual
66 deployments use multiple VMs on the jump host and internal networking to
67 simulate the a bare metal deployment.
68
69 - Documentation is built by Jenkins
70 - .iso image is built by Jenkins
71 - .rpm packages are built by Jenkins
72 - Jenkins deploys a Colorado release with the Apex deployment toolchain
73   bare metal, which includes 3 control+network nodes, and 2 compute nodes.
74
75 Release Data
76 ============
77
78 +--------------------------------------+--------------------------------------+
79 | **Project**                          | apex                                 |
80 |                                      |                                      |
81 +--------------------------------------+--------------------------------------+
82 | **Repo/tag**                         | apex/colorado.1.0                    |
83 |                                      |                                      |
84 +--------------------------------------+--------------------------------------+
85 | **Release designation**              | colorado.1.0                         |
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88 | **Release date**                     | 2016-09-22                           |
89 |                                      |                                      |
90 +--------------------------------------+--------------------------------------+
91 | **Purpose of the delivery**          | OPNFV Colorado release               |
92 |                                      |                                      |
93 +--------------------------------------+--------------------------------------+
94
95 Version change
96 --------------
97
98 Module version changes
99 ~~~~~~~~~~~~~~~~~~~~~~
100 This is the first tracked version of the Colorado release with the Apex
101 deployment toolchain.  It is based on following upstream versions:
102
103 - OpenStack (Mitaka release)
104
105 - OpenDaylight (Beryllium/Boron releases)
106
107 - CentOS 7
108
109 Document Version Changes
110 ~~~~~~~~~~~~~~~~~~~~~~~~
111
112 This is the first tracked version of Colorado release with the Apex
113 deployment toolchain.
114 The following documentation is provided with this release:
115
116 - OPNFV Installation instructions for the Colorado release with the Apex
117   deployment toolchain - ver. 1.0.0
118 - OPNFV Release Notes for the Colorado release with the Apex deployment
119   toolchain - ver. 1.0.0 (this document)
120
121 Feature Additions
122 ~~~~~~~~~~~~~~~~~
123
124 +--------------------------------------+--------------------------------------+
125 | **JIRA REFERENCE**                   | **SLOGAN**                           |
126 |                                      |                                      |
127 +--------------------------------------+--------------------------------------+
128 | JIRA: APEX-107                       | OpenDaylight HA - OVSDB Clustering   |
129 +--------------------------------------+--------------------------------------+
130 | JIRA: APEX-108                       | Migrate to OpenStack Mitaka          |
131 +--------------------------------------+--------------------------------------+
132 | JIRA: APEX-30                        | Support VLAN tagged deployments      |
133 +--------------------------------------+--------------------------------------+
134 | JIRA: APEX-105                       | Enable Huge Page Configuration       |
135 |                                      | Options                              |
136 +--------------------------------------+--------------------------------------+
137 | JIRA: APEX-111                       | Allow RAM to be specified for        |
138 |                                      | Control/Compute in Virtual           |
139 |                                      | Deployments                          |
140 +--------------------------------------+--------------------------------------+
141 | JIRA: APEX-119                       | Enable OVS DPDK as a deployment      |
142 |                                      | Scenario in Apex                     |
143 +--------------------------------------+--------------------------------------+
144 | JIRA: APEX-126                       | Tacker Service deployed by Apex      |
145 +--------------------------------------+--------------------------------------+
146 | JIRA: APEX-135                       | Congress Service deployed by Apex    |
147 +--------------------------------------+--------------------------------------+
148 | JIRA: APEX-127                       | Nova Instance CPU Pinning            |
149 +--------------------------------------+--------------------------------------+
150 | JIRA: APEX-130                       | IPv6 Underlay Deployment             |
151 +--------------------------------------+--------------------------------------+
152 | JIRA: APEX-133                       | FDIO with Honeycomb Agent            |
153 +--------------------------------------+--------------------------------------+
154 | JIRA: APEX-141                       | Integrate VSPERF into Apex           |
155 +--------------------------------------+--------------------------------------+
156 | JIRA: APEX-172                       | Enable ONOS SFC                      |
157 +--------------------------------------+--------------------------------------+
158
159 Bug Corrections
160 ~~~~~~~~~~~~~~~
161
162 **JIRA TICKETS:**
163
164 +--------------------------------------+--------------------------------------+
165 | **JIRA REFERENCE**                   | **SLOGAN**                           |
166 |                                      |                                      |
167 +--------------------------------------+--------------------------------------+
168 | JIRA: APEX-86                        | Need ability to specify number of    |
169 |                                      | compute nodes                        |
170 +--------------------------------------+--------------------------------------+
171 | JIRA: APEX-180                       | Baremetal deployment error: Failed to|
172 |                                      | mount root partition /dev/sda on     |
173 |                                      | /mnt/rootfs                          |
174 +--------------------------------------+--------------------------------------+
175 | JIRA: APEX-161                       | Heat autoscaling stack creation fails|
176 |                                      | for non-admin users                  |
177 +--------------------------------------+--------------------------------------+
178 | JIRA: APEX-198                       | Missing NAT iptables rule for public |
179 |                                      | network in instack VM                |
180 +--------------------------------------+--------------------------------------+
181 | JIRA: APEX-147                       | Installer doesn't generate/distribute|
182 |                                      | SSH keys between compute nodes       |
183 +--------------------------------------+--------------------------------------+
184 | JIRA: APEX-109                       | ONOS routes local subnet traffic to  |
185 |                                      | GW                                   |
186 +--------------------------------------+--------------------------------------+
187 | JIRA: APEX-146                       | Swift service present in available   |
188 |                                      | endpoints                            |
189 +--------------------------------------+--------------------------------------+
190 | JIRA: APEX-160                       | Enable force_metadata to support     |
191 |                                      | subnets with VM as the router        |
192 +--------------------------------------+--------------------------------------+
193 | JIRA: APEX-114                       | OpenDaylight GUI is not available    |
194 +--------------------------------------+--------------------------------------+
195 | JIRA: APEX-100                       | DNS1 and DNS2 should be handled in   |
196 |                                      | nic bridging                         |
197 +--------------------------------------+--------------------------------------+
198 | JIRA: APEX-100                       | DNS1 and DNS2 should be handled in   |
199 |                                      | nic bridging                         |
200 +--------------------------------------+--------------------------------------+
201 | JIRA: APEX-155                       | NIC Metric value not used when       |
202 |                                      | bridging NICs                        |
203 +--------------------------------------+--------------------------------------+
204 | JIRA: APEX-136                       | 2 network deployment fails           |
205 +--------------------------------------+--------------------------------------+
206 | JIRA: APEX-89                        | Deploy Ceph OSDs on compute nodes    |
207 +--------------------------------------+--------------------------------------+
208 | JIRA: APEX-137                       | added arping ass dependency for      |
209 |                                      | ONOS deployments                     |
210 +--------------------------------------+--------------------------------------+
211 | JIRA: APEX-121                       | VM Storage deletion intermittently   |
212 |                                      | fails                                |
213 +--------------------------------------+--------------------------------------+
214 | JIRA: APEX-182                       | Nova services not correctly deployed |
215 +--------------------------------------+--------------------------------------+
216 | JIRA: APEX-153                       | brbm bridge not created in jumphost  |
217 +--------------------------------------+--------------------------------------+
218
219 Deliverables
220 ------------
221
222 Software Deliverables
223 ~~~~~~~~~~~~~~~~~~~~~
224 - Apex .iso file
225 - Apex overcloud .rpm (opnfv-apex) - For nosdn and OpenDaylight Scenarios
226 - Apex overcloud onos .rpm (opnfv-apex-onos) - ONOS Scenarios
227 - Apex overcloud ODL SFC .rpm (opnfv-apex-opendaylight-sfc) - ODL SFC Scenario
228 - Apex undercloud .rpm (opnfv-apex-undercloud)
229 - Apex common .rpm (opnfv-apex-common)
230 - build.sh - Builds the above artifacts
231 - opnfv-deploy - Automatically deploys Target OPNFV System
232 - opnfv-clean - Automatically resets a Target OPNFV Deployment
233 - opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight
234
235 Documentation Deliverables
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~
237 - OPNFV Installation instructions for the Colorado release with the Apex
238   deployment toolchain - ver. 1.0.0
239 - OPNFV Release Notes for the Colorado release with the Apex deployment
240   toolchain - ver. 1.0.0 (this document)
241
242 Known Limitations, Issues and Workarounds
243 =========================================
244
245 System Limitations
246 ------------------
247
248 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
249
250 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
251
252 **Storage:**    Ceph is the only supported storage configuration.
253
254 **Min master requirements:** At least 16GB of RAM for baremetal jumphost,
255 24GB for virtual deployments (noHA).
256
257
258 Known Issues
259 ------------
260
261 **JIRA TICKETS:**
262
263 +--------------------------------------+--------------------------------------+
264 | **JIRA REFERENCE**                   | **SLOGAN**                           |
265 |                                      |                                      |
266 +--------------------------------------+--------------------------------------+
267 | JIRA: APEX-203                       | Swift proxy enabled and fails in noha|
268 |                                      | deployments                          |
269 +--------------------------------------+--------------------------------------+
270 | JIRA: APEX-215                       | Keystone services not configured and |
271 |                                      | the error is silently ignored (VLAN  |
272 |                                      | Deployments)                         |
273 +--------------------------------------+--------------------------------------+
274 | JIRA: APEX-208                       | Need ability to specify which NIC to |
275 |                                      | place VLAN on                        |
276 +--------------------------------------+--------------------------------------+
277 | JIRA: APEX-254                       | Add dynamic hugepages configuration  |
278 +--------------------------------------+--------------------------------------+
279 | JIRA: APEX-138                       | Unclear error message when interface |
280 |                                      | set to dhcp                          |
281 +--------------------------------------+--------------------------------------+
282
283
284 Workarounds
285 -----------
286 **-**
287
288 Scenario specific release notes
289 ===============================
290
291 Scenario os-odl_l3-nofeature known issues
292 -----------------------------------------
293
294 * `APEX-112 <https://jira.opnfv.org/browse/APEX-112>`_:
295    ODL routes local subnet traffic to GW
296
297 Scenario os-odl_l2-nofeature known issues
298 -----------------------------------------
299
300 * `APEX-149 <https://jira.opnfv.org/browse/APEX-149>`_:
301    Openflow rules are populated very slowly
302
303 Scenario os-odl_l2-sfc-noha known issues
304 ----------------------------------------
305
306 * `APEX-275 <https://jira.opnfv.org/browse/APEX-275>`_:
307    Metadata fails in Boron
308
309 Scenario os-nosdn-ovs known issues
310 ----------------------------------
311
312 * `APEX-274 <https://jira.opnfv.org/browse/APEX-274>`_:
313    OVS DPDK scenario does not create vhost user ports
314
315 Scenario os-odl_l2-fdio-noha known issues
316 -----------------------------------------
317
318 * `FDS-16 <https://jira.opnfv.org/browse/FDS-16>`_:
319    Security group configuration through nova leads
320    to vhostuser port connection issues
321 * `FDS-62 <https://jira.opnfv.org/browse/FDS-62>`_:
322    APEX - Increase number of files MariaDB can open
323 * `FDS-79 <https://jira.opnfv.org/browse/FDS-79>`_:
324    Sometimes (especially in bulk crete/delete operations
325    when multiple networks/ports are created within short time)
326    OpenDaylight doesn't accept creation requests
327 * `FDS-80 <https://jira.opnfv.org/browse/FDS-80>`_:
328    After launching a VM it stayed forever in BUILD status.
329    Also further operation related to this VM (volume attachment etc.)
330    caused problems
331 * `FDS-81 <https://jira.opnfv.org/browse/FDS-81>`_:
332    After functest finishes there are two bds on computes and
333    none on controller
334 * `FDS-82 <https://jira.opnfv.org/browse/FDS-82>`_:
335    Nova list shows no vms but there are some on computes in paused state
336 * `APEX-217 <https://jira.opnfv.org/browse/APEX-217>`_:
337    qemu not configured with correct group:user
338
339 .. _HAIssues:
340
341 General HA scenario known issues
342 --------------------------------
343
344 * `COPPER-22 <https://jira.opnfv.org/browse/COPPER-22>`_:
345    Congress service HA deployment is not yet supported/verified.
346 * `APEX-276 <https://jira.opnfv.org/browse/APEX-276>`_:
347    ODL HA unstable and crashes frequently
348
349 Test Result
350 ===========
351
352 The Colorado release with the Apex deployment toolchain has undergone QA
353 test runs with the following results:
354
355 +--------------------------------------+--------------------------------------+
356 | **TEST-SUITE**                       | **Results:**                         |
357 |                                      |                                      |
358 +--------------------------------------+--------------------------------------+
359 | **-**                                | **-**                                |
360 +--------------------------------------+--------------------------------------+
361
362
363 References
364 ==========
365
366 For more information on the OPNFV Colorado release, please see:
367
368 http://wiki.opnfv.org/releases/Colorado
369
370 :Authors: Tim Rozet (trozet@redhat.com)
371 :Authors: Dan Radez (dradez@redhat.com)
372 :Version: 2.1.0