fuel/docs/src/release-notes.rst

   1 :Authors: Jonas Bjurel (Ericsson)
   2 :Version: 0.3
   3
   4 =====================================================================================
   5 OPNFV Release Note for the Arno release of OPNFV when using Fuel as a deployment tool
   6 =====================================================================================
   7
   8 Abstract
   9 ========
  10
  11 This document compiles the release notes for the ARNO release, when using Fuel as a deployment tool.
  12
  13 License
  14 =======
  15 Arno release with th Fuel deployment tool Docs (c) by Jonas Bjurel (Ericsson AB)
  16
  17 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/>.
  18
  19
  20 **Contents**
  21
  22 1  Version History
  23
  24 2  Important notes
  25
  26 3  Summary
  27
  28 4  Delivery Data
  29
  30 5 Known Limitations, Issues and Workarounds
  31
  32 6 Test Result
  33
  34 7 References
  35
  36 1   Version history
  37 ===================
  38
  39 +--------------------+--------------------+--------------------+--------------------+
  40 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  41 |                    |                    |                    |                    |
  42 +--------------------+--------------------+--------------------+--------------------+
  43 | 2015-04-16         | 0.1                | Jonas Bjurel       | First draft        |
  44 |                    |                    |                    |                    |
  45 +--------------------+--------------------+--------------------+--------------------+
  46 | 2015-04-23         | 0.2                | Jonas Bjurel       | Minor change       |
  47 |                    |                    |                    |                    |
  48 +--------------------+--------------------+--------------------+--------------------+
  49 | 2015-05-12         | 0.3                | Chris Price        | Minor edits        |
  50 |                    |                    |                    |                    |
  51 +--------------------+--------------------+--------------------+--------------------+
  52
  53 2   Important notes
  54 ===================
  55
  56 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.
  57
  58 Carefully follow the installation-instructions and pay special attention to the pre-deploy script that needs to be run before deployment is started.
  59
  60 3   Summary
  61 ===========
  62
  63 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.
  64
  65 This Arno artefact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including:
  66
  67 - Documentation built by Jenkins
  68   - this document (release notes)
  69   - installation instructions
  70   - build-instructions
  71 - The Arno Fuel installer image (.iso) built by Jenkins
  72 - Automated deployment of Arno with running on bare metal or a nested hypervisor environment (KVM)
  73 - Automated validation of the Arno deployment
  74
  75
  76 4   Release Data
  77 ================
  78
  79 +--------------------------------------+--------------------------------------+
  80 | **Project**                          | Arno/genesis/fuel                    |
  81 |                                      |                                      |
  82 +--------------------------------------+--------------------------------------+
  83 | **Repo/tag**                         | genesis/arno                         |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86 | **Release designation**              | Arno                                 |
  87 |                                      |                                      |
  88 +--------------------------------------+--------------------------------------+
  89 | **Release date**                     | 2015-Spring                          |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92
  93 4.1 Version change
  94 ------------------
  95
  96 4.1.1   Module version changes
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  98 This is the first tracked release of genesis/fuel. It is based on following upstream versions:
  99
 100 - Fuel 6.0.1 (Juno release)
 101 - OpenDaylight Helium-SR2
 102
 103 4.1.2   Document version changes
 104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 105 This is the first tracked version of genesis/fuel. It comes with the following documentation:
 106
 107 - OPNFV Installation instructions for Arno with Fuel as deployment tool
 108 - OPNFV Release Notes for Arno use of Fuel as deployment tool
 109 - OPNFV Build instructions for Arno with Fuel as deployment tool
 110
 111
 112 4.2 Reason for version
 113 ----------------------
 114 4.2.1 Feature additions
 115 ~~~~~~~~~~~~~~~~~~~~~~~
 116
 117 +--------------------------------------+--------------------------------------+
 118 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 | JIRA:                                | Baselining Fuel 6.0.1 for OPNFV      |
 122 |                                      |                                      |
 123 +--------------------------------------+--------------------------------------+
 124 | JIRA:                                | Integration of OpenDaylight          |
 125 |                                      |                                      |
 126 +--------------------------------------+--------------------------------------+
 127
 128 4.2.2 Bug corrections
 129 ~~~~~~~~~~~~~~~~~~~~~
 130
 131 **JIRA TICKETS:**
 132
 133 +--------------------------------------+--------------------------------------+
 134 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 135 |                                      |                                      |
 136 +--------------------------------------+--------------------------------------+
 137 |                                      |                                      |
 138 |                                      |                                      |
 139 +--------------------------------------+--------------------------------------+
 140
 141 4.3 Deliverables
 142 ----------------
 143
 144 4.3.1   Software deliverables
 145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 146 Fuel-based installer iso (opnfv.iso) file
 147
 148 4.3.2   Documentation deliverables
 149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 150 - OPNFV Installation instructions for Arno release with the Fuel deployment tool - ver. 0.0.1
 151 - OPNFV Release Note for Arno release with the Fuel deployment tool - ver. 0.1 (this document)
 152
 153 5  Known Limitations, Issues and Workarounds
 154 ============================================
 155
 156 5.1    System Limitations
 157 -------------------------
 158
 159 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
 160
 161 **Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
 162
 163 **Storage:**    Ceph is the only supported storage configuration.
 164
 165 **Max number of networks:**   3800 (Needs special switch config.)
 166
 167 **L3Agent:**   L3 agent and floating IPs is not supported.
 168
 169 5.2    Known issues
 170 -------------------
 171
 172 **JIRA TICKETS:**
 173
 174 +--------------------------------------+--------------------------------------+
 175 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 176 |                                      |                                      |
 177 +--------------------------------------+--------------------------------------+
 178 | JIRA:                                | CentOS is not supported              |
 179 |                                      |                                      |
 180 +--------------------------------------+--------------------------------------+
 181
 182 5.3    Workarounds
 183 ------------------
 184 **-**
 185
 186
 187 6  Test Result
 188 ==============
 189
 190 Arno release with the Fuel deployment tool has undergone QA test runs with the following results:
 191
 192 +--------------------------------------+--------------------------------------+
 193 | **TEST-SUITE**                       | **Results:**                         |
 194 |                                      |                                      |
 195 +--------------------------------------+--------------------------------------+
 196 | **-**                                | **-**                                |
 197 +--------------------------------------+--------------------------------------+
 198
 199
 200 7  References
 201 =============
 202
 203 For more information on the OPNFV Arno release, please see http://wiki.opnfv.org/releases/arno.