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-04-16         | 0.1                | Jonas Bjurel       | First draft        |
  30 |                    |                    |                    |                    |
  31 +--------------------+--------------------+--------------------+--------------------+
  32 | 2015-04-23         | 0.2                | Jonas Bjurel       | Minor change       |
  33 |                    |                    |                    |                    |
  34 +--------------------+--------------------+--------------------+--------------------+
  35 | 2015-05-12         | 0.3                | Chris Price        | Minor edits        |
  36 |                    |                    |                    |                    |
  37 +--------------------+--------------------+--------------------+--------------------+
  38 | 2015-06-02         | 0.4                | Chris Price        | Minor edits        |
  39 |                    |                    |                    |                    |
  40 +--------------------+--------------------+--------------------+--------------------+
  41
  42 Important notes
  43 ===============
  44
  45 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.
  46
  47 Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run before deployment is started.
  48
  49 Summary
  50 =======
  51
  52 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.
  53
  54 This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including:
  55
  56 - Documentation built by Jenkins
  57   - this document (release notes)
  58   - installation instructions
  59   - build-instructions
  60 - The Arno Fuel installer image (.iso) built by Jenkins
  61 - Automated deployment of Arno with running on bare metal or a nested hypervisor environment (KVM)
  62 - Automated validation of the Arno deployment
  63
  64
  65 Release Data
  66 ============
  67
  68 +--------------------------------------+--------------------------------------+
  69 | **Project**                          | genesis/bgs                          |
  70 |                                      |                                      |
  71 +--------------------------------------+--------------------------------------+
  72 | **Repo/tag**                         | genesis/arno_1.0.0                   |
  73 |                                      |                                      |
  74 +--------------------------------------+--------------------------------------+
  75 | **Release designation**              | Arno 1.0.0                           |
  76 |                                      |                                      |
  77 +--------------------------------------+--------------------------------------+
  78 | **Release date**                     | 2015-06-04                           |
  79 |                                      |                                      |
  80 +--------------------------------------+--------------------------------------+
  81 | **Purpose of the delivery**          | OPNFV Arno release                   |
  82 |                                      |                                      |
  83 +--------------------------------------+--------------------------------------+
  84
  85 Version change
  86 --------------
  87
  88 Module version changes
  89 ~~~~~~~~~~~~~~~~~~~~~~
  90 This is the first tracked release of genesis/fuel. It is based on following upstream versions:
  91
  92 - Fuel 6.0.1
  93 - OpenStack Juno release
  94 - OpenDaylight Helium-SR2
  95
  96 Document version changes
  97 ~~~~~~~~~~~~~~~~~~~~~~~~
  98 This is the first tracked version of genesis/fuel. It comes with the following documentation:
  99
 100 - OPNFV Installation instructions for Arno with Fuel as deployment tool
 101 - OPNFV Release Notes for Arno use of Fuel as deployment tool
 102 - OPNFV Build instructions for Arno with Fuel as deployment tool
 103
 104
 105 Reason for version
 106 ------------------
 107 Feature additions
 108 ~~~~~~~~~~~~~~~~~
 109
 110 +--------------------------------------+--------------------------------------+
 111 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 112 |                                      |                                      |
 113 +--------------------------------------+--------------------------------------+
 114 | JIRA:                                | Baselining Fuel 6.0.1 for OPNFV      |
 115 |                                      |                                      |
 116 +--------------------------------------+--------------------------------------+
 117 | JIRA:                                | Integration of OpenDaylight          |
 118 |                                      |                                      |
 119 +--------------------------------------+--------------------------------------+
 120
 121 Bug corrections
 122 ~~~~~~~~~~~~~~~
 123
 124 **JIRA TICKETS:**
 125
 126 +--------------------------------------+--------------------------------------+
 127 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 128 |                                      |                                      |
 129 +--------------------------------------+--------------------------------------+
 130 |                                      |                                      |
 131 |                                      |                                      |
 132 +--------------------------------------+--------------------------------------+
 133
 134 Deliverables
 135 ------------
 136
 137 Software deliverables
 138 ~~~~~~~~~~~~~~~~~~~~~
 139 Fuel-based installer iso (opnfv.iso) file
 140
 141 Documentation deliverables
 142 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 143 - OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 1.0.0
 144 - OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 1.0.0 (this document)
 145
 146 Known Limitations, Issues and Workarounds
 147 =========================================
 148
 149 System Limitations
 150 ------------------
 151
 152 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
 153
 154 **Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
 155
 156 **Storage:**    Ceph is the only supported storage configuration.
 157
 158 **Max number of networks:**   3800 (Needs special switch config.)
 159
 160 **L3Agent:**   L3 agent and floating IPs is not supported.
 161
 162 Known issues
 163 ------------
 164
 165 **JIRA TICKETS:**
 166
 167 +--------------------------------------+--------------------------------------+
 168 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 169 |                                      |                                      |
 170 +--------------------------------------+--------------------------------------+
 171 | JIRA:                                | CentOS is not supported              |
 172 |                                      |                                      |
 173 +--------------------------------------+--------------------------------------+
 174
 175 Workarounds
 176 -----------
 177 **-**
 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 | **-**                                | **-**                                |
 190 +--------------------------------------+--------------------------------------+
 191
 192
 193 References
 194 ==========
 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: 0.4
 200
 201 **Documentation tracking**
 202
 203 Revision: _sha1_
 204
 205 Build date:  _date_
 206