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