docs/releasenotes/release-notes.rst

   1 ==============================================================================
   2 OPNFV Release Notes for the Colorado 2.0 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 2.0 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-10-26  | 2.2.0     | Tim Rozet       | More updates for     |
  32 |             |           |                 | Colorado 2.0         |
  33 +-------------+-----------+-----------------+----------------------+
  34 | 2016-09-20  | 2.1.0     | Tim Rozet       | More updates for     |
  35 |             |           |                 | Colorado             |
  36 +-------------+-----------+-----------------+----------------------+
  37 | 2016-08-11  | 2.0.0     | Dan Radez       | Updates for Colorado |
  38 +-------------+-----------+-----------------+----------------------+
  39 | 2015-09-17  | 1.0.0     | Dan Radez       | Rewritten for        |
  40 |             |           |                 | RDO Manager update   |
  41 +-------------+-----------+-----------------+----------------------+
  42
  43 Important Notes
  44 ===============
  45
  46 This is the OPNFV Colorado 2.0 release that implements the deploy stage of the
  47 OPNFV CI pipeline via Apex.
  48
  49 Apex is based on RDO's Triple-O installation tool chain.
  50 More information at http://rdoproject.org
  51
  52 Carefully follow the installation-instructions which guide a user on how to
  53 deploy OPNFV using Apex installer.
  54
  55 Summary
  56 =======
  57
  58 Colorado release with the Apex deployment toolchain will establish an OPNFV
  59 target system on a Pharos compliant lab infrastructure.  The current definition
  60 of an OPNFV target system is OpenStack Mitaka combined with an SDN
  61 controller, such as OpenDaylight.  The system is deployed with OpenStack High
  62 Availability (HA) for most OpenStack services.  SDN controllers are deployed
  63 only on the first controller (see HAIssues_ for known HA SDN issues).  Ceph
  64 storage is used as Cinder backend, and is the only supported storage for
  65 Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
  66 node in an HA setup.  Apex also supports non-HA deployments, which deploys a
  67 single controller and n number of compute nodes.  Furthermore, Apex is
  68 capable of deploying scenarios in a bare metal or virtual fashion.  Virtual
  69 deployments use multiple VMs on the jump host and internal networking to
  70 simulate the a bare metal deployment.
  71
  72 - Documentation is built by Jenkins
  73 - .iso image is built by Jenkins
  74 - .rpm packages are built by Jenkins
  75 - Jenkins deploys a Colorado release with the Apex deployment toolchain
  76   bare metal, which includes 3 control+network nodes, and 2 compute nodes.
  77
  78 Release Data
  79 ============
  80
  81 +--------------------------------------+--------------------------------------+
  82 | **Project**                          | apex                                 |
  83 |                                      |                                      |
  84 +--------------------------------------+--------------------------------------+
  85 | **Repo/tag**                         | apex/colorado.2.0                    |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | **Release designation**              | colorado.2.0                         |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91 | **Release date**                     | 2016-10-27                           |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94 | **Purpose of the delivery**          | OPNFV Colorado 2.0 release           |
  95 |                                      |                                      |
  96 +--------------------------------------+--------------------------------------+
  97
  98 Version change
  99 --------------
 100
 101 Module version changes
 102 ~~~~~~~~~~~~~~~~~~~~~~
 103 This is the second tracked version of the Colorado release with the Apex
 104 deployment toolchain.  It is based on following upstream versions:
 105
 106 - OpenStack (Mitaka release)
 107
 108 - OpenDaylight (Beryllium/Boron releases)
 109
 110 - CentOS 7
 111
 112 Document Version Changes
 113 ~~~~~~~~~~~~~~~~~~~~~~~~
 114
 115 The following documentation is provided with this release:
 116
 117 - OPNFV Installation instructions for the Colorado release with the Apex
 118   deployment toolchain - ver. 3.0
 119 - OPNFV Release Notes for the Colorado release with the Apex deployment
 120   toolchain - ver. 2.2.0 (this document)
 121
 122 Feature Additions
 123 ~~~~~~~~~~~~~~~~~
 124
 125 +--------------------------------------+--------------------------------------+
 126 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 127 |                                      |                                      |
 128 +--------------------------------------+--------------------------------------+
 129 | JIRA: APEX-107                       | OpenDaylight HA - OVSDB Clustering   |
 130 +--------------------------------------+--------------------------------------+
 131 | JIRA: APEX-108                       | Migrate to OpenStack Mitaka          |
 132 +--------------------------------------+--------------------------------------+
 133 | JIRA: APEX-30                        | Support VLAN tagged deployments      |
 134 +--------------------------------------+--------------------------------------+
 135 | JIRA: APEX-105                       | Enable Huge Page Configuration       |
 136 |                                      | Options                              |
 137 +--------------------------------------+--------------------------------------+
 138 | JIRA: APEX-111                       | Allow RAM to be specified for        |
 139 |                                      | Control/Compute in Virtual           |
 140 |                                      | Deployments                          |
 141 +--------------------------------------+--------------------------------------+
 142 | JIRA: APEX-119                       | Enable OVS DPDK as a deployment      |
 143 |                                      | Scenario in Apex                     |
 144 +--------------------------------------+--------------------------------------+
 145 | JIRA: APEX-126                       | Tacker Service deployed by Apex      |
 146 +--------------------------------------+--------------------------------------+
 147 | JIRA: APEX-135                       | Congress Service deployed by Apex    |
 148 +--------------------------------------+--------------------------------------+
 149 | JIRA: APEX-127                       | Nova Instance CPU Pinning            |
 150 +--------------------------------------+--------------------------------------+
 151 | JIRA: APEX-130                       | IPv6 Underlay Deployment             |
 152 +--------------------------------------+--------------------------------------+
 153 | JIRA: APEX-133                       | FDIO with Honeycomb Agent            |
 154 +--------------------------------------+--------------------------------------+
 155 | JIRA: APEX-141                       | Integrate VSPERF into Apex           |
 156 +--------------------------------------+--------------------------------------+
 157 | JIRA: APEX-172                       | Enable ONOS SFC                      |
 158 +--------------------------------------+--------------------------------------+
 159
 160 Bug Corrections
 161 ~~~~~~~~~~~~~~~
 162
 163 **JIRA TICKETS:**
 164
 165 +--------------------------------------+--------------------------------------+
 166 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 167 |                                      |                                      |
 168 +--------------------------------------+--------------------------------------+
 169 | JIRA: APEX-86                        | Need ability to specify number of    |
 170 |                                      | compute nodes                        |
 171 +--------------------------------------+--------------------------------------+
 172 | JIRA: APEX-180                       | Baremetal deployment error: Failed to|
 173 |                                      | mount root partition /dev/sda on     |
 174 |                                      | /mnt/rootfs                          |
 175 +--------------------------------------+--------------------------------------+
 176 | JIRA: APEX-161                       | Heat autoscaling stack creation fails|
 177 |                                      | for non-admin users                  |
 178 +--------------------------------------+--------------------------------------+
 179 | JIRA: APEX-198                       | Missing NAT iptables rule for public |
 180 |                                      | network in instack VM                |
 181 +--------------------------------------+--------------------------------------+
 182 | JIRA: APEX-147                       | Installer doesn't generate/distribute|
 183 |                                      | SSH keys between compute nodes       |
 184 +--------------------------------------+--------------------------------------+
 185 | JIRA: APEX-109                       | ONOS routes local subnet traffic to  |
 186 |                                      | GW                                   |
 187 +--------------------------------------+--------------------------------------+
 188 | JIRA: APEX-146                       | Swift service present in available   |
 189 |                                      | endpoints                            |
 190 +--------------------------------------+--------------------------------------+
 191 | JIRA: APEX-160                       | Enable force_metadata to support     |
 192 |                                      | subnets with VM as the router        |
 193 +--------------------------------------+--------------------------------------+
 194 | JIRA: APEX-114                       | OpenDaylight GUI is not available    |
 195 +--------------------------------------+--------------------------------------+
 196 | JIRA: APEX-100                       | DNS1 and DNS2 should be handled in   |
 197 |                                      | nic bridging                         |
 198 +--------------------------------------+--------------------------------------+
 199 | JIRA: APEX-100                       | DNS1 and DNS2 should be handled in   |
 200 |                                      | nic bridging                         |
 201 +--------------------------------------+--------------------------------------+
 202 | JIRA: APEX-155                       | NIC Metric value not used when       |
 203 |                                      | bridging NICs                        |
 204 +--------------------------------------+--------------------------------------+
 205 | JIRA: APEX-136                       | 2 network deployment fails           |
 206 +--------------------------------------+--------------------------------------+
 207 | JIRA: APEX-89                        | Deploy Ceph OSDs on compute nodes    |
 208 +--------------------------------------+--------------------------------------+
 209 | JIRA: APEX-137                       | added arping ass dependency for      |
 210 |                                      | ONOS deployments                     |
 211 +--------------------------------------+--------------------------------------+
 212 | JIRA: APEX-121                       | VM Storage deletion intermittently   |
 213 |                                      | fails                                |
 214 +--------------------------------------+--------------------------------------+
 215 | JIRA: APEX-182                       | Nova services not correctly deployed |
 216 +--------------------------------------+--------------------------------------+
 217 | JIRA: APEX-153                       | brbm bridge not created in jumphost  |
 218 +--------------------------------------+--------------------------------------+
 219 | JIRA: APEX-274                       | OVS DPDK scenario does not create    |
 220 |                                      | vhost user ports                     |
 221 +--------------------------------------+--------------------------------------+
 222 | JIRA: APEX-277                       | ONOS fails to launch due to OVS and  |
 223 |                                      | Kernel version mismatch              |
 224 +--------------------------------------+--------------------------------------+
 225 | JIRA: APEX-179                       | DNS settings not working properly    |
 226 |                                      | for baremetal deployments            |
 227 +--------------------------------------+--------------------------------------+
 228 | JIRA: APEX-203                       | Swift proxy enabled and fails in noha|
 229 |                                      | deployment                           |
 230 +--------------------------------------+--------------------------------------+
 231 | JIRA: APEX-230                       | Tacker heat_uri setting is wrong     |
 232 +--------------------------------------+--------------------------------------+
 233 | JIRA: APEX-241                       | Glance services are not running after|
 234 |                                      | reboot                               |
 235 +--------------------------------------+--------------------------------------+
 236 | JIRA: APEX-265                       | Metadata problems with os-odl_l2-sfc |
 237 |                                      | scenario                             |
 238 +--------------------------------------+--------------------------------------+
 239 | JIRA: APEX-271                       | L3 agent interface_driver set        |
 240 |                                      | incorrectly for nosdn fdio noha      |
 241 +--------------------------------------+--------------------------------------+
 242 | JIRA: APEX-275                       | Metadata fails in ODL Boron          |
 243 +--------------------------------------+--------------------------------------+
 244 | JIRA: APEX-278                       | Duplicate neutron config class       |
 245 |                                      | declaration for SDNVPN               |
 246 +--------------------------------------+--------------------------------------+
 247 | JIRA: APEX-281                       | ONOS sometimes fails to provide      |
 248 |                                      | addresses to instances               |
 249 +--------------------------------------+--------------------------------------+
 250 | JIRA: APEX-283                       | Change networking-vpp ML2 driver to  |
 251 |                                      | etcd                                 |
 252 +--------------------------------------+--------------------------------------+
 253 | JIRA: APEX-284                       | vpp and hc versions for os-odl_l2    |
 254 |                                      | -fdio-noha scenario                  |
 255 +--------------------------------------+--------------------------------------+
 256 | JIRA: APEX-285                       | Remove vlan-strip-offload off config |
 257 |                                      | from os-odl_l2-fdio-noha scenario    |
 258 +--------------------------------------+--------------------------------------+
 259 | JIRA: APEX-286                       | Make fdio repo an option in puppet-  |
 260 |                                      | fdio                                 |
 261 +--------------------------------------+--------------------------------------+
 262 | JIRA: APEX-289                       | Set undercloud VM to autostart for   |
 263 |                                      | reboot                               |
 264 +--------------------------------------+--------------------------------------+
 265 | JIRA: APEX-291                       | link to apex installer missing on    |
 266 |                                      | OPNFV download site                  |
 267 +--------------------------------------+--------------------------------------+
 268 | JIRA: APEX-293                       | tenant_nic is assumed to be a virtual|
 269 |                                      | name for nosdn fdio scenario         |
 270 +--------------------------------------+--------------------------------------+
 271 | JIRA: APEX-294                       | dns server settings is ignored from  |
 272 |                                      | network_settings.yaml                |
 273 +--------------------------------------+--------------------------------------+
 274 | JIRA: APEX-297                       | Add details in "11.2 Creating a Node |
 275 |                                      | Inventory File"                      |
 276 +--------------------------------------+--------------------------------------+
 277 | JIRA: APEX-326                       | Consolidate SFC rpm into regular Apex|
 278 |                                      | rpm                                  |
 279 +--------------------------------------+--------------------------------------+
 280 | JIRA: APEX-331                       | Conditionally install OVS NSH in     |
 281 |                                      | ONOS Deployment                      |
 282 +--------------------------------------+--------------------------------------+
 283 | JIRA: APEX-332                       | IPv6 Scenario fails to deploy        |
 284 +--------------------------------------+--------------------------------------+
 285 | JIRA: APEX-333                       | OVS DPDK does not work with UCS      |
 286 +--------------------------------------+--------------------------------------+
 287 | JIRA: APEX-334                       | ONOS SFC not using SFC version of OVS|
 288 +--------------------------------------+--------------------------------------+
 289 | JIRA: APEX-335                       | Performance settings missing in      |
 290 |                                      | os-odl_l2-fdio-ha.yaml               |
 291 +--------------------------------------+--------------------------------------+
 292 | JIRA: APEX-163                       | Prefix to mask calculation doesn't   |
 293 |                                      | work                                 |
 294 +--------------------------------------+--------------------------------------+
 295 | JIRA: APEX-266                       | ntp server shoudl be in network      |
 296 |                                      | settings                             |
 297 +--------------------------------------+--------------------------------------+
 298 | JIRA: APEX-292                       | unclear that ip ranges in network    |
 299 |                                      | settings may not overlap             |
 300 +--------------------------------------+--------------------------------------+
 301
 302 Deliverables
 303 ------------
 304
 305 Software Deliverables
 306 ~~~~~~~~~~~~~~~~~~~~~
 307 - Apex .iso file
 308 - Apex overcloud .rpm (opnfv-apex) - For nosdn and OpenDaylight Scenarios
 309 - Apex overcloud onos .rpm (opnfv-apex-onos) - ONOS Scenarios
 310 - Apex undercloud .rpm (opnfv-apex-undercloud)
 311 - Apex common .rpm (opnfv-apex-common)
 312 - build.sh - Builds the above artifacts
 313 - opnfv-deploy - Automatically deploys Target OPNFV System
 314 - opnfv-clean - Automatically resets a Target OPNFV Deployment
 315 - opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight
 316
 317 Documentation Deliverables
 318 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 319 - OPNFV Installation instructions for the Colorado release with the Apex
 320   deployment toolchain - ver. 3.0
 321 - OPNFV Release Notes for the Colorado release with the Apex deployment
 322   toolchain - ver. 2.2.0 (this document)
 323
 324 Known Limitations, Issues and Workarounds
 325 =========================================
 326
 327 System Limitations
 328 ------------------
 329
 330 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
 331
 332 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
 333
 334 **Storage:**    Ceph is the only supported storage configuration.
 335
 336 **Min master requirements:** At least 16GB of RAM for baremetal jumphost,
 337 24GB for virtual deployments (noHA).
 338
 339
 340 Known Issues
 341 ------------
 342
 343 **JIRA TICKETS:**
 344
 345 +--------------------------------------+--------------------------------------+
 346 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 347 |                                      |                                      |
 348 +--------------------------------------+--------------------------------------+
 349 | JIRA: APEX-203                       | Swift proxy enabled and fails in noha|
 350 |                                      | deployments                          |
 351 +--------------------------------------+--------------------------------------+
 352 | JIRA: APEX-215                       | Keystone services not configured and |
 353 |                                      | the error is silently ignored (VLAN  |
 354 |                                      | Deployments)                         |
 355 +--------------------------------------+--------------------------------------+
 356 | JIRA: APEX-208                       | Need ability to specify which NIC to |
 357 |                                      | place VLAN on                        |
 358 +--------------------------------------+--------------------------------------+
 359 | JIRA: APEX-254                       | Add dynamic hugepages configuration  |
 360 +--------------------------------------+--------------------------------------+
 361 | JIRA: APEX-138                       | Unclear error message when interface |
 362 |                                      | set to dhcp                          |
 363 +--------------------------------------+--------------------------------------+
 364
 365
 366 Workarounds
 367 -----------
 368 **-**
 369
 370 Scenario specific release notes
 371 ===============================
 372
 373 Scenario os-odl_l3-nofeature known issues
 374 -----------------------------------------
 375
 376 * `APEX-112 <https://jira.opnfv.org/browse/APEX-112>`_:
 377    ODL routes local subnet traffic to GW
 378
 379 Scenario os-odl_l2-nofeature known issues
 380 -----------------------------------------
 381
 382 * `APEX-149 <https://jira.opnfv.org/browse/APEX-149>`_:
 383    Openflow rules are populated very slowly
 384
 385 Scenario os-odl_l2-bgpvpn known issues
 386 --------------------------------------
 387
 388 None
 389
 390 Scenario os-onos-nofeature known issues
 391 ---------------------------------------
 392
 393 None
 394
 395 Scenario os-onos-sfc known issues
 396 ---------------------------------
 397
 398 * `APEX-281 <https://jira.opnfv.org/browse/APEX-281>`_:
 399    ONOS sometimes fails to provide addresses to instances
 400
 401 Scenario os-odl_l2-sfc-noha known issues
 402 ----------------------------------------
 403
 404 None
 405
 406 Scenario os-nosdn-ovs known issues
 407 ----------------------------------
 408
 409 None
 410
 411 Scenario os-odl_l2-fdio-noha known issues
 412 -----------------------------------------
 413
 414 * `FDS-121 <https://jira.opnfv.org/browse/FDS-121>`_:
 415    qemu doesn't receive connection on socket, vhost-user reconnect problem
 416 * `FDS-62 <https://jira.opnfv.org/browse/FDS-62>`_:
 417    APEX - Increase number of files MariaDB can open
 418 * `FDS-79 <https://jira.opnfv.org/browse/FDS-79>`_:
 419    Sometimes (especially in bulk crete/delete operations
 420    when multiple networks/ports are created within short time)
 421    OpenDaylight doesn't accept creation requests
 422 * `FDS-81 <https://jira.opnfv.org/browse/FDS-81>`_:
 423    After functest finishes there are two bds on computes and
 424    none on controller
 425 * `APEX-217 <https://jira.opnfv.org/browse/APEX-217>`_:
 426    qemu not configured with correct group:user
 427 * `APEX-337 <https://jira.opnfv.org/browse/APEX-337>`_:
 428    enable isolcpu on kernel and pin vpp to unused cpu for fdio scenarios
 429
 430 .. _HAIssues:
 431
 432 General HA scenario known issues
 433 --------------------------------
 434
 435 * `COPPER-22 <https://jira.opnfv.org/browse/COPPER-22>`_:
 436    Congress service HA deployment is not yet supported/verified.
 437 * `APEX-276 <https://jira.opnfv.org/browse/APEX-276>`_:
 438    ODL HA unstable and crashes frequently
 439
 440 Test Result
 441 ===========
 442
 443 The Colorado release with the Apex deployment toolchain has undergone QA
 444 test runs with the OPNFV FuncTest project.  The latest results per scenario
 445 can be found `here <http://testresults.opnfv.org/reporting/functest/
 446 release/colorado/index-status-apex.html>`_ for Colorado release.
 447
 448
 449 References
 450 ==========
 451
 452 For more information on the OPNFV Colorado release, please see:
 453
 454 http://wiki.opnfv.org/releases/Colorado
 455
 456 :Authors: Tim Rozet (trozet@redhat.com)
 457 :Authors: Dan Radez (dradez@redhat.com)
 458 :Version: 2.2.0