docs/release-notes/release-notes.rst

   1 ============================================================================================
   2 OPNFV Release Notes for the Bramaputra 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 Bramaputra 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-09-10         | 0.2.0              | Tim Rozet          | Updated for SR1    |
  33 |                    |                    |                    |                    |
  34 +--------------------+--------------------+--------------------+--------------------+
  35 | 2015-06-03         | 0.1.2              | Tim Rozet          | Minor Edits        |
  36 |                    |                    |                    |                    |
  37 +--------------------+--------------------+--------------------+--------------------+
  38 | 2015-06-02         | 0.1.1              | Chris Price        | Minor Edits        |
  39 |                    |                    |                    |                    |
  40 +--------------------+--------------------+--------------------+--------------------+
  41 | 2015-04-16         | 0.1.0              | Tim Rozet          | First draft        |
  42 |                    |                    |                    |                    |
  43 +--------------------+--------------------+--------------------+--------------------+
  44
  45 Important notes
  46 ===============
  47
  48 This is the OPNFV Bramaputra release that implements the deploy stage of the OPNFV CI pipeline via Apex.
  49
  50 Apex is based on RDO Manager. More information at http://rdoproject.org
  51
  52 Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Apex installer.
  53
  54 Summary
  55 =======
  56
  57 Bramaputra release with the Apex deployment toolchain will establish an OPNFV target system
  58 on a Pharos compliant lab infrastructure.  The current definition of an OPNFV target system
  59 is and OpenStack Liberty version combined with OpenDaylight version: Lithium.  The system
  60 is deployed with OpenStack High Availability (HA) for most OpenStack services.  OpenDaylight
  61 is deployed in non-HA form as HAi support is not availble for OpenDaylight at the time of
  62 the Bramaputra release.  Ceph storage is used as Cinder backend, and is the only supported
  63 storage for Bramaputra. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
  64 node.
  65
  66 - Documentation is built by Jenkins
  67 - .iso image is built by Jenkins
  68 - Jenkins deploys a Bramaputra release with the Apex deployment toolchain baremetal,
  69   which includes 3 control+network nodes, and 2 compute nodes.
  70
  71 Release Data
  72 ============
  73
  74 +--------------------------------------+--------------------------------------+
  75 | **Project**                          | apex                                 |
  76 |                                      |                                      |
  77 +--------------------------------------+--------------------------------------+
  78 | **Repo/tag**                         | apex/bramaputra.2016.1.0             |
  79 |                                      |                                      |
  80 +--------------------------------------+--------------------------------------+
  81 | **Release designation**              | arno.2016.1.0                        |
  82 |                                      |                                      |
  83 +--------------------------------------+--------------------------------------+
  84 | **Release date**                     | 2015-02-??                           |
  85 |                                      |                                      |
  86 +--------------------------------------+--------------------------------------+
  87 | **Purpose of the delivery**          | OPNFV Bramaputra release             |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90
  91 Version change
  92 --------------
  93
  94 Module version changes
  95 ~~~~~~~~~~~~~~~~~~~~~~
  96 This is the first tracked version of the Bramapurta release with the Apex deployment toolchain.
  97 It is based on following upstream versions:
  98
  99 - OpenStack (Liberty release)
 100
 101 - OpenDaylight Lithium
 102
 103 - CentOS 7
 104
 105 Document version changes
 106 ~~~~~~~~~~~~~~~~~~~~~~~~
 107
 108 This is the first tracked version of Bramaputra release with the Apex deployment toolchain.
 109 The following documentation is provided with this release:
 110
 111 - OPNFV Installation instructions for the Bramaputra release with the Apex deployment toolchain - ver. 1.0.0
 112 - OPNFV Release Notes for the Bramaputra release with the Apex deployment 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 Bramaputra         |
 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 Instack qcow2 disk image
 151 Overcloud glance disk images
 152 - deploy-ramdisk-ironic.initramfs
 153 - deploy-ramdisk-ironic.kernel
 154 - discovery-ramdisk.initramfs
 155 - discovery-ramdisk.kernel
 156 - fedora-user.qcow2
 157 - overcloud-full.initrd
 158 - overcloud-full.qcow2
 159 - overcloud-full.vmlinuz
 160 build.sh - Builds the above artifacts
 161 deploy.sh - Automatically deploys Target OPNFV System to Bare Metal
 162
 163 Documentation deliverables
 164 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 165 - OPNFV Installation instructions for the Bramaputra release with the Apex deployment toolchain - ver. 1.0.0
 166 - OPNFV Release Notes for the Bramaputra release with the Apex deployment toolchain - ver. 1.0.0 (this document)
 167
 168 Known Limitations, Issues and Workarounds
 169 =========================================
 170
 171 System Limitations
 172 ------------------
 173
 174 **Max number of blades:**   1 Apex master, 3 Controllers, 20 Compute blades
 175
 176 **Min number of blades:**   1 Apex master, 1 Controller, 1 Compute blade
 177
 178 **Storage:**    Ceph is the only supported storage configuration.
 179
 180 **Min master requirements:** At least 2048 MB of RAM
 181
 182
 183 Known issues
 184 ------------
 185
 186 **JIRA TICKETS:**
 187
 188 +--------------------------------------+--------------------------------------+
 189 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 190 |                                      |                                      |
 191 +--------------------------------------+--------------------------------------+
 192 | JIRA: APEX-31                        | Support installs without internet    |
 193 |                                      |                                      |
 194 +--------------------------------------+--------------------------------------+
 195
 196 Workarounds
 197 -----------
 198 **-**
 199
 200
 201 Test Result
 202 ===========
 203
 204 The Bramaputra release with the Apex deployment toolchain has undergone QA test runs with the following results:
 205
 206 +--------------------------------------+--------------------------------------+
 207 | **TEST-SUITE**                       | **Results:**                         |
 208 |                                      |                                      |
 209 +--------------------------------------+--------------------------------------+
 210 | **-**                                | **-**                                |
 211 +--------------------------------------+--------------------------------------+
 212
 213
 214 References
 215 ==========
 216
 217 For more information on the OPNFV Bramaputra release, please see:
 218
 219 http://wiki.opnfv.org/releases/bramaputra
 220
 221 :Authors: Tim Rozet (trozet@redhat.com)
 222 :Authors: Dan Radez (dradez@redhat.com)
 223 :Version: 1.0.0