Merge "Adapt zrpcd to work for Carbon/Nitrogen"
[apex.git] / docs / release / release-notes / release-notes.rst
1 ===========================================================================
2 OPNFV Release Notes for the Euphrates release of OPNFV Apex deployment tool
3 ===========================================================================
4
5 Abstract
6 ========
7
8 This document provides the release notes for Euphrates release with the Apex
9 deployment toolchain.
10
11 License
12 =======
13
14 All Apex and "common" entities are protected by the Apache 2.0 License
15 ( http://www.apache.org/licenses/ )
16
17 Important Notes
18 ===============
19
20 This is the OPNFV Euphrates release that implements the deploy stage of the
21 OPNFV CI pipeline via Apex.
22
23 Apex is based on RDO's Triple-O installation tool chain.
24 More information at http://rdoproject.org
25
26 Carefully follow the installation-instructions which guide a user on how to
27 deploy OPNFV using Apex installer.
28
29 Summary
30 =======
31
32 Euphrates release with the Apex deployment toolchain will establish an OPNFV
33 target system on a Pharos compliant lab infrastructure.  The current definition
34 of an OPNFV target system is OpenStack Newton combined with an SDN
35 controller, such as OpenDaylight.  The system is deployed with OpenStack High
36 Availability (HA) for most OpenStack services.  SDN controllers are deployed
37 on every controller unless deploying with one the HA FD.IO scenarios.  Ceph
38 storage is used as Cinder backend, and is the only supported storage for
39 Euphrates.  Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
40 node in an HA setup.  Apex also supports non-HA deployments, which deploys a
41 single controller and n number of compute nodes.  Furthermore, Apex is
42 capable of deploying scenarios in a bare metal or virtual fashion.  Virtual
43 deployments use multiple VMs on the Jump Host and internal networking to
44 simulate the a bare metal deployment.
45
46 - Documentation is built by Jenkins
47 - .iso image is built by Jenkins
48 - .rpm packages are built by Jenkins
49 - Jenkins deploys a Euphrates release with the Apex deployment toolchain
50   bare metal, which includes 3 control+network nodes, and 2 compute nodes.
51
52 Release Data
53 ============
54
55 +--------------------------------------+--------------------------------------+
56 | **Project**                          | apex                                 |
57 |                                      |                                      |
58 +--------------------------------------+--------------------------------------+
59 | **Repo/tag**                         | apex/euphrates.1.0                   |
60 |                                      |                                      |
61 +--------------------------------------+--------------------------------------+
62 | **Release designation**              | 5.0.0                                |
63 |                                      |                                      |
64 +--------------------------------------+--------------------------------------+
65 | **Release date**                     | 2017-10-20                           |
66 |                                      |                                      |
67 +--------------------------------------+--------------------------------------+
68 | **Purpose of the delivery**          | OPNFV Euphrates release              |
69 |                                      |                                      |
70 +--------------------------------------+--------------------------------------+
71
72 Version change
73 --------------
74
75 Module version changes
76 ~~~~~~~~~~~~~~~~~~~~~~
77 This is the first tracked version of the Euphrates release with the Apex
78 deployment toolchain.  It is based on following upstream versions:
79
80 - OpenStack (Newton release)
81
82 - OpenDaylight (Carbon/Nitrogen(master) releases)
83
84 - CentOS 7
85
86 Document Version Changes
87 ~~~~~~~~~~~~~~~~~~~~~~~~
88
89 This is the first tracked version of Euphrates release with the Apex
90 deployment toolchain.
91 The following documentation is provided with this release:
92
93 - OPNFV Installation instructions for the Euphrates release with the Apex
94   deployment toolchain - ver. 1.0.0
95 - OPNFV Release Notes for the Euphrates release with the Apex deployment
96   toolchain - ver. 1.0.0 (this document)
97
98 Feature Additions
99 ~~~~~~~~~~~~~~~~~
100
101 +--------------------------------------+--------------------------------------+
102 | **JIRA REFERENCE**                   | **SLOGAN**                           |
103 |                                      |                                      |
104 +--------------------------------------+--------------------------------------+
105 | JIRA: APEX-129                       | Adds OVN SDN Controller support      |
106 +--------------------------------------+--------------------------------------+
107 | JIRA: APEX-299                       | Migrate to OpenStack Newton          |
108 +--------------------------------------+--------------------------------------+
109 | JIRA: APEX-150                       | Allow for multiple external networks |
110 +--------------------------------------+--------------------------------------+
111 | JIRA: APEX-301                       | Support Networking ODL v2 Driver     |
112 +--------------------------------------+--------------------------------------+
113 | JIRA: APEX-300                       | Support OpenDaylight new netvirt     |
114 +--------------------------------------+--------------------------------------+
115 | JIRA: APEX-302                       | Upstream Tacker and Congress         |
116 |                                      | support                              |
117 +--------------------------------------+--------------------------------------+
118 | JIRA: APEX-106                       | Enable CPU pinning for Overcloud     |
119 +--------------------------------------+--------------------------------------+
120 | JIRA: APEX-390                       | OpenDaylight HA as default for HA    |
121 |                                      | scenarios                            |
122 +--------------------------------------+--------------------------------------+
123 | JIRA: APEX-357                       | Include Quagga in SDNVPN scenario    |
124 +--------------------------------------+--------------------------------------+
125 | JIRA: APEX-262                       | Migrate to new network settings      |
126 |                                      | format                               |
127 +--------------------------------------+--------------------------------------+
128 | JIRA: APEX-128                       | Adds Real Time KVM support           |
129 +--------------------------------------+--------------------------------------+
130
131 Bug Corrections
132 ~~~~~~~~~~~~~~~
133
134 **JIRA TICKETS:**
135
136 +--------------------------------------+--------------------------------------+
137 | **JIRA REFERENCE**                   | **SLOGAN**                           |
138 |                                      |                                      |
139 +--------------------------------------+--------------------------------------+
140 | JIRA: APEX-208                       | Need ability to specify which nic    |
141 |                                      | to place vlan on                     |
142 +--------------------------------------+--------------------------------------+
143 | JIRA: APEX-215                       | Keystone services not configured and |
144 |                                      | error is silently ignored on VLAN    |
145 |                                      | Deployments                          |
146 +--------------------------------------+--------------------------------------+
147 | JIRA: APEX-221                       | NoHA virtual deployments should use 1|
148 |                                      | compute                              |
149 +--------------------------------------+--------------------------------------+
150 | JIRA: APEX-276                       | ODL HA is unstable and crashes       |
151 |                                      | frequently                           |
152 +--------------------------------------+--------------------------------------+
153 | JIRA: APEX-287                       | Name mismatch for package openstack- |
154 |                                      | congress during overcloud build      |
155 +--------------------------------------+--------------------------------------+
156 | JIRA: APEX-339                       | Enable pinning for OVS DPDK          |
157 +--------------------------------------+--------------------------------------+
158 | JIRA: APEX-345                       | Horizon and cloud failures due to    |
159 |                                      | running out of file descriptors for  |
160 |                                      | MariaDB in noha deployments          |
161 +--------------------------------------+--------------------------------------+
162 | JIRA: APEX-370                       | ISO builds fail in Danube            |
163 +--------------------------------------+--------------------------------------+
164 | JIRA: APEX-372                       | Specifying same NIC for storage and  |
165 |                                      | private network but different VLANs  |
166 |                                      | results in duplicate NIC error       |
167 +--------------------------------------+--------------------------------------+
168 | JIRA: APEX-373                       | Running smoke tests should install   |
169 |                                      | Ansible onto jump host               |
170 +--------------------------------------+--------------------------------------+
171 | JIRA: APEX-374                       | Ceph accidentally disabled by default|
172 +--------------------------------------+--------------------------------------+
173 | JIRA: APEX-378                       | OVS 2.5.90 NSH build fails           |
174 +--------------------------------------+--------------------------------------+
175 | JIRA: APEX-382                       | yum update on undercloud breaks      |
176 |                                      | deployments                          |
177 +--------------------------------------+--------------------------------------+
178 | JIRA: APEX-386                       | Fix os-net-config to match upstream  |
179 |                                      | stable/newton                        |
180 +--------------------------------------+--------------------------------------+
181 | JIRA: APEX-398                       | Tacker uses "RegionOne" instead of   |
182 |                                      | "regionOne"                          |
183 +--------------------------------------+--------------------------------------+
184 | JIRA: APEX-399                       | hugepages are not enabled when       |
185 |                                      | configured in deploy settings        |
186 +--------------------------------------+--------------------------------------+
187 | JIRA: APEX-403                       | Remove Quagga from build process and |
188 |                                      | cache to artifacts                   |
189 +--------------------------------------+--------------------------------------+
190 | JIRA: APEX-406                       | ODL FDIO neutron patches to all      |
191 |                                      | scenarios                            |
192 +--------------------------------------+--------------------------------------+
193 | JIRA: APEX-407                       | VPP service does not start upon      |
194 |                                      | reboot                               |
195 +--------------------------------------+--------------------------------------+
196 | JIRA: APEX-408                       | Quagga's bgpd cannot start due to    |
197 |                                      | permissions                          |
198 +--------------------------------------+--------------------------------------+
199 | JIRA: APEX-421                       | Update odl/hc/vpp versions for odl_l3|
200 |                                      | noha                                 |
201 +--------------------------------------+--------------------------------------+
202 | JIRA: APEX-426                       | Missing virtual-computes arg in help |
203 |                                      | output for deploy                    |
204 +--------------------------------------+--------------------------------------+
205 | JIRA: APEX-427                       | Neutron openvswitch agent starts when|
206 |                                      | openvswitch is restarted             |
207 +--------------------------------------+--------------------------------------+
208
209 Deliverables
210 ------------
211
212 Software Deliverables
213 ~~~~~~~~~~~~~~~~~~~~~
214 - Apex .iso file
215 - Apex release .rpm (opnfv-apex-release)
216 - Apex overcloud .rpm (opnfv-apex) - For nosdn and OpenDaylight Scenarios
217 - Apex undercloud .rpm (opnfv-apex-undercloud)
218 - Apex common .rpm (opnfv-apex-common)
219 - build.py - Builds the above artifacts
220 - opnfv-deploy - Automatically deploys Target OPNFV System
221 - opnfv-clean - Automatically resets a Target OPNFV Deployment
222 - opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight
223
224 Documentation Deliverables
225 ~~~~~~~~~~~~~~~~~~~~~~~~~~
226 - OPNFV Installation instructions for the Euphrates release with the Apex
227   deployment toolchain - ver. 5.0
228 - OPNFV Release Notes for the Euphrates release with the Apex deployment
229   toolchain - ver. 5.0 (this document)
230
231 Known Limitations, Issues and Workarounds
232 =========================================
233
234 System Limitations
235 ------------------
236
237 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
238
239 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
240
241 **Storage:**    Ceph is the only supported storage configuration.
242
243 **Min master requirements:** At least 16GB of RAM for baremetal Jump Host,
244 24GB for virtual deployments (noHA).
245
246
247 Known Issues
248 ------------
249
250 **JIRA TICKETS:**
251
252 +--------------------------------------+--------------------------------------+
253 | **JIRA REFERENCE**                   | **SLOGAN**                           |
254 |                                      |                                      |
255 +--------------------------------------+--------------------------------------+
256 | JIRA: APEX-138                       | Unclear error message when interface |
257 |                                      | set to dhcp                          |
258 +--------------------------------------+--------------------------------------+
259 | JIRA: APEX-280                       | Deleted network not cleaned up       |
260 |                                      | on controller                        |
261 +--------------------------------------+--------------------------------------+
262 | JIRA: APEX-295                       | Missing support for VLAN tenant      |
263 |                                      | networks                             |
264 +--------------------------------------+--------------------------------------+
265 | JIRA: APEX-352                       | Package "openstack-utils" is         |
266 |                                      | missing from overcloud               |
267 +--------------------------------------+--------------------------------------+
268 | JIRA: APEX-368                       | Ceilometer stores samples and events |
269 |                                      | forever                              |
270 +--------------------------------------+--------------------------------------+
271 | JIRA: APEX-371                       | Ceph partitions need to be prepared  |
272 |                                      | on deployment when using 2nd disk    |
273 +--------------------------------------+--------------------------------------+
274 | JIRA: APEX-375                       | Default glance storage points to     |
275 |                                      | http,swift when ceph disabled        |
276 +--------------------------------------+--------------------------------------+
277 | JIRA: APEX-389                       | Compute kernel parameters are used   |
278 |                                      | for all nodes                        |
279 +--------------------------------------+--------------------------------------+
280 | JIRA: APEX-410                       | Need to limit number of workers per  |
281 |                                      | OpenStack service for baremetal      |
282 |                                      | deployments                          |
283 +--------------------------------------+--------------------------------------+
284 | JIRA: APEX-412                       | Install failures with UEFI           |
285 +--------------------------------------+--------------------------------------+
286 | JIRA: APEX-417                       | Missing OVS 2.6 + NSH support        |
287 +--------------------------------------+--------------------------------------+
288 | JIRA: APEX-419                       | opnfv-clean sometimes leaves admin   |
289 |                                      | and public network down              |
290 +--------------------------------------+--------------------------------------+
291 | JIRA: APEX-425                       | Need to tweak performance settings   |
292 |                                      | virtual DPDK scenarios               |
293 +--------------------------------------+--------------------------------------+
294
295
296 Workarounds
297 -----------
298 **-**
299
300
301 Test Result
302 ===========
303
304 Please reference Functest project documentation for test results with the
305 Apex installer.
306
307
308 References
309 ==========
310
311 For more information on the OPNFV Euphrates release, please see:
312
313 http://wiki.opnfv.org/releases/Euphrates
314
315 :Authors: Tim Rozet (trozet@redhat.com)
316 :Authors: Dan Radez (dradez@redhat.com)
317 :Version: 5.0