docs/releasenotes/release-notes.rst

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