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