docs/release-notes.rst

   1 =========================================================================================
   2 OPNFV Release Note for the Arno SR1 release of OPNFV when using Fuel as a deployment tool
   3 =========================================================================================
   4
   5
   6 .. contents:: Table of Contents
   7    :backlinks: none
   8
   9
  10 Abstract
  11 ========
  12
  13 This document compiles the release notes for the Arno SR1 release of
  14 OPNFV when using Fuel as a deployment tool.
  15
  16 License
  17 =======
  18
  19 Arno SR1 release with the Fuel deployment tool Docs (c) by Jonas
  20 Bjurel (Ericsson AB)
  21
  22 Arno SR1 release with the Fuel deployment tool Docs are licensed under
  23 a Creative Commons Attribution 4.0 International License. You should
  24 have received a copy of the license along with this. If not, see
  25 <http://creativecommons.org/licenses/by/4.0/>.
  26
  27
  28 Version history
  29 ===============
  30
  31 +--------------------+--------------------+--------------------+--------------------+
  32 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  33 |                    |                    |                    |                    |
  34 +--------------------+--------------------+--------------------+--------------------+
  35 | 2015-06-03         | 1.0.0              | Jonas Bjurel       | Arno SR0 release   |
  36 |                    |                    |                    |                    |
  37 +--------------------+--------------------+--------------------+--------------------+
  38 | 2015-09-28         | 1.1.3              | Jonas Bjurel       | Arno SR1 release   |
  39 |                    |                    |                    |                    |
  40 +--------------------+--------------------+--------------------+--------------------+
  41
  42 Important notes
  43 ===============
  44
  45 For the first OPNFV release (Arno), these notes introduce use of
  46 `OpenStack Fuel <https://wiki.openstack.org/wiki/Fuel>` for the
  47 deployment stage of the OPNFV continuous integration (CI) pipeline.
  48 The goal of the Arno release and this Fuel-based deployment process is
  49 to establish a foundational platform accelerating further development
  50 of the OPNFV infrastructure.
  51
  52
  53 Carefully follow the installation-instructions and pay special
  54 attention to the pre-deploy script that needs to be run before
  55 deployment is started.
  56
  57
  58 Summary
  59 =======
  60
  61 For Arno SR1, the typical use of Fuel as an OpenStack installer is
  62 supplemented with OPNFV unique components such as `OpenDaylight
  63 <http://www.opendaylight.org/software>`_ version Helium as well as
  64 OPNFV-unique configurations.
  65
  66
  67 This Arno artefact provides Fuel as the deployment stage tool in the
  68 OPNFV CI pipeline including:
  69
  70
  71 - Documentation built by Jenkins
  72   - this document (release notes)
  73   - installation instructions
  74   - build-instructions
  75 - The Arno Fuel installer image (.iso) built by Jenkins
  76 - Automated deployment of Arno with running on bare metal or a nested
  77   hypervisor environment (KVM)
  78 - Automated validation of the Arno deployment
  79
  80
  81 Release Data
  82 ============
  83
  84 +--------------------------------------+--------------------------------------+
  85 | **Project**                          | genesis/bgs                          |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | **Repo/tag**                         | genesis/arno.2015.2.0                |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91 | **Release designation**              | Arno Base Service release 1 (SR1)    |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94 | **Release date**                     | 2015-10-01                           |
  95 |                                      |                                      |
  96 +--------------------------------------+--------------------------------------+
  97 | **Purpose of the delivery**          | OPNFV Arno Base SR1 release          |
  98 |                                      |                                      |
  99 +--------------------------------------+--------------------------------------+
 100
 101 Version change
 102 --------------
 103
 104 Module version changes
 105 ~~~~~~~~~~~~~~~~~~~~~~
 106 This is the second tracked release of genesis/fuel. It is based on
 107 following upstream versions:
 108
 109 - Fuel 6.1.0
 110 - OpenStack Juno release
 111 - OpenDaylight Litium release
 112
 113 Document version changes
 114 ~~~~~~~~~~~~~~~~~~~~~~~~
 115 This is the second tracked version of the fuel installer for OPNFV. It
 116 comes with the following documentation:
 117
 118 - OPNFV Installation instructions for Arno with Fuel as deployment tool
 119 - OPNFV Release Notes for Arno use of Fuel as deployment tool
 120 - OPNFV Build instructions for Arno with Fuel as deployment tool
 121
 122
 123 Reason for version
 124 ------------------
 125 Feature additions
 126 ~~~~~~~~~~~~~~~~~
 127
 128 +--------------------------------------+--------------------------------------+
 129 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 130 |                                      |                                      |
 131 +--------------------------------------+--------------------------------------+
 132 | JIRA: FUEL-4                         | Baselining Fuel 6.0.1 for OPNFV      |
 133 |                                      |                                      |
 134 +--------------------------------------+--------------------------------------+
 135 | JIRA: FUEL-17                        | Integration of OpenDaylight          |
 136 |                                      |                                      |
 137 +--------------------------------------+--------------------------------------+
 138
 139 Bug corrections
 140 ~~~~~~~~~~~~~~~
 141
 142 **JIRA TICKETS:**
 143
 144 +--------------------------------------+--------------------------------------+
 145 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 146 |                                      |                                      |
 147 +--------------------------------------+--------------------------------------+
 148 | JIRA: BGS-57                         | The OpenDaylight Helium release is   |
 149 |                                      | not fully functional and the         |
 150 |                                      | resulting Fuel integration is not    |
 151 |                                      | able to cope with the deficiancies.  |
 152 |                                      | It is therefore not recommended to   |
 153 |                                      | to enable this option.               |
 154 |                                      | A functional integration of ODL      |
 155 |                                      | version: Lithium is expected to be   |
 156 |                                      | available in an upcomming service    |
 157 |                                      | release.                             |
 158 |                                      |                                      |
 159 +--------------------------------------+--------------------------------------+
 160
 161 Deliverables
 162 ------------
 163
 164 Software deliverables
 165 ~~~~~~~~~~~~~~~~~~~~~
 166 Fuel-based installer iso file <arno.2015.2.0.fuel.iso>
 167
 168 Documentation deliverables
 169 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 170 - OPNFV Installation instructions for Arno release with the Fuel
 171   deployment tool - ver. 1.1.0
 172 - OPNFV Build instructions for Arno release with the Fuel deployment
 173   tool - ver. 1.1.0
 174 - OPNFV Release Note for Arno release with the Fuel deployment tool -
 175   ver. 1.1.3 (this document)
 176
 177 Known Limitations, Issues and Workarounds
 178 =========================================
 179
 180 System Limitations
 181 ------------------
 182
 183 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
 184
 185 **Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
 186
 187 **Storage:**    Ceph is the only supported storage configuration.
 188
 189 **Max number of networks:**   3800 (Needs special switch config.)
 190
 191
 192 Known issues
 193 ------------
 194
 195 **JIRA TICKETS:**
 196
 197 +--------------------------------------+--------------------------------------+
 198 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 199 |                                      |                                      |
 200 +--------------------------------------+--------------------------------------+
 201 | JIRA: FUEL-43                        | VMs not accessible through SSH due   |
 202 |                                      | to VXLAN 50 Byte overhead and lack   |
 203 |                                      | of proper MTU value setting on       |
 204 |                                      | virtual ethernet devices             |
 205 +--------------------------------------+--------------------------------------+
 206 | JIRA: FUEL-44                        | Centos 6.5 option has not been       |
 207 |                                      | enough verified                      |
 208 +--------------------------------------+--------------------------------------+
 209
 210
 211 Workarounds
 212 -----------
 213 See JIRA: `FUEL-43 <https://jira.opnfv.org/browse/FUEL-43>`
 214
 215
 216 Test Result
 217 ===========
 218 Arno SR1 release with the Fuel deployment tool has undergone QA test
 219 runs with the following results:
 220 https://wiki.opnfv.org/arno_sr1_result_page?rev=1443626728
 221
 222 References
 223 ==========
 224 For more information on the OPNFV Arno release, please see
 225 http://wiki.opnfv.org/releases/arno.
 226
 227 :Authors: Jonas Bjurel (Ericsson)
 228 :Version: 1.1.3
 229
 230 **Documentation tracking**
 231
 232 Revision: _sha1_
 233
 234 Build date:  _date_