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