fuel/docs/src/release-notes.rst

   1 =====================================================================================
   2 OPNFV Release Note for the Arno 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 release of OPNFV when using Fuel as a deployment tool.
  14
  15 License
  16 =======
  17
  18 Arno release with the Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB)
  19
  20 Arno 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
  33 Important notes
  34 ===============
  35
  36 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.
  37
  38 Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run before deployment is started.
  39
  40 Summary
  41 =======
  42
  43 For Arno, 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.
  44
  45 This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including:
  46
  47 - Documentation built by Jenkins
  48   - this document (release notes)
  49   - installation instructions
  50   - build-instructions
  51 - The Arno Fuel installer image (.iso) built by Jenkins
  52 - Automated deployment of Arno with running on bare metal or a nested hypervisor environment (KVM)
  53 - Automated validation of the Arno deployment
  54
  55
  56 Release Data
  57 ============
  58
  59 +--------------------------------------+--------------------------------------+
  60 | **Project**                          | genesis/bgs                          |
  61 |                                      |                                      |
  62 +--------------------------------------+--------------------------------------+
  63 | **Repo/tag**                         | genesis/arno.2015.1.0                |
  64 |                                      |                                      |
  65 +--------------------------------------+--------------------------------------+
  66 | **Release designation**              | Arno Base Service release 0 (SR0)    |
  67 |                                      |                                      |
  68 +--------------------------------------+--------------------------------------+
  69 | **Release date**                     | 2015-06-04                           |
  70 |                                      |                                      |
  71 +--------------------------------------+--------------------------------------+
  72 | **Purpose of the delivery**          | OPNFV Arno Base SR0 release          |
  73 |                                      |                                      |
  74 +--------------------------------------+--------------------------------------+
  75
  76 Version change
  77 --------------
  78
  79 Module version changes
  80 ~~~~~~~~~~~~~~~~~~~~~~
  81 This is the first tracked release of genesis/fuel. It is based on following upstream versions:
  82
  83 - Fuel 6.0.1
  84 - OpenStack Juno release
  85 - OpenDaylight Helium-SR3
  86
  87 Document version changes
  88 ~~~~~~~~~~~~~~~~~~~~~~~~
  89 This is the first tracked version of the fuel installer for OPNFV. It comes with the following documentation:
  90
  91 - OPNFV Installation instructions for Arno with Fuel as deployment tool
  92 - OPNFV Release Notes for Arno use of Fuel as deployment tool
  93 - OPNFV Build instructions for Arno with Fuel as deployment tool
  94
  95
  96 Reason for version
  97 ------------------
  98 Feature additions
  99 ~~~~~~~~~~~~~~~~~
 100
 101 +--------------------------------------+--------------------------------------+
 102 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 103 |                                      |                                      |
 104 +--------------------------------------+--------------------------------------+
 105 | JIRA:-                               | Baselining Fuel 6.0.1 for OPNFV      |
 106 |                                      |                                      |
 107 +--------------------------------------+--------------------------------------+
 108 | JIRA:-                               | Integration of OpenDaylight          |
 109 |                                      |                                      |
 110 +--------------------------------------+--------------------------------------+
 111
 112 Bug corrections
 113 ~~~~~~~~~~~~~~~
 114
 115 **JIRA TICKETS:**
 116
 117 +--------------------------------------+--------------------------------------+
 118 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 |                                      |                                      |
 122 | -                                    | -                                    |
 123 +--------------------------------------+--------------------------------------+
 124
 125 Deliverables
 126 ------------
 127
 128 Software deliverables
 129 ~~~~~~~~~~~~~~~~~~~~~
 130 Fuel-based installer iso file <arno.2015.1.0.fuel.iso>
 131
 132 Documentation deliverables
 133 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 134 - OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 1.0.0
 135 - OPNFV Build instructions for Arno release with the Fuel deployment tool - ver. 1.0.0
 136 - OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 1.0.0 (this document)
 137
 138 Known Limitations, Issues and Workarounds
 139 =========================================
 140
 141 System Limitations
 142 ------------------
 143
 144 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
 145
 146 **Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
 147
 148 **Storage:**    Ceph is the only supported storage configuration.
 149
 150 **Max number of networks:**   3800 (Needs special switch config.)
 151
 152
 153 Known issues
 154 ------------
 155
 156 **JIRA TICKETS:**
 157
 158 +--------------------------------------+--------------------------------------+
 159 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 160 |                                      |                                      |
 161 +--------------------------------------+--------------------------------------+
 162 | JIRA: BGS-57                         | The OpenDaylight Helium release is   |
 163 |                                      | not fully functional and the         |
 164 |                                      | resulting Fuel integration is not    |
 165 |                                      | able to cope with the deficiancies.  |
 166 |                                      | It is therefore not recommended to   |
 167 |                                      | to enable this option.               |
 168 |                                      | A functional integration of ODL      |
 169 |                                      | version: Lithium is expected to be   |
 170 |                                      | available in an upcomming service    |
 171 |                                      | release.                             |
 172 |                                      |                                      |
 173 +--------------------------------------+--------------------------------------+
 174
 175 Workarounds
 176 -----------
 177 Current workaround for the JIRA: BGS-57 is not to enable OpenDaylight networking - see installation instructions.
 178
 179
 180 Test Result
 181 ===========
 182
 183 Arno release with the Fuel deployment tool has undergone QA test runs with the following results:
 184
 185 +--------------------------------------+--------------------------------------+
 186 | **TEST-SUITE**                       | **Results:**                         |
 187 |                                      |                                      |
 188 +--------------------------------------+--------------------------------------+
 189 | Tempest test suite 1:                | 27 out of 105 testcases fails        |
 190 |                                      | see note (1) and note (2)            |
 191 +--------------------------------------+--------------------------------------+
 192 | Tempest test suite 2:                | 26 out of 100 testcases fails        |
 193 |                                      | see note (1) and note (2)            |
 194 +--------------------------------------+--------------------------------------+
 195 | Tempest test suite 3:                | 14 out of 106 testcases fails        |
 196 |                                      | see note (1) and note (2)            |
 197 +--------------------------------------+--------------------------------------+
 198 | Rally test suite suie 1:             | 10 out of 18 testcases fails         |
 199 |                                      | see note (1) and note (3)            |
 200 +--------------------------------------+--------------------------------------+
 201 | ODL test suite suie                  | 7 out of 7 testcases fails           |
 202 |                                      | see note (1) and note (4)            |
 203 +--------------------------------------+--------------------------------------+
 204 | vPING                                | OK                                   |
 205 |                                      | see note (1)                         |
 206 +--------------------------------------+--------------------------------------+
 207
 208 ** - Note (1): Have been run with ODL controller active but not with integrated ODL networking VXLAN segmentation activated **
 209 ** - Note (2): see https://wiki.opnfv.org/r1_tempest **
 210 ** - Note (3): see https://wiki.opnfv.org/r1_rally_bench **
 211 ** - Note (4): see https://wiki.opnfv.org/r1_odl_suite **
 212
 213 References
 214 ==========
 215 For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno.
 216
 217 :Authors: Jonas Bjurel (Ericsson)
 218 :Version: 1.0.0
 219
 220 **Documentation tracking**
 221
 222 Revision: _sha1_
 223
 224 Build date:  _date_