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-08-11  | 2.0.0     | Dan Radez       | Updates for Colorado |
  32 +-------------+-----------+-----------------+----------------------+
  33 | 2015-09-17  | 1.0.0     | Dan Radez       | Rewritten for        |
  34 |             |           |                 | RDO Manager update   |
  35 +-------------+-----------+-----------------+----------------------+
  36
  37 Important notes
  38 ===============
  39
  40 This is the OPNFV Colorado release that implements the deploy stage of the
  41 OPNFV CI pipeline via Apex.
  42
  43 Apex is based on RDO's Triple-O installation tool chain.
  44 More information at http://rdoproject.org
  45
  46 Carefully follow the installation-instructions which guide a user on how to
  47 deploy OPNFV using Apex installer.
  48
  49 Summary
  50 =======
  51
  52 Colorado release with the Apex deployment toolchain will establish an OPNFV
  53 target system on a Pharos compliant lab infrastructure.  The current definition
  54 of an OPNFV target system is and OpenStack Liberty combined with OpenDaylight
  55 Beryllium.  The system is deployed with OpenStack High Availability (HA) for
  56 most OpenStack services.  OpenDaylight is deployed in non-HA form as HA support
  57 is not availble for OpenDaylight at the time of the Colorado release.  Ceph
  58 storage is used as Cinder backend, and is the only supported storage for
  59 Colorado. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
  60 node.
  61
  62 - Documentation is built by Jenkins
  63 - .iso image is built by Jenkins
  64 - .rpm packages are built by Jenkins
  65 - Jenkins deploys a Colorado release with the Apex deployment toolchain
  66   baremetal, which includes 3 control+network nodes, and 2 compute nodes.
  67
  68 Release Data
  69 ============
  70
  71 +--------------------------------------+--------------------------------------+
  72 | **Project**                          | apex                                 |
  73 |                                      |                                      |
  74 +--------------------------------------+--------------------------------------+
  75 | **Repo/tag**                         | apex/colorado.1.0                    |
  76 |                                      |                                      |
  77 +--------------------------------------+--------------------------------------+
  78 | **Release designation**              | colorado.1.0                         |
  79 |                                      |                                      |
  80 +--------------------------------------+--------------------------------------+
  81 | **Release date**                     | 2016-09-14                           |
  82 |                                      |                                      |
  83 +--------------------------------------+--------------------------------------+
  84 | **Purpose of the delivery**          | OPNFV Colorado release               |
  85 |                                      |                                      |
  86 +--------------------------------------+--------------------------------------+
  87
  88 Version change
  89 --------------
  90
  91 Module version changes
  92 ~~~~~~~~~~~~~~~~~~~~~~
  93 This is the first tracked version of the Colorado release with the Apex
  94 deployment toolchain.  It is based on following upstream versions:
  95
  96 - OpenStack (Mitaka release)
  97
  98 - OpenDaylight (Beryllium release)
  99
 100 - CentOS 7
 101
 102 Document version changes
 103 ~~~~~~~~~~~~~~~~~~~~~~~~
 104
 105 This is the first tracked version of Colorado release with the Apex
 106 deployment toolchain.
 107 The following documentation is provided with this release:
 108
 109 - OPNFV Installation instructions for the Colorado release with the Apex
 110   deployment toolchain - ver. 1.0.0
 111 - OPNFV Release Notes for the Colorado release with the Apex deployment
 112   toolchain - ver. 1.0.0 (this document)
 113
 114 Feature additions
 115 ~~~~~~~~~~~~~~~~~
 116
 117 +--------------------------------------+--------------------------------------+
 118 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 | JIRA: APEX-32                        | Build.sh integration of RDO Manager  |
 122 |                                      |                                      |
 123 +--------------------------------------+--------------------------------------+
 124 | JIRA: APEX-6                         | Deploy.sh integration of RDO Manager |
 125 |                                      |                                      |
 126 +--------------------------------------+--------------------------------------+
 127 | JIRA: APEX-34                        | Migrate and update Release           |
 128 |                                      | Documentation for Colorado           |
 129 +--------------------------------------+--------------------------------------+
 130
 131 Bug corrections
 132 ~~~~~~~~~~~~~~~
 133
 134 **JIRA TICKETS:**
 135
 136 +--------------------------------------+--------------------------------------+
 137 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 138 |                                      |                                      |
 139 +--------------------------------------+--------------------------------------+
 140 |                                      |                                      |
 141 |                                      |                                      |
 142 +--------------------------------------+--------------------------------------+
 143
 144 Deliverables
 145 ------------
 146
 147 Software deliverables
 148 ~~~~~~~~~~~~~~~~~~~~~
 149 Apex .iso file
 150 Apex overcloud .rpm (opnfv-apex)
 151 Apex undercloud .rpm (opnfv-apex-undercloud)
 152 Apex common .rpm (opnfv-apex-common)
 153 build.sh - Builds the above artifacts
 154 opnfv-deploy - Automatically deploys Target OPNFV System
 155 opnfv-clean - Automatically resets a Target OPNFV Deployment
 156
 157 Documentation deliverables
 158 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 159 - OPNFV Installation instructions for the Colorado release with the Apex
 160   deployment toolchain - ver. 1.0.0
 161 - OPNFV Release Notes for the Colorado release with the Apex deployment
 162   toolchain - ver. 1.0.0 (this document)
 163
 164 Known Limitations, Issues and Workarounds
 165 =========================================
 166
 167 System Limitations
 168 ------------------
 169
 170 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
 171
 172 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
 173
 174 **Storage:**    Ceph is the only supported storage configuration.
 175
 176 **Min master requirements:** At least 16GB of RAM
 177
 178
 179 Known issues
 180 ------------
 181
 182 **JIRA TICKETS:**
 183
 184 +--------------------------------------+--------------------------------------+
 185 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 186 |                                      |                                      |
 187 +--------------------------------------+--------------------------------------+
 188 | JIRA: APEX-89                        | Deploy Ceph OSDs on the compute      |
 189 |                                      | nodes also                           |
 190 +--------------------------------------+--------------------------------------+
 191 | JIRA: APEX-27                        | OpenContrail Support                 |
 192 |                                      |                                      |
 193 +--------------------------------------+--------------------------------------+
 194 | JIRA: APEX-30                        | Support for VLAN tagged network      |
 195 |                                      | deployment architecture              |
 196 +--------------------------------------+--------------------------------------+
 197 | JIRA: APEX-100                       | DNS1 and DNS2 not handled in         |
 198 |                                      | nic bridging                         |
 199 +--------------------------------------+--------------------------------------+
 200 | JIRA: APEX-47                        | Integrate Tacker as part of SFC      |
 201 |                                      | Experimental Feature                 |
 202 +--------------------------------------+--------------------------------------+
 203 | JIRA: APEX-84                        | --flat option no longer working      |
 204 |                                      |                                      |
 205 +--------------------------------------+--------------------------------------+
 206 | JIRA: APEX-51                        | Integrate SDNVPN as a deploy option  |
 207 |                                      |                                      |
 208 +--------------------------------------+--------------------------------------+
 209 | JIRA: APEX-99                        | Syntax error when                    |
 210 |                                      | running opnfv-deploy                 |
 211 +--------------------------------------+--------------------------------------+
 212 | JIRA: APEX-86                        | Compute node count configurable      |
 213 |                                      | for virtual deployments              |
 214 +--------------------------------------+--------------------------------------+
 215 | JIRA: APEX-141                       | Adding VSPERF support                |
 216 |                                      |                                      |
 217 +--------------------------------------+--------------------------------------+
 218
 219 Workarounds
 220 -----------
 221 **-**
 222
 223 Scenario specific release notes
 224 ===============================
 225
 226 Scenario os-odl_l2-fdio-noha known issues
 227 -----------------------------------------
 228
 229 * `FDS-16 <https://jira.opnfv.org/browse/FDS-16>`_:
 230    Security group configuration through nova leads
 231    to vhostuser port connection issues
 232 * `FDS-62 <https://jira.opnfv.org/browse/FDS-62>`_:
 233    APEX - Increase number of files MariaDB can open
 234 * `FDS-79 <https://jira.opnfv.org/browse/FDS-79>`_:
 235    Sometimes (especially in bulk crete/delete operations
 236    when multiple networks/ports are created within short time)
 237    OpenDaylight doesn't accept creation requests
 238 * `FDS-80 <https://jira.opnfv.org/browse/FDS-80>`_:
 239    After launching a VM it stayed forever in BUILD status.
 240    Also further operation related to this VM (volume attachment etc.)
 241    caused problems
 242 * `FDS-81 <https://jira.opnfv.org/browse/FDS-81>`_:
 243    After functest finishes there are two bds on computes and
 244    none on controller
 245 * `FDS-82 <https://jira.opnfv.org/browse/FDS-82>`_:
 246    Nova list shows no vms but there are some on computes in paused state
 247
 248
 249 General HA scenario known issues
 250 --------------------------------
 251
 252 * `COPPER-22 <https://jira.opnfv.org/browse/COPPER-22>`_:
 253    Congress service HA deployment is not yet supported/verified.
 254
 255 Test Result
 256 ===========
 257
 258 The Colorado release with the Apex deployment toolchain has undergone QA
 259 test runs with the following results:
 260
 261 +--------------------------------------+--------------------------------------+
 262 | **TEST-SUITE**                       | **Results:**                         |
 263 |                                      |                                      |
 264 +--------------------------------------+--------------------------------------+
 265 | **-**                                | **-**                                |
 266 +--------------------------------------+--------------------------------------+
 267
 268
 269 References
 270 ==========
 271
 272 For more information on the OPNFV Colorado release, please see:
 273
 274 http://wiki.opnfv.org/releases/Colorado
 275
 276 :Authors: Tim Rozet (trozet@redhat.com)
 277 :Authors: Dan Radez (dradez@redhat.com)
 278 :Version: 1.0.0