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 release .rpm (opnfv-apex-release)
 309 - Apex overcloud .rpm (opnfv-apex) - For nosdn and OpenDaylight Scenarios
 310 - Apex overcloud onos .rpm (opnfv-apex-onos) - ONOS Scenarios
 311 - Apex undercloud .rpm (opnfv-apex-undercloud)
 312 - Apex common .rpm (opnfv-apex-common)
 313 - build.sh - Builds the above artifacts
 314 - opnfv-deploy - Automatically deploys Target OPNFV System
 315 - opnfv-clean - Automatically resets a Target OPNFV Deployment
 316 - opnfv-util - Utility to connect to or debug Overcloud nodes + OpenDaylight
 317
 318 Documentation Deliverables
 319 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 320 - OPNFV Installation instructions for the Colorado release with the Apex
 321   deployment toolchain - ver. 3.0
 322 - OPNFV Release Notes for the Colorado release with the Apex deployment
 323   toolchain - ver. 2.2.0 (this document)
 324
 325 Known Limitations, Issues and Workarounds
 326 =========================================
 327
 328 System Limitations
 329 ------------------
 330
 331 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
 332
 333 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
 334
 335 **Storage:**    Ceph is the only supported storage configuration.
 336
 337 **Min master requirements:** At least 16GB of RAM for baremetal jumphost,
 338 24GB for virtual deployments (noHA).
 339
 340
 341 Known Issues
 342 ------------
 343
 344 **JIRA TICKETS:**
 345
 346 +--------------------------------------+--------------------------------------+
 347 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 348 |                                      |                                      |
 349 +--------------------------------------+--------------------------------------+
 350 | JIRA: APEX-203                       | Swift proxy enabled and fails in noha|
 351 |                                      | deployments                          |
 352 +--------------------------------------+--------------------------------------+
 353 | JIRA: APEX-215                       | Keystone services not configured and |
 354 |                                      | the error is silently ignored (VLAN  |
 355 |                                      | Deployments)                         |
 356 +--------------------------------------+--------------------------------------+
 357 | JIRA: APEX-208                       | Need ability to specify which NIC to |
 358 |                                      | place VLAN on                        |
 359 +--------------------------------------+--------------------------------------+
 360 | JIRA: APEX-254                       | Add dynamic hugepages configuration  |
 361 +--------------------------------------+--------------------------------------+
 362 | JIRA: APEX-138                       | Unclear error message when interface |
 363 |                                      | set to dhcp                          |
 364 +--------------------------------------+--------------------------------------+
 365
 366
 367 Workarounds
 368 -----------
 369 **-**
 370
 371 Scenario specific release notes
 372 ===============================
 373
 374 Scenario os-odl_l3-nofeature known issues
 375 -----------------------------------------
 376
 377 * `APEX-112 <https://jira.opnfv.org/browse/APEX-112>`_:
 378    ODL routes local subnet traffic to GW
 379
 380 Scenario os-odl_l2-nofeature known issues
 381 -----------------------------------------
 382
 383 * `APEX-149 <https://jira.opnfv.org/browse/APEX-149>`_:
 384    Openflow rules are populated very slowly
 385
 386 Scenario os-odl_l2-bgpvpn known issues
 387 --------------------------------------
 388
 389 None
 390
 391 Scenario os-onos-nofeature known issues
 392 ---------------------------------------
 393
 394 None
 395
 396 Scenario os-onos-sfc known issues
 397 ---------------------------------
 398
 399 * `APEX-281 <https://jira.opnfv.org/browse/APEX-281>`_:
 400    ONOS sometimes fails to provide addresses to instances
 401
 402 Scenario os-odl_l2-sfc-noha known issues
 403 ----------------------------------------
 404
 405 None
 406
 407 Scenario os-nosdn-ovs known issues
 408 ----------------------------------
 409
 410 None
 411
 412 Scenario os-odl_l2-fdio-noha known issues
 413 -----------------------------------------
 414
 415 * `FDS-121 <https://jira.opnfv.org/browse/FDS-121>`_:
 416    qemu doesn't receive connection on socket, vhost-user reconnect problem
 417 * `FDS-62 <https://jira.opnfv.org/browse/FDS-62>`_:
 418    APEX - Increase number of files MariaDB can open
 419 * `FDS-79 <https://jira.opnfv.org/browse/FDS-79>`_:
 420    Sometimes (especially in bulk crete/delete operations
 421    when multiple networks/ports are created within short time)
 422    OpenDaylight doesn't accept creation requests
 423 * `FDS-81 <https://jira.opnfv.org/browse/FDS-81>`_:
 424    After functest finishes there are two bds on computes and
 425    none on controller
 426 * `APEX-217 <https://jira.opnfv.org/browse/APEX-217>`_:
 427    qemu not configured with correct group:user
 428 * `APEX-337 <https://jira.opnfv.org/browse/APEX-337>`_:
 429    enable isolcpu on kernel and pin vpp to unused cpu for fdio scenarios
 430
 431 Scenario os-nosdn-fdio-noha known issues
 432 ----------------------------------------
 433
 434 Note that a set of manual configration steps need to be performed
 435 post an automated deployment for the scenario to be fully functional.
 436 Please refer to `FDS-159 <https://jira.opnfv.org/browse/FDS-159>`_ and
 437 `FDS-160 <https://jira.opnfv.org/browse/FDS-160>`_ for details.
 438
 439 * `FDS-155 <https://jira.opnfv.org/browse/FDS-155>`_:
 440    os-nosdn-fdio-noha scenario: tempest_smoke_serial causes
 441    mariadb/mysqld process to hang
 442 * `FDS-156 <https://jira.opnfv.org/browse/FDS-156>`_:
 443    os-nosdn-fdio-noha scenario: Race conditions for
 444    network-vif-plugged notification
 445 * `FDS-157 <https://jira.opnfv.org/browse/FDS-157>`_:
 446    os-nosdn-fdio-noha scenario: Intermittently VMs
 447    would get assigned 2 IPs instead of 1
 448 * `FDS-158 <https://jira.opnfv.org/browse/FDS-158>`_:
 449    os-nosdn-fdio-noha scenario: VM start/launch fails with
 450    "no more IP addresses" in neutron logs
 451 * `FDS-159 <https://jira.opnfv.org/browse/FDS-159>`_:
 452    os-nosdn-fdio-noha scenario: Security groups not yet supported
 453 * `FDS-160 <https://jira.opnfv.org/browse/FDS-160>`_:
 454    os-nosdn-fdio-noha scenario: Vlan fix on controller
 455 * `FDS-161 <https://jira.opnfv.org/browse/FDS-161>`_:
 456    os-nosdn-fdio-noha scenario: VPP fails with certain UCS B-series blades
 457
 458 .. _HAIssues:
 459
 460 General HA scenario known issues
 461 --------------------------------
 462
 463 * `COPPER-22 <https://jira.opnfv.org/browse/COPPER-22>`_:
 464    Congress service HA deployment is not yet supported/verified.
 465 * `APEX-276 <https://jira.opnfv.org/browse/APEX-276>`_:
 466    ODL HA unstable and crashes frequently
 467
 468 Test Result
 469 ===========
 470
 471 The Colorado release with the Apex deployment toolchain has undergone QA
 472 test runs with the OPNFV FuncTest project.  The latest results per scenario
 473 can be found `here <http://testresults.opnfv.org/reporting/functest/
 474 release/colorado/index-status-apex.html>`_ for Colorado release.
 475
 476
 477 References
 478 ==========
 479
 480 For more information on the OPNFV Colorado release, please see:
 481
 482 http://wiki.opnfv.org/releases/Colorado
 483
 484 :Authors: Tim Rozet (trozet@redhat.com)
 485 :Authors: Dan Radez (dradez@redhat.com)
 486 :Version: 2.2.0