docs/release-notes/release-notes.rst

   1 ============================================================================================
   2 OPNFV Release Notes for the Brahmaputra release of OPNFV when using Apex as a 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 Brahmaputra release with the Apex deployment toolchain.
  14
  15 License
  16 =======
  17
  18 All Apex and "common" entities are protected by the Apache License ( http://www.apache.org/licenses/ )
  19
  20
  21 Version history
  22 ===============
  23
  24
  25 +--------------------+--------------------+--------------------+--------------------+
  26 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  27 |                    |                    |                    |                    |
  28 +--------------------+--------------------+--------------------+--------------------+
  29 | 2015-09-17         | 1.0.0              | Dan Radez          | Rewritten for      |
  30 |                    |                    |                    | RDO Manager update |
  31 +--------------------+--------------------+--------------------+--------------------+
  32 | 2015-04-26         | 2.0.0              | Tim Rozet          | Brahmaputra SR2    |
  33 |                    |                    |                    | update             |
  34 +--------------------+--------------------+--------------------+--------------------+
  35
  36 Important notes
  37 ===============
  38
  39 This is the OPNFV Brahmaputra SR2 release that implements the deploy stage of the OPNFV CI pipeline via Apex.
  40
  41 Apex is based on RDO Manager. More information at http://rdoproject.org
  42
  43 Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Apex installer.
  44
  45 Summary
  46 =======
  47
  48 Brahmaputra release with the Apex deployment toolchain will establish an OPNFV target system
  49 on a Pharos compliant lab infrastructure.  The current definition of an OPNFV target system
  50 is and OpenStack Liberty combined with OpenDaylight Beryllium.  The system is deployed with
  51 OpenStack High Availability (HA) for most OpenStack services.  OpenDaylight is deployed in
  52 non-HA form as HA support is not availble for OpenDaylight at the time of the Brahmaputra
  53 release.  Ceph storage is used as Cinder backend, and is the only supported storage for
  54 Brahmaputra. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node.
  55
  56 - Documentation is built by Jenkins
  57 - .iso image is built by Jenkins
  58 - .rpm packages are built by Jenkins
  59 - Jenkins deploys a Brahmaputra release with the Apex deployment toolchain baremetal,
  60   which includes 3 control+network nodes, and 2 compute nodes.
  61
  62 Release Data
  63 ============
  64
  65 +--------------------------------------+--------------------------------------+
  66 | **Project**                          | apex                                 |
  67 |                                      |                                      |
  68 +--------------------------------------+--------------------------------------+
  69 | **Repo/tag**                         | apex/brahmaputra.3.0                 |
  70 |                                      |                                      |
  71 +--------------------------------------+--------------------------------------+
  72 | **Release designation**              | brahmaputra.3.0                      |
  73 |                                      |                                      |
  74 +--------------------------------------+--------------------------------------+
  75 | **Release date**                     | 2016-04-28                           |
  76 |                                      |                                      |
  77 +--------------------------------------+--------------------------------------+
  78 | **Purpose of the delivery**          | OPNFV Brahmaputra SR2 release        |
  79 |                                      |                                      |
  80 +--------------------------------------+--------------------------------------+
  81
  82 Version change
  83 --------------
  84
  85 Module version changes
  86 ~~~~~~~~~~~~~~~~~~~~~~
  87 This is the second service release version of the Brahmaputra with the Apex deployment toolchain.
  88 It is based on following upstream versions:
  89
  90 - OpenStack (Liberty release)
  91
  92 - OpenDaylight (Beryllium SR2 release)
  93
  94 - CentOS 7
  95
  96 Document version changes
  97 ~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99 This is the first tracked version of Brahmaputra release with the Apex deployment toolchain.
 100 The following documentation is provided with this release:
 101
 102 - OPNFV Installation instructions for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0
 103 - OPNFV Release Notes for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document)
 104
 105 Feature additions
 106 ~~~~~~~~~~~~~~~~~
 107
 108 +--------------------------------------+--------------------------------------+
 109 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 110 |                                      |                                      |
 111 +--------------------------------------+--------------------------------------+
 112 | JIRA: APEX-118                       | SDNVPN scenario added                |
 113 |                                      |                                      |
 114 +--------------------------------------+--------------------------------------+
 115 | JIRA: APEX-89                        | Deploy Ceph OSDs on compute nodes    |
 116 |                                      |                                      |
 117 +--------------------------------------+--------------------------------------+
 118 | JIRA: APEX-47                        | Integrate Tacker as part of SFC      |
 119 |                                      | Experimental Feature                 |
 120 +--------------------------------------+--------------------------------------+
 121
 122 Bug corrections
 123 ~~~~~~~~~~~~~~~
 124
 125 **JIRA TICKETS:**
 126
 127 +--------------------------------------+--------------------------------------+
 128 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 129 |                                      |                                      |
 130 +--------------------------------------+--------------------------------------+
 131 | JIRA: APEX-140                       | Fixes non-default libvirtd network   |
 132 |                                      | subnet in virtual deployments        |
 133 +--------------------------------------+--------------------------------------+
 134 | JIRA: APEX-139                       | Increases timeout for detecting      |
 135 |                                      | Undercloud IP                        |
 136 +--------------------------------------+--------------------------------------+
 137 | JIRA: APEX-113                       | Missing neutron-ovs-agent in no SDN  |
 138 |                                      | HA mode                              |
 139 +--------------------------------------+--------------------------------------+
 140 | JIRA: APEX-116                       | SFC compute node tables may not      |
 141 |                                      | offset correctl                      |
 142 +--------------------------------------+--------------------------------------+
 143 | JIRA: APEX-115                       | DHCP metadata is disabled for        |
 144 |                                      | isolated networks                    |
 145 +--------------------------------------+--------------------------------------+
 146 | JIRA: APEX-121                       | VM Storage deletion intermittently   |
 147 |                                      | fails                                |
 148 +--------------------------------------+--------------------------------------+
 149 | JIRA: APEX-110                       | Deployment with no SDN no HA fails   |
 150 |                                      |                                      |
 151 +--------------------------------------+--------------------------------------+
 152 | JIRA: APEX-137                       | Added arping as dependency for ONOS  |
 153 |                                      | deployments                          |
 154 +--------------------------------------+--------------------------------------+
 155 | JIRA: APEX-136                       | 2 Network deployment fails           |
 156 |                                      |                                      |
 157 +--------------------------------------+--------------------------------------+
 158 | JIRA: APEX-114                       | OpenDaylight GUI is not available    |
 159 |                                      |                                      |
 160 +--------------------------------------+--------------------------------------+
 161 | JIRA: APEX-84                        | --flat option no longer working      |
 162 |                                      |                                      |
 163 +--------------------------------------+--------------------------------------+
 164 | JIRA: APEX-99                        | Syntax error when                    |
 165 |                                      | running opnfv-deploy                 |
 166 +--------------------------------------+--------------------------------------+
 167
 168 Deliverables
 169 ------------
 170
 171 Software deliverables
 172 ~~~~~~~~~~~~~~~~~~~~~
 173 Apex .iso file
 174 Apex overcloud .rpm (opnfv-apex)
 175 Apex undercloud .rpm (opnfv-apex-undercloud)
 176 Apex common .rpm (opnfv-apex-common)
 177 build.sh - Builds the above artifacts
 178 opnfv-deploy - Automatically deploys Target OPNFV System
 179 opnfv-clean - Automatically resets a Target OPNFV Deployment
 180
 181 Documentation deliverables
 182 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 183 - OPNFV Installation instructions for the Brahmaputra release with the Apex deployment toolchain - ver. 1.0.0
 184 - OPNFV Release Notes for the Brahmaputra SR2 release with the Apex deployment toolchain - ver. 2.0.0 (this document)
 185
 186 Known Limitations, Issues and Workarounds
 187 =========================================
 188
 189 System Limitations
 190 ------------------
 191
 192 **Max number of blades:**   1 Apex undercloud, 3 Controllers, 20 Compute blades
 193
 194 **Min number of blades:**   1 Apex undercloud, 1 Controller, 1 Compute blade
 195
 196 **Storage:**    Ceph is the only supported storage configuration.
 197
 198 **Min master requirements:** At least 16GB of RAM
 199
 200
 201 Known issues
 202 ------------
 203
 204 **JIRA TICKETS:**
 205
 206 +--------------------------------------+--------------------------------------+
 207 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 208 |                                      |                                      |
 209 +--------------------------------------+--------------------------------------+
 210 | JIRA: APEX-27                        | OpenContrail Support                 |
 211 |                                      |                                      |
 212 +--------------------------------------+--------------------------------------+
 213 | JIRA: APEX-30                        | Support for VLAN tagged network      |
 214 |                                      | deployment architecture              |
 215 +--------------------------------------+--------------------------------------+
 216 | JIRA: APEX-100                       | DNS1 and DNS2 not handled in         |
 217 |                                      | nic bridging                         |
 218 +--------------------------------------+--------------------------------------+
 219
 220
 221 Workarounds
 222 -----------
 223 **-**
 224
 225
 226 Test Result
 227 ===========
 228
 229 The Brahmaputra release with the Apex deployment toolchain has undergone QA test runs with the following results:
 230
 231 +--------------------------------------+--------------------------------------+
 232 | **TEST-SUITE**                       | **Results:**                         |
 233 |                                      |                                      |
 234 +--------------------------------------+--------------------------------------+
 235 | **-**                                | **-**                                |
 236 +--------------------------------------+--------------------------------------+
 237
 238
 239 References
 240 ==========
 241
 242 For more information on the OPNFV Brahmaputra release, please see:
 243
 244 http://wiki.opnfv.org/releases/brahmaputra
 245
 246 :Authors: Tim Rozet (trozet@redhat.com)
 247 :Authors: Dan Radez (dradez@redhat.com)
 248 :Version: 2.0.0