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